Sendbird/listMessages

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

GET/v3/{channel_type}/{channel_url}/messages

List channel messages

Retrieves a channel's past messages in creation order. channel_type is open_channels or group_channels, channel_url identifies the channel, and thread replies are not grouped with their parents.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId
listMessages
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

channel_type

pathstringrequired

channel type field.

open_channels

channel_url

pathstringrequired

Channel URL.

group_channel_123

message_ts

querynumberrequired

message ts field.

1

message_id

querynumberrequired

message id field.

1

prev_limit

querynumber

prev limit field.

1

next_limit

querynumber

next limit field.

1

include

queryboolean

include field.

true

reverse

queryboolean

reverse field.

true

sender_id

querystring

sender id field.

sender_id_value

sender_ids

querystring

sender ids field.

sender_ids_value

operator_filter

querystring

operator filter field.

all

custom_types

querystring

custom types field.

custom_types_value

message_type

querystring

Message type.

MESG

including_removed

queryboolean

including removed field.

true

include_reactions

queryboolean

include reactions field.

true

include_reply_type

querystring

include reply type field.

NONE

include_parent_message_info

queryboolean

include parent message info field.

true

include_thread_info

queryboolean

include thread info field.

true

include_poll_details

queryboolean

include poll details field.

true

with_sorted_meta_array

queryboolean

with sorted meta array field.

true

show_subchannel_messages_only

queryboolean

show subchannel messages only field.

true

user_id

querystring

User identifier.

user_id_123

Responses

200

ListMessagesResponseapplication/json

Request succeeded.

Properties: messages

400

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

401

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

403

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

404

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

429

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

500

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "messages": []
}