接口调用说明
App 管理员可以通过该接口发送单聊消息已读回执。
用户 A 给用户 B 发送单聊消息,则用户 B 作为消息的接收方,发送消息已读回执。请求中 Operator_Account 字段填用户 B 的 UserID, Peer_Account 字段填用户 A 的 UserID,C2CMsgInfo 中的 From_Account 填用户 A 的 UserID ,To_Account填用户 B 的 UserID。
请求URL示例
https://console.tim.qq.com/v4/openim/c2c_msg_read_receipt?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/openim/c2c_msg_read_receipt | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
请求包示例
{"Operator_Account":"user1","Peer_Account": "user2","C2CMsgInfo": [{"From_Account": "user2","To_Account": "user1","MsgKey": "1467329515_5675354_1708676941"}]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Operator_Account | String | 必填 | 发送已读回执的用户 UserID |
Peer_Account | String | 必填 | 会话的另一方用户 UserID |
C2CMsgInfo | Array | 必填 | 发送已读回执的消息列表 |
From_Account | String | 必填 | 消息的发送方 UserID,需与 Peer_Account 保持一致 |
To_Account | String | 必填 | 消息的接收方 UserID,需与 Operator_Account 保持一致 |
MsgKey | String | 必填 | 消息的 MsgKey |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功 非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 描述 |
20001 | 请求包非法 |
20002 | UserSig 或 A2 失效 |
20003 | 消息发送方或接收方 UserID 无效或不存在,请检查 UserID 是否已导入即时通信 IM |
20004 | 网络异常,请重试 |
20005 | 服务器内部错误,请重试 |
20006 | 触发发送单聊消息之前回调,App 后台返回禁止下发该消息 |
90001 | JSON 格式解析失败,请检查请求包是否符合 JSON 规范 |
90002 | JSON 格式请求包中 MsgBody 不符合消息格式描述,或者 MsgBody 不是 Array 类型,请参考 [TIMMsgElement 对象](https://cloud.tencent.com/document/product/269/2720#.E6.B6.88.E6.81.AF.E5.85.83.E7.B4.A0-timmsgelement) 的定义 |
90003 | JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 字段不是 String 类型 |
90005 | JSON 格式请求包体中缺少 MsgRandom 字段或者 MsgRandom 字段不是 Integer 类型 |
90007 | JSON 格式请求包体中 MsgBody 类型不是 Array 类型,请将其修改为 Array 类型 |
90009 | 请求需要 App 管理员权限 |
90010 | JSON 格式请求包不符合消息格式描述,请参考 [TIMMsgElement 对象](https://cloud.tencent.com/document/product/269/2720#.E6.B6.88.E6.81.AF.E5.85.83.E7.B4.A0-timmsgelement) 的定义 |
90012 | To_Account 没有注册或不存在,请确认 To_Account 是否导入即时通信 IM 或者是否拼写错误 |
90026 | 消息离线存储时间错误(最多不能超过7天) |
90031 | JSON 格式请求包体中 SyncOtherMachine 字段不是 Integer 类型 |
90044 | JSON 格式请求包体中 MsgLifeTime 字段不是 Integer 类型 |
91000 | 服务内部错误,请重试 |
90992 | 服务内部错误,请重试;如果所有请求都返回该错误码,且 App 配置了第三方回调,请检查 App 服务器是否正常向即时通信 IM 后台服务器返回回调结果 |
93000 | JSON 数据包超长,消息包体请不要超过12k |
90048 | 请求的用户账号不存在 |
接口调试工具
参考