搜索对用户或机器人可见的群列表

获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。

前提条件

应用需要开启机器人能力。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/search
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat:readonly 获取群组信息 im:chat:read 查看群信息 im:chat.group_info:readonly 读取群信息（历史版本）
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
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
query	string	否	关键词 注意： - 关键词支持匹配群国际化名称、群成员名称 - 支持使用多语种搜索（飞书客户端内支持的多语种） - 支持拼音、前缀等模糊搜索 - 关键词为空值或长度超过 64 个字符时将返回空的结果 - 关键词中尽量不要包含 - 符号。如果必须包含该符号，请在传值时添加双引号，例如 “Example-0”。 示例值：abc
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==
page_size	int	否	分页大小，用来限制一次请求所返回的数据条目数。 示例值：10 默认值：20 数据校验规则： - 最大值：100

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	list_chat\[\]	群组列表
└ chat_id	string	群组 ID，调用获取群信息接口，根据群组 ID 可获取群详细信息。
└ avatar	string	群头像 URL
└ name	string	群名称
└ description	string	群描述
└ owner_id	string	群主的用户 ID，ID 类型与 owner_id_type 相对应。 注意：群主为机器人时无返回值。
└ owner_id_type	string	群主的用户 ID 类型，类型分为 user_id、open_id、union_id。各类型 ID 介绍参考用户身份概述。 注意：群主为机器人时无返回值。
└ external	boolean	是否是外部群
└ tenant_key	string	租户 Key，为租户在飞书上的唯一标识，用来换取对应的tenant_access_token，也可以用作租户在应用中的唯一标识。
└ chat_status	string	群状态 可选值有： - normal: 正常 - dissolved: 解散 - dissolved_save: 解散并保留
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "chat_id": "oc_a0553eda9014c201e6969b478895c230",
                "avatar": "https://p3-lark-file.byteimg.com/img/lark-avatar-staging/default-avatar_44ae0ca3-e140-494b-956f-78091e348435~100x100.jpg",
                "name": "测试群名称",
                "description": "测试群描述",
                "owner_id": "4d7a3c6g",
                "owner_id_type": "user_id",
                "external": false,
                "tenant_key": "736588c9260f175e",
                "chat_status": "normal"
            }
        ],
        "page_token": "dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误。请参考 API 文档参数描述，排查请求时参数是否填写有误。
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232034	The app is unavailable or inactivate in the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。

更多错误码信息，参见通用错误码。