Retrieve all chat messages within a particular dialog.
Filter messages by word
1. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.2. Set a search operator for a field
ctn
operator is applied to a message
field with the guys
value.3. As a result, the API will return messages satisfying the specified criteria.
Filter and sort messages
1. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.2. Set a search operator for a field
lt
operator is applied to a date_sent
field.3. Set a sort operator for a field
sort_desc
operator is applied to the date_sent
field.4. As a result, the API returns messages filtered and sorted upon the request.
Get message by its ID
1. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.2. Set the ID of the message
_id
parameter to refer to a particular message.3. As a result, the API returns a specified message.
Get message by its ID with API key
1. Use 'Authorization' header to pass API key
2. Use 'On-Behalf-Of' header to pass user id
3. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.4. Set the ID of the message
_id
parameter to refer to a particular message.5. As a result, the API returns a specified message.
Filter messages by word with API key
1. Use 'Authorization' header to pass API key
2. Use 'On-Behalf-Of' header to pass user id
3. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.4. Set a search operator for a field
ctn
operator is applied to a message
field with the guys
value.5. As a result, the API will return messages satisfying the specified criteria.
Filter and sort messages with API key
1. Use 'Authorization' header to pass API key
2. Use 'On-Behalf-Of' header to pass user id
3. Set the ID of the dialog
chat_dialog_id
to refer to a specific dialog.4. Set a search operator for a field
lt
operator is applied to a date_sent
field.5. Set a sort operator for a field
sort_desc
operator is applied to the date_sent
field.6. As a result, the API returns messages filtered and sorted upon the request.
occupants_ids
field for type=2
(GROUP) dialog;type=1
(PUBLIC) dialog.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”. |
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. |
mark_as_read=1
to perform. As a result, when the message 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. ApiKey {your_api_key}
. Must be used either QB-Token or Authorization.403
404