SDK 文档

服务端 API

有奖调研

单聊消息已读上报后回调

最近更新时间:2021-09-24 16:26:59

功能说明

App 后台可以通过该回调实时监控用户的单聊消息的已读动作。

注意事项

  • 要启用回调,必须配置回调 URL,并打开本回调对应的开关,配置方法详见 第三方回调配置 文档。
  • 回调的方向是即时通信 IM 后台向 App 后台发起 HTTPS POST 请求。
  • App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
  • 其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。

可能触发该回调的场景

  • App 用户通过客户端做单聊消息的已读上报。
  • App 管理员通过 REST API admin_set_msg_read 接口 设置单聊消息已读。

回调发生时机

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

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com
示例:

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数 说明
https 请求协议为 HTTPS,请求方式为 POST
www.example.com 回调 URL
SdkAppid 创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand 固定为:C2C.CallbackAfterMsgReport
contenttype 请求包体固定为 JSON
ClientIP 客户端 IP,格式如:127.0.0.1
OptPlatform 客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

请求包示例

{
  "CallbackCommand": "C2C.CallbackAfterMsgReport", // 回调命令
  "Report_Account": "jared", // 已读上报方
  "Peer_Account": "Jonh", // 会话对端
  "LastReadTime": 1614754606, //已读时间
  "UnreadMsgNum": 7 // Report_Account 未读的单聊消息总数量
}

请求包字段说明

字段 类型 说明
CallbackCommand String 回调命令
Report_Account String 已读上报方 UserID
Peer_Account String 会话对端 UserID
LastReadTime Integer 已读时间
UnreadMsgNum Integer Report_Account 未读的单聊消息总数量(包含所有的单聊会话)

应答包示例

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0 // 0为回调成功,1为回调出错
}

应答包字段说明

字段 类型 属性 说明
ActionStatus String 必填 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 必填 错误码,0为回调成功;1为回调出错
ErrorInfo String 必填 错误信息

参考

目录