搜索消息

用户可以通过关键字搜索可见消息，可见性和套件内搜索一致。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/search/v2/message
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	search:message 获取消息搜索结果
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
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，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
page_size	int	否	分页大小 示例值：20 默认值：20 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：9e91187f9107ef4d43cd71c3722cd97665e6cec51bf30a06328839bc9867

请求体

名称	类型	必填	描述
query	string	是	搜索关键词 示例值："测试消息"
from_ids	string\[\]	否	消息来自user_id列表 示例值：["ou_7dab8a3d3cdcc9da365777c7ad535d62"]
chat_ids	string\[\]	否	消息所在chat_id列表 示例值：["oc_a0553eda9014c201e6969b478895c230"]
message_type	string	否	消息类型(file/image/media) 示例值："image" 可选值有： - file: 文件 - image: 图片 - media: 视频
at_chatter_ids	string\[\]	否	at用户user_id列表 示例值：["ou_7dab8a3d3cdcc9da365777c7ad535d62"]
from_type	string	否	消息来自类型(bot/user) 示例值："user" 可选值有： - bot: 机器人 - user: 用户
chat_type	string	否	会话类型(group_chat/p2p_chat) 示例值："group_chat" 可选值有： - group_chat: 群聊 - p2p_chat: 单聊
start_time	string	否	消息发送起始时间 示例值："1609296809"
end_time	string	否	消息发送结束时间 示例值："1609296809"

请求体示例

{
    "query": "测试消息",
    "from_ids": [
        "ou_7dab8a3d3cdcc9da365777c7ad535d62"
    ],
    "chat_ids": [
        "oc_a0553eda9014c201e6969b478895c230"
    ],
    "message_type": "image",
    "at_chatter_ids": [
        "ou_7dab8a3d3cdcc9da365777c7ad535d62"
    ],
    "from_type": "user",
    "chat_type": "group_chat",
    "start_time": "1609296809",
    "end_time": "1609296809"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	string\[\]	消息id列表
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            "om_dc13264520392913993dd051dba21dcf"
        ],
        "page_token": "GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ==",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1278001	invalid param	参数错误，请检查参数
500	1278002	Internal Server Error	系统错误