单聊消息已读上报后回调
功能说明
App 业务服务端可以通过该回调实时查看用户的单聊消息的已读动作。
注意事项
- 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
- 回调的方向是 OpenIMServer 向 App 后台发起 HTTP/HTTPS POST 请求。
- APP 业务服务端需在超时时间内响应此请求。
可能触发该回调的场景
- App 用户通过客户端做单聊消息的已读上报。
- App 管理员通过 REST API 接口 设置单聊消息已读。
回调发生时机
- 单聊消息已读上报成功之后。
接口说明
请求 URL 示例
此处CallbackCommand
为:callbackAfterSingleMsgReadCommand
{WEBHOOK_ADDRESS}/callbackAfterSingleMsgReadCommand?contenttype=json
请求包示例
{
"callbackCommand": "callbackAfterSingleMsgReadCommand",
"conversationID": "si_u1_u2:0"
"userID": "user123",
"seqs": [20, 35],
"contentType": 101
}
请求包字段说明
对象 | 类型 | 描述 |
---|---|---|
callbackCommand | string | 回调命令,这里是单聊消息已读回调 |
conversationID | string | 会话ID |
userID | string | 接收消息的用户ID |
contentType | int32 | 消息类型 |
seqs | []int64 | 已读消息序列 |
应答包示例
成功应答
成功接收并处理用户已读单聊消息的请求。
{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": 0
}
应答包字段说明
字段 | 值 | 说明 |
---|---|---|
actionCode | 0 | 表示业务系统的回调是否正确执行。0 表示操作成功。 |
errCode | 20001 | 表示自定义错误码,范围在20001-29999之间。在 actionCode 不等于0时设置;在 nextCode 不等于1时设置。 |
errMsg | "An error message" | 自定义错误码对应的简单错误信息。 |
errDlt | "Detailed error information" | 自定义错误码对应的详细错误信息。 |
nextCode | 1 | 下一步执行指令,1 表示拒绝继续执行,actionCode 等于0 时设置。 |