获取群成员列表

获取用户/机器人所在群的群成员列表。

注意事项：

机器人或授权用户必须在群组中

该接口不会返回群内的机器人成员

由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size

如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size

获取内部群信息时，操作者须与群组在同一租户下

{ "code": 0, "msg": "success", "data": { "items": [ { "member_id_type": "open_id", "member_id": "ou_9204a37300b3700d61effaa439f34295", "name": "张三" } ], "page_token": "0", "has_more": true } }

请求参数

Path 参数

chat_id

必需

群 ID

示例值："oc_a0553eda9014c201e6969b478895c230"

示例值:

oc_a0553eda9014c201e6969b478895c230

Query 参数

member_id_type

可选

群成员用户 ID 类型，详情参见用户相关的 ID 概念示例值："open_id" 可选值有： user_id：以 user_id 来识别成员 union_id：以 union_id 来识别成员 open_id：以 open_id 来识别成员当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

page_token

string

可选

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

示例值:

dmJCRHhpd3JRbGV1VEVNRFFyTitRWDY5ZFkybmYrMEUwMUFYT0VMMWdENEtuYUhsNUxGMDIwemtvdE5ORjBNQQ==

page_size

string

可选

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

示例值:

Header 参数

Authorization

string

必需

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

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {4}]

成员列表

必需

page_token

string

必需

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

has_more

boolean

是否还有更多项

必需

member_total

integer

成员总数

必需