Session list

Use this endpoint to get list of chat sessions created within the operator's company.

Log in to see full request history
Query Params
boolean
Defaults to false

Determines whether to return the total number of records.

boolean
Defaults to false

Determines whether to return the record list.

integer
Defaults to 10

Maxium number of returning records.

integer

Starting point to return records from a result set.

integer

Page number, used to paginate over all records.

string

Comma-separated list of a record's fields to be fetched

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: name, status, markedAsSpam, startedAt, lastMessageCreatedAt and operatorAssignedAt.

string

The particular session identifier.

string

The start date (for example, 2018-05-27T21:30:54+00:00).

string

The end date (for example, 2018-05-27T21:30:54+00:00).

boolean

Determines whether to return chat sessions marked as spam.

string

The operator identifier.

string

The operator type.

string

The bot status.

string

The chat session status.

string

The session name template.

string

The chat identifier.

boolean

The session grouped by clientId.

string

The comma-separated list of session tags to filter by.

boolean

Determines whether to return chat sessions where clients is banned.

string

By session name, phone number (whatsapp), clientId, sessionId.

Responses

400

Invalid input parameters

401

User is not authenticated

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json