List Dialogs

Retrieve a list of chat dialogs. You can list dialogs using specific search criteria.

Recipes
Get dialog by dialog ID
Open Recipe
Filter dialogs by type
Open Recipe
Filter dialogs by custom field
Open Recipe
Display total number of all dialogs
Open Recipe
Get dialogs with API key
Open Recipe

Search Operators

The request can contain all, some or none of the next search operators.

OperatorDescription
ltLess 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.
lteLess 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.
gtGreater 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.
gteGreater 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.
neNot 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.
inContained 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.
ninNot 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.
allALL 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).
ctnContains 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:

OperatorDescription
sort_ascTypes: all types

Example: sort_asc=field_name

Search results will be sorted by the specified field in ascending order.
sort_descTypes: all types

Example:
sort_desc=field_name

Search results will be sorted by the specified field in descending order.
Query Params
string

Search records with the field that contains the specified value. Can be many 1..N.

string

Filters records with field that contains the value according to the specified value and operator. Can be many 1..N.

int32
Defaults to 1

Unread message count is calculated for dialogs by default. Set include_unread_message_count=0 to skip calculation, this will speed up request. By default: 1.
Added in v2.4.5

int32
Defaults to 100

Limit search results to N records. Useful for pagination. Default: 100

string
Defaults to 0

Skip N records in search results. Useful for pagination. Default: 0

string

Count search results. Set count=1 to apply. Response will contain only count of records found. If the parameter is not passed, the response will contain all available dialog records along with their count.

string

Search results will be sorted by the specified field in descending order.

string

Search results will be sorted by the specified field in ascending order.

string

Class name in Custom Objects.

string

Field name of class in Custom Objects. Can be many 1..N.

Headers
string
required

A user session token. See our Authentication page to learn more about the session token.

string
Defaults to ApiKey {your API key}

Server API key, The API key should be formatted as "ApiKey {your API key}".

string

User ID. The user ID of the user on whose behalf the request is being made.

Response

Language
Request
Choose an example:
application/json