查询消息已读信息

GET

https://open.feishu.cn/open-apis/im/v1/messages/{message_id}/read_users

查询消息的已读信息。
注意事项:

只能查询机器人自己发送，且发送时间不超过7天的消息

查询消息已读信息时机器人仍需要在会话内

本接口不支持查询批量消息

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	230002	The bot can not be outside the group.	机器人不在对应群组中。
400	230006	Bot ability is not activated.	机器人能力未启用。在开发者后台-应用功能-机器人页面开启机器人功能并发布上线。
400	230012	Bot is NOT the sender of the message.	机器人不是消息的发送者。
400	230027	Lack of necessary permissions.	请根据本文档中的权限要求部分补充所需权限。
400	230033	Get the reading status must be done within 7 days after the message is sent.	查询消息读取情况只能在发送消息后的7天内。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/im/v1/messages//read_users?user_id_type' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "user_id_type": "open_id",
        "user_id": "ou_9b851f7b51a9d58d109982337c46f3de",
        "timestamp": "1609484183000",
        "tenant_key": "736588c9260f175e"
      }
    ],
    "has_more": true,
    "page_token": "GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="
  }
}

请求参数

Path 参数

message_id

string

必需

待查询的消息的ID，说明参见：消息ID说明注意：不支持查询批量消息示例值："om_dc13264520392913993dd051dba21dcf"

Query 参数

user_id_type

string

必需

用户 ID 类型示例值："open_id" 可选值有： open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

page_size

string

可选

此次调用中使用的分页的大小示例值：20 数据校验规则：取值范围：1 ～ 100

page_token

string

可选

下一页分页的token 示例值："GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {4}]

必需

has_more

boolean

是否还有下一页

必需

page_token

string

必需

下一页分页的token

修改于 2023-01-12 08:44:05

撤回消息

获取会话历史消息

查询消息已读信息

错误码#

请求参数

返回响应

错误码