查询消息已读信息

注意事项:

• 需要开启机器人能力
• 查询消息已读信息时机器人仍需要在会话内
• 本接口不支持查询批量消息

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/im/v2/messages/:message_id/read_users
HTTP Method	GET
支持的应用类型	自建应用 商店应用
权限要求开启任一权限即可	获取用户给机器人发送的信息、向用户发送单聊、群聊消息
字段权限要求	该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请获取用户 user_id（仅自建应用）

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"了解更多：获取与使用access_token

路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称	类型	描述
message_id	string	待查询的消息的ID，请注意不支持查询批量消息 示例值："150402"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：user_id 当值为 user_id，字段权限要求： 获取用户 user ID
page_size	int	是	此次调用中使用的分页的大小 示例值：20 数据校验规则： * 取值范围：1 ～ 100
page_token	string	否	下一页分页的token 示例值："GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟items	read_user[]
∟ ∟user_id	string	用户id 字段权限要求： 获取用户 user_id（仅自建应用）
∟ ∟timestamp	string	阅读时间
∟ ∟tenant_key	string	tenant key
∟has_more	boolean	是否还有下一页
∟page_token	string	下一页分页的token

响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "success": true,
    "msg": "操作成功",
    "data": {
        "items": [
            {
                "user_id": "ou_9b851f7b51a9d58d109982337c46f3de",
                "timestamp": "1609484183000",
                "tenant_key": "736588c9260f175e"
            }
        ],
        "has_more": true,
        "page_token": "GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="
    }
}