云信服务端支持在单聊场景下，将接收到的消息标记为已读，即（向消息发送方）发送已读回执。

API 使用限制

单个应用默认最高调用频率请参考 频控说明。

URL

POST http://api.yunxinapi.com/nimserver/msg/markReadMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参见API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必填	说明
from	String	是	已读回执的发送方（即消息接收方）IM 账号（accid）
to	String	是	已读回执的接收方（即消息发送方）的 IM 账号（accid）
msgidClient	String	是	需要标记为已读的消息的客户端消息 ID（clientId）。客户端消息 ID 指由 SDK 侧生成的消息 ID。该参数长度上限 50 字符。

返回参数

参数	类型	说明
code	Integer	状态码
data	Object	已读回执的数据对象，包含 timestamp 字段，表示已读回执的时间戳

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1******03mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=wqt_tm_1&to=wqt_tm_2&msgid=157617319445528738' 'http://api.yunxinapi.com/nimserver/msg/markReadMsg.action'

请求成功返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "data":{
        "timestamp": 1231231123  // 已读回执时间戳
    }
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "bad msgidClient"  // msgidClient参数错误
}

状态码

状态码	说明	处理建议
403	功能被禁用	请联系技术支持
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超限	降低接口调用频率
500	服务出错	请联系技术支持