SendbirdSendbird 聊天平台服务端 API v3
GET/v3/{channel_type}/{channel_url}/messages
获取频道消息列表
按创建时间排序获取频道历史消息,channel_type 为 open_channels/group_channels,channel_url 指定频道;线程回复不与父消息分组。
通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint;客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容,Pontx 不代理、缓存或聚合,调用方使用本地 SDK/CLI 直连。
请求
- operationId
listMessages- 服务器
https://api-{app_id}.sendbird.com- 认证
- apiTokenAuth
请求参数
channel_type
pathstring必填
channel type 字段。
open_channels
channel_url
pathstring必填
频道 URL
group_channel_123
message_ts
querynumber必填
message ts 字段。
1
message_id
querynumber必填
message id 字段。
1
prev_limit
querynumber
prev limit 字段。
1
next_limit
querynumber
next limit 字段。
1
include
queryboolean
include 字段。
true
reverse
queryboolean
reverse 字段。
true
sender_id
querystring
sender id 字段。
sender_id_value
sender_ids
querystring
sender ids 字段。
sender_ids_value
operator_filter
querystring
operator filter 字段。
all
custom_types
querystring
custom types 字段。
custom_types_value
message_type
querystring
消息类型
MESG
including_removed
queryboolean
including removed 字段。
true
include_reactions
queryboolean
include reactions 字段。
true
include_reply_type
querystring
include reply type 字段。
NONE
include_parent_message_info
queryboolean
include parent message info 字段。
true
include_thread_info
queryboolean
include thread info 字段。
true
include_poll_details
queryboolean
include poll details 字段。
true
with_sorted_meta_array
queryboolean
with sorted meta array 字段。
true
show_subchannel_messages_only
queryboolean
show subchannel messages only 字段。
true
user_id
querystring
用户 ID
user_id_123
响应
200
ListMessagesResponseapplication/json
请求成功。
字段: messages
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
{
"messages": []
}