在线调试
分页查询群成员列表
更新时间: 2024/07/17 17:08:08
该接口用于分页查询群组的所有成员列表,也可以根据查询类型查询群组中的禁言成员列表。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
GET https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/list_members
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_id |
String | 必选 | 需要查询的群组 ID,创建群组成功时,云信服务器会自动生成并返回。 |
查询参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_type |
Integer | 必选 | 群组类型。1:高级群;2:超大群。 |
member_type |
Integer | 可选 | 指定需要查询的成员类型。 0(默认):查询全部成员;1:仅查询群主和管理员;2:仅查询普通成员。 |
chat_banned_type |
Integer | 可选 | 指定仅查询禁言成员。 0(默认):查询全部成员;1:仅查询禁言成员;2:仅查询非禁言成员。 |
descending |
Boolean | 可选 | 是否按照成员入群时间降序排列。默认为 fasle,即按照入群时间升序排序。 |
page_token |
String | 可选 | 分页标识符,如果为空,则从第一页开始查询。 |
limit |
Integer | 可选 | 每页返回的成员数上限,最大为 100。小于等于 0,或者大于 100,会报 414 错误。 |
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "osuccess"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
has_more |
Boolean | 是否还有更多数据。 | 是 |
next_token |
String | 分页标识符。 | 否 |
-
items |
Array of objects | 返回的群成员列表。 | 是 |
team_id |
Long | 群组 ID。 | 是 |
account_id |
String | 群成员的云信账号 ID。 | 是 |
member_role |
Integer | 群成员类型。0:普通成员;1:群主;2:群管理员。 | 是 |
team_nick |
String | 成员在本群内的昵称。 | 是 |
server_extension |
String | 自定义扩展字段,JSON 格式。 | 否 |
chat_banned |
Boolean | 成员在本群中是否被禁言。 | 否 |
join_time |
Long | 成员加入群的时间戳。 | 是 |
update_time |
Long | 成员更新的时间戳。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": {
"has_more": true,
"next_token": "werqweasdf",
"items": [
{
"team_id": 7294343,
"account_id": "dog11",
"chat_banned": true,
"server_extension": "dog1",
"member_role": 0,
"team_nick": "",
"join_time": 1697022900157,
"update_time": 1697022943625
}
]
}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频控超出限制 | rate limit exceeded |
108404 | 群组不存在 | team not exist |
108311 | 超大群服务未开通 | super team service disabled |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?