Qodex.ai

List messages

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

List messages

Retrieves a list of past messages of a channel.

This message retrieval is one of Sendbird's premium features. Contact our sales team for further assistance.

https://sendbird.com/docs/chat/v3/platform-api/guides/messages#2-list-messages

channel_type Type: string Description: Specifies the type of the channel. Either openchannels or groupchannels. channel_url Type: string Description: Specifies the URL of the channel to retrieve a list of past messages.

Request Params

KeyDatatypeRequiredDescription
message_tsstring
message_idstring
prev_limitstring
next_limitstring
includestring
reversestring
sender_idstring
sender_idsstring
operator_filterstring
custom_typesstring
message_typestring
including_removedstring
include_reactionsstring
with_sorted_meta_arraystring
show_subchannel_messages_onlystring
user_idstring
custom_typestring
with_meta_arraystring

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Acceptstring

RESPONSES

status: OK

{"messages":[{"message_survival_seconds":"\u003cnumber\u003e","custom_type":"\u003cstring\u003e","mentioned_users":[{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}}],"translations":"\u003cobject\u003e","updated_at":"\u003cnumber\u003e","is_op_msg":"\u003cboolean\u003e","is_removed":"\u003cboolean\u003e","user":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","role":"\u003cstring\u003e","user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},"file":"\u003cobject\u003e","message":"\u003cstring\u003e","data":"\u003cstring\u003e","message_retention_hour":"\u003cnumber\u003e","silent":"\u003cboolean\u003e","type":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","channel_type":"\u003cstring\u003e","req_id":"\u003cstring\u003e","mention_type":"\u003cstring\u003e","channel_url":"\u003cstring\u003e","message_id":"\u003cnumber\u003e","sorted_metaarray":[{"key":"\u003cstring\u003e","value":["\u003cstring\u003e","\u003cstring\u003e"]},{"key":"\u003cstring\u003e","value":["\u003cstring\u003e","\u003cstring\u003e"]}],"og_tag":{"og:url":"\u003cstring\u003e","og:title":"\u003cstring\u003e","og:description":"\u003cstring\u003e","og:image":{"url":"\u003cstring\u003e","secure_url":"\u003cstring\u003e","width":"\u003cnumber\u003e","height":"\u003cnumber\u003e"}}},{"message_survival_seconds":"\u003cnumber\u003e","custom_type":"\u003cstring\u003e","mentioned_users":[{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},{"user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}}],"translations":"\u003cobject\u003e","updated_at":"\u003cnumber\u003e","is_op_msg":"\u003cboolean\u003e","is_removed":"\u003cboolean\u003e","user":{"require_auth_for_profile_image":"\u003cboolean\u003e","is_active":"\u003cboolean\u003e","role":"\u003cstring\u003e","user_id":"\u003cstring\u003e","nickname":"\u003cstring\u003e","profile_url":"\u003cstring\u003e","metadata":{"anyOf":"\u003cstring\u003e"}},"file":"\u003cobject\u003e","message":"\u003cstring\u003e","data":"\u003cstring\u003e","message_retention_hour":"\u003cnumber\u003e","silent":"\u003cboolean\u003e","type":"\u003cstring\u003e","created_at":"\u003cnumber\u003e","channel_type":"\u003cstring\u003e","req_id":"\u003cstring\u003e","mention_type":"\u003cstring\u003e","channel_url":"\u003cstring\u003e","message_id":"\u003cnumber\u003e","sorted_metaarray":[{"key":"\u003cstring\u003e","value":["\u003cstring\u003e","\u003cstring\u003e"]},{"key":"\u003cstring\u003e","value":["\u003cstring\u003e","\u003cstring\u003e"]}],"og_tag":{"og:url":"\u003cstring\u003e","og:title":"\u003cstring\u003e","og:description":"\u003cstring\u003e","og:image":{"url":"\u003cstring\u003e","secure_url":"\u003cstring\u003e","width":"\u003cnumber\u003e","height":"\u003cnumber\u003e"}}}]}