# 搜索消息
用户可以通过关键字搜索可见消息，可见性和套件内搜索一致。
**注意事项**：该接口是 https://open.larkoffice.com/document/server-docs/search-v2/suite-search/create 搜消息能力的升级版，支持更多筛选器，并返回更多响应信息
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/im/v1/messages/search
HTTP Method | POST
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取消息搜索结果(search:message)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
page_size | int | 否 | **示例值**：15 (默认15，最大30)
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
query | string | 否 | query (长度范围：0 ～ 50 字符)
**示例值**："下午去哪团建"
filter | message_search_filter | 否 | 消息过滤器
from_ids | string\[\] | 否 | 消息创建者
**示例值**：["ou-7890123456abcdef"]
**数据校验规则**：
- 长度范围：`0` ～ `200`
chat_ids | string\[\] | 否 | 消息所在的会话，会话ID获取方式参考：https://open.larkoffice.com/document/server-docs/group/chat/chat-id-description
**示例值**：["ou-7890123456abcdef"]
**数据校验规则**：
- 长度范围：`0` ～ `200`
time_range | time_range | 否 | 开始与结束时间，不需要同时传入，但是end_time需要大于start_time
start_time | string | 否 | 开始时间(iso8601，需要小于end_time)
**示例值**："2026-03-21T16:15:30+08:00"
**数据校验规则**：
- 长度范围：`0` ～ `64` 字符
- 正则校验：`^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(Z|([+-](?:[01]\d|2[0-3]):?[0-5]\d))$`
end_time | string | 否 | 结束时间(iso8601，需要大于start_time)
**示例值**："2026-03-21T16:15:30+08:00"
**数据校验规则**：
- 长度范围：`0` ～ `64` 字符
- 正则校验：`^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T([01]\d|2[0-3]):([0-5]\d):([0-5]\d)(Z|([+-](?:[01]\d|2[0-3]):?[0-5]\d))$`
include_attachment_types | string\[\] | 否 | 包含某些附件类型
**示例值**：["image"]
**可选值有**：
- image：image
- video：video
- file：file
- link：link
**数据校验规则**：
- 长度范围：`0` ～ `4`
from_types | string\[\] | 否 | 来源类型(用户消息、机器人消息)
**示例值**：["user"]
**可选值有**：
- user：user
- bot：bot
**数据校验规则**：
- 长度范围：`0` ～ `2`
at_chatter_ids | string\[\] | 否 | 消息中包含at的user_id (包含at all)
**示例值**：["ou-7890123456abcdef"]
**数据校验规则**：
- 长度范围：`0` ～ `200`
chat_type | string | 否 | 会话类型（单聊、群聊） 单选
**示例值**："group"
**可选值有**：
- group：group
- p2p：p2p
is_at_me | boolean | 否 | 是否at过我，默认否 (包含at all)
**示例值**：true
exclude_from_types | string\[\] | 否 | 过滤来源
**示例值**：["user"]
**可选值有**：
- user：user
- bot：bot
**数据校验规则**：
- 长度范围：`0` ～ `2`
### 请求体示例
```json
{
"query": "下午去哪团建",
"filter": {
"from_ids": [
"ou-7890123456abcdef"
],
"chat_ids": [
"ou-7890123456abcdef"
],
"time_range": {
"start_time": "2026-03-21T16:15:30+08:00",
"end_time": "2026-03-21T16:15:30+08:00"
},
"include_attachment_types": [
"image"
],
"from_types": [
"user"
],
"at_chatter_ids": [
"ou-7890123456abcdef"
],
"chat_type": "group",
"is_at_me": true,
"exclude_from_types": [
"user"
]
}
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | message_search_item\[\] | items
id | string | 消息ID
display_info | string | 包含消息基本信息的卡片,用户搜索关键词命中的文本 片段,使用标签包裹标注
meta_data | message_search_meta | 消息元数据
message_id | string | 消息ID
type | string | 消息类型
**可选值有**：
- unknown：unknown
- post：post
- file：file
- text：text
- image：image
- system：system
- audio：audio
- email：email
- share_group_chat：share_group_chat
- sticker：sticker
- merge_forward：merge_forward
- calendar：calendar
- cloud_file：cloud_file
- card：card
- media：media
- share_calendar_event：share_calendar_event
- hongbao：hongbao
- general_calendar：general_calendar
- video_chat：video_chat
- location：location
- commercialized_hongbao：commercialized_hongbao
- share_user_card：share_user_card
- todo：todo
- folder：folder
- diagnose：diagnose
- vote：vote
- link：link
create_time | string | 创建时间(iso8601)
update_time | string | 更新时间(iso8601)
position | int | 消息位置
chat_id | string | 所在会话ID
from_id | string | 消息发送者ID
thread_id | string | 消息话题ID
thread_position | int | 消息话题位置
is_p2p_chat | boolean | 是否为单聊
total | int | total
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
notice | string | 搜索补充提示信息，返回本次搜索的额外说明，例如：query被截断；搜索结果不全等
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "om_40eb06e7b84dc71c03e00ida3c754892",
"display_info": "飞书搜索",
"meta_data": {
"message_id": "om_40eb06e7b84dc71c03e00ida3c754892",
"type": "post",
"create_time": "2026-03-21T16:15:30+08:00",
"update_time": "2026-03-21T16:15:30+08:00",
"position": 0,
"chat_id": "oc_5ad11d72b830411d72b836c20",
"from_id": "ou-7890123456abcdef",
"thread_id": "omt_d4be107c616a",
"thread_position": 10,
"is_p2p_chat": false
}
}
],
"total": 100,
"has_more": true,
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
"notice": "The query is too long and has been truncated to the first 50 characters for search."
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 230001 | param is invalid | 请参考接口文档的参数要求，检查并修正请求参数