Chat
List Dialogs
Retrieve a list of chat dialogs. You can list dialogs using specific search criteria.
GET
Recipes
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: last_message_date_sent, created_at, updated_at Example: ?updated_at[lt]=1556829805 Will return dialogs with updated_at less than 1556829805. |
| lte | Less Than or Equal to operator Types: number, string, date Applicable to fields: last_message_date_sent, created_at, updated_at Example: ?last_message_date_sent[lte]=1556735709 Will return dialogs with last_message_date_sent less than or equal 1556735709. |
| gt | Greater Than operator Types: number, string, date Applicable to fields: last_message_date_sent, created_at, updated_at Example: ?last_message_date_sent[gt]=1556735709 Will return dialogs with last_message_date_sent greater than 1556735709. |
| gte | Greater Than or Equal to operator Types: number, string, date Applicable to fields: last_message_date_sent, created_at, updated_at Example: ?last_message_date_sent[gt]=1556735709 Will return dialogs with last_message_date_sent greater than 1556735709. |
| ne | Not Equal to operator Types: number, string, date Applicable to fields: _id, name, last_message_date_sent Example: ?_id[ne]=5cc9bb58a28f9a406659d777 Will return dialogs with _id not equal to 5cc9bb58a28f9a406659d777. |
| in | Contained IN array operator Types: number, string, date Applicable to fields: type, last_message_date_sent, name Example: ?type[in]=1,2 Will return dialogs with type equal to 1 and equal to 2. |
| nin | Not contained IN array operator Types: number, string, date Applicable to fields: last_message_date_sent Example: ?last_message_date_sent[nin]=1556739654, 1556739987 Will return dialogs with last_message_date_sent not equal to 1556739654 and 1556739987. |
| all | ALL contained IN array Types: number Applicable to fields: occupants_ids Example: ?occupants_ids[all]=91103344,91142495 Will return dialogs with occupants_ids equal to 91103344 and 91142495 (both). |
| ctn | Contains substring operator Types: string Applicable to field: name Example: ?name[ctn]=party Returns dialogs whose name 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
Search records with the field that contains the specified value. Can be many 1..N.
Filters records with field that contains the value according to the specified value and operator. Can be many 1..N.
Unread message count is calculated for dialogs by default. Set to 0 to skip calculation, which will speed up the request.
Added in v2.4.5.
Limit search results to N records. Useful for pagination.
Skip N records in search results. Useful for pagination.
Count search results. Set to 1 to apply. Response will contain only count of records found. If not passed, the response will contain all available dialog records along with their count.
Search results will be sorted by the specified field in descending order.
Search results will be sorted by the specified field in ascending order.
Class name in Custom Objects.
Field name of class in Custom Objects. Can be many 1..N.
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?