该接口可以通过指定高级群 ID、消息 ID 和消息发送者的 IM 账号，查询对应高级群消息的已读未读详情，包括目标消息已读数、目标消息的未读数、已读用户列表和未读用户列表。

调用频率

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

请求

URL

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

Header

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

查询参数

参数名称	类型	是否必选	描述
team_id	String	必选	需要查询的高级群 ID，创建群组成功时，云信服务器会自动生成并返回。
team_type	Integer	必选	群组类型，目前仅支持 team_type=1，即仅支持高级群。
sender_id	String	必选	消息发送者账号 ID。
message_server_id	Long	必选	需要查询的服务端消息 ID（发送群已读业务消息时服务器返回的消息 ID），最大长度 64 位长整型。
snapshot	Boolean	可选	是否返回已读/未读成员的 IM 账号 ID 列表，默认为 false（不返回）。

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
read_size	Integer	目标消息的已读用户数。	是
unread_size	Integer	目标消息的未读用户数。	是
read_account_ids	Array of strings	目标消息的已读用户账号 ID 列表。	否
unread_account_ids	Array of strings	目标消息的未读用户账号 ID 列表。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "read_size": 1,
        "unread_size": 2,
        "read_account_ids": [
            "accid1"
        ],
        "unread_account_ids": [
            "accid3",
            "accid2"
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频控超出限制	rate limit exceeded
102404	用户不存在	account not exist
107331	群消息已读功能未开启	read receipt for team messages function disabled
107332	群消息已读记录未找到	read receipt record for the team message not found
500	服务器内部错误	internal server error
503	服务器繁忙	server busy