即时通信 IM 发送单聊消息已读回执

功能说明
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
请求参数说明
下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/openim/c2c_msg_read_receipt
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 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 规范。
90003
JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 字段不是 String 类型。
90009
请求需要 App 管理员权限。
90012
To_Account 没有注册或不存在，请确认 To_Account 是否导入即时通信 IM 或者是否拼写错误。
91000
服务内部错误，请重试。
90992
服务内部错误，请重试；如果所有请求都返回该错误码，且 App 配置了第三方回调，请检查 App 服务器是否正常向即时通信 IM 后台服务器返回回调结果。
90048
请求的用户账号不存在。
接口调试工具
通过 REST API 在线调试工具 调试本接口。
参考
查询单聊消息（v4/openim/admin_getroammsg）
﻿

参数	说明
v4/openim/c2c_msg_read_receipt	请求接口
sdkappid	创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
random	请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype	请求格式固定值为`json`

字段	类型	属性	说明
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。

错误码	描述
20001	请求包非法。
20002	UserSig 或 A2 失效。
20003	消息发送方或接收方 UserID 无效或不存在，请检查 UserID 是否已导入即时通信 IM。
20004	网络异常，请重试。
20005	服务器内部错误，请重试。
20006	触发发送单聊消息之前回调，App 后台返回禁止下发该消息。
90001	JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90003	JSON 格式请求包体中缺少 To_Account 字段或者 To_Account 字段不是 String 类型。
90009	请求需要 App 管理员权限。
90012	To_Account 没有注册或不存在，请确认 To_Account 是否导入即时通信 IM 或者是否拼写错误。
91000	服务内部错误，请重试。
90992	服务内部错误，请重试；如果所有请求都返回该错误码，且 App 配置了第三方回调，请检查 App 服务器是否正常向即时通信 IM 后台服务器返回回调结果。
90048	请求的用户账号不存在。

发送单聊消息已读回执

本页目录：

功能说明

接口调用说明

请求 URL 示例

请求参数说明

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考