Skip to main content
GET

Path Parameters

chat_dialog_id
string
required
ID of the dialog to which a current message is connected. Generated automatically by the server after message creation.

Headers

QB-Token
string
required
A user or application session token. See Authentication page to learn more about session tokens. Must be used either QB-Token or Authorization.
Authorization
string
default:"ApiKey {your_api_key}"
API key from Dashboard. Expected format: ApiKey {your_api_key}. Must be used either QB-Token or Authorization.
On-Behalf-Of
string
User ID. The user ID of the user on whose behalf the request is being made.

Responses

A successful response
_id
string
created_at
string
last_message
string
last_message_date_sent
integer
last_message_id
string
last_message_user_id
integer
name
string
occupants_ids
array of integers
admin_ids
array of integers (added in v2.52.0)
photo
string
type
integer
updated_at
string
user_id
integer
xmpp_room_jid
string
unread_messages_count
integer
is_join_required
integer
An error response
errors
array of strings
An error response
errors
array of strings