Chat
List Messages
Retrieve all chat messages within a particular dialog.
GET
Recipes
All retrieved chat messages will be marked as read after request.
Messages will be marked in 2 cases:
- if the current user ID is in
occupants_ids
field fortype=2
(GROUP) dialog; - if dialog’s
type=1
(PUBLIC) dialog.
Search operators
The request can contain all, some or none of the next search operators:
Operator | Description |
---|---|
lt | Less Than operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id, updated_at Example: date_sent[lt]=1556829805 Description: Will return messages with date_sent less than 1556829805. |
lte | Less Than or Equal to operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id, updated_at Example: updated_at[lte]=1556829805 Will return messages with updated_at less than or equal 1556829805. |
gt | Greater Than operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id, updated_at Example: date_sent[gt]=1556829805 Will return messages with date_sent greater than 1556829805. |
gte | Greater Than or Equal to operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id, updated_at Example: date_sent[gte]=1556829805 Will return messages with date_sent greater than or equal 1556829805. |
ne | Not Equal to operator Types: number, string, date Applicable to fields: _id, message, date_sent, sender_id, recipient_id Example: recipient_id[ne]=9988237 Will return messages with recipient_id not equal to 9988237. |
in | Contained IN array operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id Example: sender_id[in]=91419276,91419395 Will return messages with sender_id equal to 91419276 and equal to 91419395. |
nin | Not contained IN array Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id Example: recipient_id[nin]=91419276,91419395 Will return messages with recipient_id not equal to 91419276 and 91419395. |
or | OR operator Types: number, string, date Applicable to fields: date_sent, sender_id, recipient_id Example: sender_id[or]=91419390,96753878 Will return messages with sender_id equal to 91419390 or 96753878. |
ctn | Contains substring operator Types: string Applicable to fields: message Example: message[ctn]=party Returns messages which text contains the word “party”. |
Sort operators
Next sorting operators are allowed:
Operator | Description |
---|---|
sort_asc | Types: all types Example: sort_asc=field_name Search results will be sorted by the specified field in ascending order. |
sort_desc | Types: all types Example: sort_desc=field_name Search results will be sorted by the specified field in descending order. |
Query Parameters
ID of the dialog.
Search records with the field that contains the specified value. Can be many 1..N.
Filters records with field which contains value according to specified value and operator. Can be many 1..N.
Mark the requested message(s) as read. Set
mark_as_read=1
to perform. As a result, when the message(s) is retreived by the opponent, the opponent ID is added to the array of read_ids field. Works only if the message had the unread status previously, not backwards. You can update message status using the Update Message request. Limit search results to N records. Useful for pagination.
Skip N records in search results. Useful for pagination.
Count search results. Response will contain only a count of found records.
Search results will be sorted by a specified field in descending order.
Search results will be sorted by a specified field in ascending order.
Headers
A user or application session token. See our Authentication page to learn more about session tokens. Must be used either QB-Token or Authorization.
API key from Dashboard. Expected format:
ApiKey {your_api_key}
. Must be used either QB-Token or Authorization.User ID. The user ID of the user on whose behalf the request is being made.
Responses
Was this page helpful?