product:chat

Get channel

Returns a channel by its CID without creating it. Responds with 404 when the channel does not exist, so it doubles as an existence check. Pass state=true to also load messages, read state and watchers, and the messages_id_* parameters to page those messages by message ID.

get/channels/{type}/{id}

Path parameters

typestring required

Channel type to interact with

idstring required

Channel ID to interact with

Query parameters

stateboolean
messages_limitinteger
members_limitinteger
watchers_limitinteger
messages_id_ltstring
messages_id_ltestring
messages_id_gtstring
messages_id_gtestring
messages_id_aroundstring
user_idstring

Response

Successful response

durationstring required
hiddenboolean
hide_messages_beforestring date-time
watcher_countinteger

Changes