SendbirdSendbird 聊天平台服务端 API v3
GET/v3/group_channels/{channel_url}/members
获取频道成员列表
检索指定群组频道的成员列表,需提供 channel_url,可通过查询参数筛选与分页成员信息。
通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint;客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容,Pontx 不代理、缓存或聚合,调用方使用本地 SDK/CLI 直连。
请求
- operationId
listMembers- 服务器
https://api-{app_id}.sendbird.com- 认证
- apiTokenAuth
请求参数
channel_url
pathstring必填
频道 URL
group_channel_123
token
querystring
令牌
next_page_token_abc
limit
querynumber
返回条数上限
1
user_id
querystring
用户 ID
user_id_123
show_delivery_receipt
queryboolean
show delivery receipt 字段。
true
show_read_receipt
queryboolean
show read receipt 字段。
true
show_member_is_muted
queryboolean
show member is muted 字段。
true
order
querystring
排序方式
member_nickname_alphabetical
operator_filter
querystring
operator filter 字段。
all
member_state_filter
querystring
成员状态过滤
all
muted_member_filter
querystring
muted member filter 字段。
all
member_active_mode_filter
querystring
member active mode filter 字段。
activated
nickname_startswith
querystring
nickname startswith 字段。
Alice
include_push_preference
queryboolean
include push preference 字段。
true
响应
200
GroupChannelListMembersResponseapplication/json
请求成功。
字段: membersnext
400
SendbirdApiErrorapplication/json
请求参数无效。
字段: codemessage
401
SendbirdApiErrorapplication/json
未认证或 API 令牌无效。
字段: codemessage
403
SendbirdApiErrorapplication/json
无权限访问该资源。
字段: codemessage
404
SendbirdApiErrorapplication/json
未找到指定资源。
字段: codemessage
429
SendbirdApiErrorapplication/json
请求频率超限,请稍后重试。
字段: codemessage
500
SendbirdApiErrorapplication/json
上游服务内部错误。
字段: codemessage
{
"members": [],
"next": "next_page_token_abc"
}