API 参考
在线调试

发送单聊已读回执

更新时间: 2024/07/17 16:53:41

该接口可以在单聊会话中发送消息已读回执,即在单聊会话中将某消息标记为已读。

调用频率

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

请求

URL

POST https://open.yunxinapi.com/im/v2/messages/actions/p2p_read_receipt

请求 Header 的参数说明请参见请求 Header

请求体参数

参数名称 类型 是否必选 描述
from_account_id String 必选 已读回执发送方(即消息接收方)的云信账号 ID。
to_account_id String 必选 已读回执接收方(即消息发送发)的云信账号 ID。
message_server_id Long 必选 需要标记为已读的服务端消息 ID。

请求体示例

json{
    "from_account_id": "accid1",
    "to_account_id": "accid2",
    "message_server_id": 1231124123
}

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "timestamp": 123456123111
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
107404 消息不存在 message not exist
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码