功能描述

该接口可以在高级群会话中发送消息已读回执，即在高级群会话中将某些消息标记为已读。

• 高级群消息已读功能需要提前在云信控制台开通，否则调该接口会报错。
• 高级群消息已读功能默认支持的群容量上限为 200 人，即只有 200 人以内的群组才支持高级群消息已读功能。若需要扩展，也可在控制台修改支持的群容量，最多设置为 500 人。
• 一次最多可以将 50 条高级群消息标记为已读。

调用频率

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

请求

URL

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

Header

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

请求体参数

参数名称	类型	是否必选	描述
from_account_id	String	必选	已读回执发送方（即消息接收方）的云信账号 ID。该账号需要为高级群成员。
team_id	String	必选	接收已读回执的高级群 ID。
message_server_ids	Array of longs	必选	需要标记为已读的服务端消息 ID。最多传入 50 条高级群消息。

请求体示例

json{
    "from_account_id": "accid1",
    "team_id": 123445,
    "message_server_ids": [
        1576173194455,
        1576173111455
    ]
}

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
success_list	Array of longs	发送已读回执成功的消息 ID 列表。	否
failed_list	Array of longs	发送已读回执失败的消息 ID 列表。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "success_list": [1623412231],
    "failed_list": [1623112231]
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
107331	该 App 未开启群消息已读功能	read receipt for team messages function disabled
108302	无高级群	not advanced team
108404	群不存在	team not exist
500	服务器内部错误	internal server error