# 搜索机器人

用户可以通过关键字搜索可见的机器人，可见性和套件内搜索一致。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/bot/v4/bot/search
HTTP Method | POST
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 搜索机器人(search:bot)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 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 | 否 | **示例值**：10
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- 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)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
query | string | 否 | query (长度范围：0 ～ 50 字符)<br>**示例值**："会议助手"
filter | bot_search_filter | 否 | filter
chat_ids | string\[\] | 否 | 群聊ID列表，查询指定群聊内的机器人<br>群聊ID获取参考：https://open.larkoffice.com/document/server-docs/group/chat/chat-id-description<br>**示例值**：["oc-7890123456abcdef"]<br>**数据校验规则**：<br>- 长度范围：`0` ～ `100`
has_chatter | boolean | 否 | 是否和机器人聊过天，如果设置true，只返回有聊天的机器人<br>**示例值**：false

### 请求体示例
```json
{
    "query": "会议助手",
    "filter": {
        "chat_ids": [
            "oc-7890123456abcdef"
        ],
        "has_chatter": false
    }
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | bot_search_item\[\] | items
id | string | 机器人ID
display_info | string | 包含机器人基本信息的卡片，用户搜索关键词命中的文本片段，使用<h></h>标签包裹标注
meta_data | bot_search_meta | 机器人元信息
tenant_id | string | 租户ID
enable_join_group | boolean | 是否允许加入群聊
chat_id | string | 机器人所属的群聊ID
is_agent | boolean | 是否是智能体
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
notice | string | 搜索补充提示信息，返回本次搜索的额外说明，例如：query被截断；搜索结果不全等

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7890123456abcdef",
                "display_info": "飞书<h>搜索</h>助手",
                "meta_data": {
                    "tenant_id": "7010970696222244883",
                    "enable_join_group": false,
                    "chat_id": "oc-7890123456abcdef",
                    "is_agent": false
                }
            }
        ],
        "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 | 4001 | invalid param: missing required fields | 请参考接口文档的参数要求，检查并修正请求参数