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

GET

/open-apis/im/v1/chats/search

自建应用商店应用

搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。
注意事项：

Access token与发起搜索的主体相对应。

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误，参考本文档检查输入参数。
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232025	Bot ability is not activated.	应用需要开启机器人能力。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/im/v1/chats/search' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id_type": "open_id",
    "query": "测试"
}'

响应示例

{
  "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"
      }
    ],
    "page_token": "dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==",
    "has_more": true
  }
}

请求参数

Query 参数

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，字段权限要求：获取用户 user ID

示例值:

open_id

query

string

可选

关键词。注意：如果query为空值将返回空的结果示例值："abc"

示例值:

abc

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ=="

示例值:

dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

page_size

string

可选

分页大小示例值：10 数据校验规则：最大值：100

示例值:

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Body 参数application/json

user_id_type

string

可选

query

string

必需

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {8}]

chat 列表

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

has_more

boolean

是否还有更多项

必需

修改于 2023-01-13 05:41:08

获取用户或机器人所在的群列表

获取群成员发言权限

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

错误码#

请求参数

返回响应

错误码