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

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:
?updated_at[nin]=1556739654, 1556739987

Will return dialogs with updated_at 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.
Language