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

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

注意事项:

  • 可以以用户身份调用

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/im/chats
HTTP Method GET
支持的应用类型 自建应用
商店应用
权限要求
开启任一权限即可
获取与更新群组信息
字段权限要求 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请
获取用户 user_id

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token

user_access_token
值格式:"Bearer access_token"
示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560"

# 查询参数

名称 类型 必填 描述
page_token string 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"dmJCRHhpd3JRbGV1VEVNRF"
page_size int 分页大小
示例值:10
数据校验规则
* 最大值:100

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
 ∟list_chat list_chat[] chat 列表
  ∟chat_id string 群组 ID
  ∟avatar string 群头像 URL
  ∟name string 群名称
  ∟bulletin string 群公告
  ∟owner_id string 群主 ID
  ∟chat_type string 群类型 公开群/非公开群
 ∟page_token string 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,
否则不返回 page_token
 ∟has_more boolean 是否还有更多项

# 响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "has_more": false,
    "page_token": null,
    "list_chat": [
      {
        "chat_id": "3da2e8374623647c1HR90tQ~",
        "avatar": "https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJszE7Wzo71PYZSsSxb5UMoTJe0r9FIuPuhgvshF4VBTWnIW3cCzfPoaA8WPqIc~.png",
        "name": "开放平台测试11",
        "owner_id": "11111111392",
        "bulletin": "开放平台测试11",
        "chat_type": "1"
      }
    ]
  },
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
最后更新于 : 8/21/2023, 4:57:10 PM