• UIKit
  • SDK
  • 服务端 API
Chat/
服务端 API/
服务端回调/
单聊消息回调/
服务端 API
  • UserSig(Token) 鉴权
  • RESTful API
    • RESTful API 概述
    • RESTful API 列表
    • 消息相关
      • 发送消息
        • 向单个用户发送单聊消息
        • 向多个用户发送单聊消息
        • 群内发送普通消息
        • 群内发送系统消息
        • 直播群广播消息
        • 导入单聊消息
        • 导入群消息
      • 历史消息
        • 修改单聊历史消息
        • 修改群聊历史消息
        • 拉取单聊历史消息
        • 拉取群聊历史消息
      • 删除消息
        • 删除指定用户发送的消息
      • 撤回消息
        • 撤回单聊消息
        • 撤回群消息
      • 已读回执
        • 设置单聊消息已读
        • 拉取群消息已读回执详情
        • 拉取群消息已读回执
      • 消息扩展
        • 拉取单聊消息扩展
        • 设置单聊消息扩展
        • 拉取群消息扩展
        • 设置群消息扩展
      • 推送给所有用户
        • 全员推送接口
        • 推送给所有用户
        • 设置应用属性名称
        • 获取应用属性名称
        • 获取用户属性
        • 设置用户属性
        • 删除用户属性
        • 获取用户标签
        • 添加用户标签
        • 删除用户标签
        • 删除用户所有标签
    • 会话相关
      • 会话列表
        • 拉取会话列表
      • 未读会话数
        • 设置成员的未读消息数
        • 查询未读单聊消息数
      • 删除会话
        • 删除会话
      • 会话组标签
        • 创建会话组数据
        • 更新会话组数据
        • 删除会话组数据
        • 创建或更新会话标记数据
        • 查找会话组标记
        • 拉取会话组标记数据
    • 群相关
      • 群组管理
        • 获取应用内所有群组
        • 创建群组
        • 解散群组
        • 获取用户已加入的群
      • 群资料
        • 获取群资料
        • 修改群资料
        • 导入群资料
      • 群成员管理
        • 添加群成员
        • 删除群成员
        • 封禁群成员
        • 解禁群成员
        • 批量禁言和取消禁言
        • 获取被禁言群成员列表
        • 变更群主
        • 查询用户在群组中的身份
        • 导入群成员
      • 群成员信息
        • 获取群成员资料
        • 修改群成员资料
        • Getting Specified Group Member Profiles
      • 群自定义属性
        • 获取群自定义属性
        • 修改群自定义属性
        • 清空群自定义属性
        • 重置群自定义属性
        • 删除群自定义属性
      • 直播群管理
        • 获取直播群在线人数
        • 获取直播群在线成员列表
        • 设置直播群成员标记
        • 获取封禁群成员列表
      • 社群管理
        • 创建话题
        • 删除话题
        • 获取话题资料
        • 修改话题资料
        • 导入话题资料
      • 群计数器
        • 获取群计数器
        • 更新群计数器
        • 删除群计数器
    • 用户管理
      • 账号管理
        • 导入单个账号
        • 导入多账号
        • 删除账号
        • 查询账号
      • 用户信息
        • 设置资料
        • 拉取资料
      • 用户状态
        • 账号登录状态失效
        • 查询账号在线状态
      • 好友管理
        • 添加好友
        • 导入好友
        • 更新好友
        • 删除好友
        • 删除所有好友
        • 验证好友
        • 拉取好友
        • 拉取指定好友
      • 好友列表
        • 添加列表
        • 删除列表
        • 拉取列表
      • 黑名单
        • 拉黑用户
        • 将用户移出黑名单
        • 拉取黑名单
        • 验证黑名单中的用户
    • 全员禁言管理
      • 设置全员禁言
      • 查询全员禁言
    • 运维管理
      • 拉取运维数据
      • 下载最新消息
      • 获取服务器 IP 地址
    • 智能机器人
      • 拉取智能机器人账号
      • 创建智能机器人账号
      • 删除智能机器人账号
    • 全员/标签推送
      • 发起全员/标签推送
      • 获取应用属性名称
      • 设置应用属性名称
      • 获取用户属性
      • 设置用户属性
      • 删除用户属性
      • 获取用户标签
      • 添加用户标签
      • 删除用户标签
      • 清空用户标签
      • 推送撤回
  • 服务端回调
    • 回调概述
    • 回调命令列表
    • 运维管理回调
      • 接口超频告警回调
    • 在线状态回调
      • 状态变更回调
    • 关系链回调
      • 更新资料之后
      • 添加好友之前
      • 添加好友回应之前
      • 添加好友之后
      • 删除好友之后
      • 将用户加入黑名单后
      • 将用户移出黑名单后
    • 单聊消息回调
      • 发送单聊消息之前
      • 发送单聊消息之后
      • 设置单聊消息已读之后
      • 撤回单聊消息之后
    • 群回调
      • 创建群组之前
      • 创建群组之后
      • 申请入群之前
      • 拉人入群之前
      • 用户入群之后
      • 成员退群之后
      • 发送群消息之前
      • 发送群消息后
      • 群组满员之后
      • 群组解散之后
      • 群组资料变动之后
      • 撤回群消息之后回调
      • 直播群成员在线和离线状态回调
      • 发送群消息异常回调
      • 创建话题之前
      • 创建话题之后
      • 删除话题后
      • 话题信息变更回调
      • 群成员资料变更后回调
      • 群属性变更后回调
      • 已读回执后回调
      • 群主变更后回调
      • Group Creation Daily Net Increase Threshold Alarm Callback
    • 机器人相关回调
      • 单聊机器人消息回调
      • 群内@机器人之后回调

设置单聊消息已读之后

功能说明

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

注意事项

要启用回调,必须配置回调 URL,并打开本回调对应的开关,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 Chat 后台向 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
创建应用时在即时通信 Chat 控制台分配的 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
必填
错误信息

参考

在技术社区提问