Retrieve a list of chat dialogs. You can list dialogs using specific search criteria.
Filter dialogs by custom field
1. Set a custom object class
CoolDialog
custom object class.See this section to learn how to create a custom object class.2. Set a custom object field
friends
field of the CoolDialog
custom object class.3. As a result, the API returns all dialogs by the specified custom object field.
Display total number of all dialogs
1. Specify if you want to count dialogs
count
to 1
.2. As a result, the API returns a total number of all dialogs that exist in the system.
Get dialog by dialog ID
1. Set the dialog ID
2. As a result, the specified dialog is returned
Filter dialogs by type
1. Set a search operator for a field
in
operator is applied to a type
field.2. Set a sort operator for a field
sort_desc
operator is applied to the last_message_date_sent
field.3. Set a limit for a number of dialogs on the page
limit
parameter.Here, the number of dialogs on the page is limited to 3
.4. As a result, the API returns all public and group dialogs.
Get dialogs with API key
1. Use 'Authorization' header to pass API key
2. Use 'On-Behalf-Of' header to pass user_id
3. As a result, the API returns all public and group dialogs.
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”. |
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. |
ApiKey {your_api_key}
. Must be used either QB-Token or Authorization.