Sendbird/listChannels

暂不支持在线调用 · 原因见下方

SendbirdSendbird 聊天平台服务端 API v3

GET/v3/group_channels

获取群组频道列表

检索应用内群组频道的列表，可通过多种查询参数限定搜索范围并选择要返回的频道信息。如需获取某个用户已加入的频道，应改用 User 模块下按用户列出群组频道的接口。

通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint；客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容，Pontx 不代理、缓存或聚合，调用方使用本地 SDK/CLI 直连。

请求

operationId: listChannels
服务器: https://api-{app_id}.sendbird.com
认证: apiTokenAuth

请求参数

`token`

querystring

令牌

next_page_token_abc

`limit`

querynumber

返回条数上限

`distinct_mode`

querystring

独立频道模式

all

`public_mode`

querystring

公开频道模式

all

`super_mode`

querystring

超级频道模式

all

`created_after`

querynumber

created after 字段。

`created_before`

querynumber

created before 字段。

`show_empty`

queryboolean

show empty 字段。

true

`show_member`

queryboolean

是否显示成员

true

`show_delivery_receipt`

queryboolean

show delivery receipt 字段。

true

`show_read_receipt`

queryboolean

show read receipt 字段。

true

`show_metadata`

queryboolean

show metadata 字段。

true

`show_frozen`

queryboolean

show frozen 字段。

true

`order`

querystring

排序方式

chronological

`metadata_order_key`

querystring

metadata order key 字段。

metadata_key

`custom_types`

querystring

custom types 字段。

custom_types_value

`custom_type_startswith`

querystring

custom type startswith 字段。

search_term

`channel_urls`

querystring

channel urls 字段。

channel_urls_value

`name`

querystring

名称

Example Channel

`name_contains`

querystring

name contains 字段。

search_term

`name_startswith`

querystring

name startswith 字段。

search_term

`members_exactly_in`

querystring

members exactly in 字段。

members_exactly_in_value

`members_include_in`

querystring

members include in 字段。

members_include_in_value

`query_type`

querystring

query type 字段。

default

`members_nickname`

querystring

members nickname 字段。

Alice

`members_nickname_contains`

querystring

members nickname contains 字段。

Alice

`metadata_key`

querystring

metadata key 字段。

metadata_key

`metadata_values`

querystring

metadata values 字段。

metadata_value

`metadata_value_startswith`

querystring

metadata value startswith 字段。

metadata_value

`metacounter_key`

querystring

metacounter key 字段。

metadata_key

`metacounter_values`

querystring

metacounter values 字段。

metadata_value

`metacounter_value_gt`

querystring

metacounter value gt 字段。

metadata_value

`metacounter_value_gte`

querystring

metacounter value gte 字段。

metadata_value

`metacounter_value_lt`

querystring

metacounter value lt 字段。

metadata_value

`metacounter_value_lte`

querystring

metacounter value lte 字段。

metadata_value

`include_sorted_metaarray_in_last_message`

queryboolean

include sorted metaarray in last message 字段。

true

响应

`200`

GroupChatListChannelsResponseapplication/json

请求成功。

字段: channelsnextts

`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

{
  "channels": [],
  "next": "next_page_token_abc",
  "ts": 1
}