# 多实体搜索
多实体搜索，适用于写信联系人搜索
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/mail/v1/multi_entity/search
HTTP Method | POST
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查询用户的企业邮箱(mail:user_mailbox:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 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"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
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 | 是 | 搜索关键词
**数据校验规则：** 长度范围：1 字符 ～ 50 字符
**示例值**："周会"
size | int | 否 | 获取的数据条数，**默认20，支持1-20**
**示例值**：20
**默认值**：`20`
**数据校验规则**：
- 取值范围：`1` ～ `20`
### 请求体示例
```json
{
"query": "周会",
"size": 20
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | multi_entity_search_item\[\] | 返回的实体详情
type | string | 标识当前的实体是哪种（例如：user, chat 等）
id | string | 唯一标识 ID
name | string | 名称
email | string | 邮箱地址
display_name | string | 备注名
member_count | int | 群成员数量
user_id | string | 用户 ID
department | string | 部门信息
chat_id | string | 群聊或会话 ID
tag | string | 标签
notice | string | 搜索补充提示信息，返回本次搜索的额外说明，例如：query被截断；搜索结果不全 等
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"type": "user",
"id": "6911188411932033028",
"name": "张三",
"email": "zhangsan@bytedance.com",
"display_name": "备注名",
"member_count": 128,
"user_id": "ou_2d131f4c3a28b0",
"department": "飞书研发团队",
"chat_id": "oc_40ed357053e34b9",
"tag": "超大群/部门群/邮箱联系人/邮件组/外部"
}
],
"notice": "The query is too long and has been truncated to the first 50 characters for search."
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1231001 | invalid param | 检查请求参数是否缺失、类型或格式错误。
500 | 1231002 | network error | 检查网络连接或下游服务是否短暂不可用，建议重试。
500 | 1231011 | query is too long | 缩短搜索关键词或查询条件。
500 | 1231012 | invalid filter | 检查 filter 字段格式和值是否合法。
500 | 1231020 | page_token is invalid or expired | page_token 已失效或不合法，请重新发起搜索。
500 | 1231021 | page_size exceeds maximum allowed value | 调小 page_size，不要超过接口限制。
500 | 1231022 | pagination limit reached | 分页已超过限制，请收窄查询条件后重新搜索。
500 | 1231030 | user identity not found | 检查 access token 是否有效，以及是否能识别到用户身份。
500 | 1231031 | failed to initialize request context | 请求上下文初始化失败，请检查 token、租户和请求基础信息。
500 | 1231040 | search service error | 搜索服务异常，请稍后重试；若仍无法解决，请携带 request_id/log_id 联系飞书技术支持：https://applink.feishu.cn/TLJpeNdW
500 | 1231041 | failed to process search result | 搜索结果处理失败，请稍后重试；若仍无法解决，请携带 request_id/log_id 联系飞书技术支持：https://applink.feishu.cn/TLJpeNdW
500 | 1232601 | meeting time format is invalid | 检查会议时间格式是否符合接口要求。
500 | 1232602 | failed to build meeting filter | 检查会议筛选条件是否完整且格式正确。
500 | 1232603 | failed to convert meeting search result | 会议搜索结果转换失败，请稍后重试；若仍无法解决，请携带 request_id/log_id 联系飞书技术支持：https://applink.feishu.cn/TLJpeNdW
500 | 1232604 | invalid meeting room ID format | 检查会议室 ID 格式是否正确。
401 | 1234011 | user_access_token is invalid or expired | user_access_token 无效或已过期，请重新获取用户态 token。