群聊消息已读上报后回调

功能说明

App 业务服务端可以通过该回调实时查看用户的单聊消息的已读动作。

注意事项

• 为启用回调，必须配置回调 URL，并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
• 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
• APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景

• 用户阅读了一条群消息。

回调发生时机

• 群聊消息已读上报成功之后。

接口说明

请求 URL 示例

此处CallbackCommand为：callbackAfterGroupMsgReadCommand

{WEBHOOK_ADDRESS}/callbackAfterGroupMsgReadCommand?contenttype=json

请求包示例

{
  "callbackCommand": "callbackGroupMsgReadCommand",
  "sendID": "user123",
  "receiveID": "group789",
  "unreadMsgNum": 5,
  "contentType": 101,
}

请求包字段说明

对象	类型	描述
callbackCommand	string	回调命令，这里是群消息已读回调
sendID	string	发送消息的用户ID
receiveID	string	接收消息的群组ID
unreadMsgNum	int64	未读消息数量
contentType	int	消息类型

应答包示例

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "",
    "errDlt": "",
    "nextCode": ""
}

应答包字段说明

字段	值	说明
actionCode	0	表示业务系统的回调是否正确执行。0表示操作成功。
errCode	0	表示自定义错误码，此处填0代表忽略回调结果。
errMsg	"An error message"	自定义错误码对应的简单错误信息。
errDlt	"Detailed error information"	自定义错误码对应的详细错误信息。
nextCode	1	下一步执行指令，1表示拒绝继续执行，actionCode等于0时设置。