Session list

get

https://chat-api.twin24.ai/api/v1/sessions

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

Query Params

withoutCount

boolean

Defaults to false

Determines whether to return the total number of records.

withoutItems

boolean

Defaults to false

Determines whether to return the record list.

limit

integer

Defaults to 10

Maxium number of returning records.

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

fields

string

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

sort

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.

sessionId

string

The particular session identifier.

from

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).

markedAsSpam

boolean

Determines whether to return chat sessions marked as spam.

operatorId

string

The operator identifier.

operatorType

string

enum

The operator type.

Allowed:

operatorGroups

string

The comma-separated list of operator group id to filter by. If an empty parameter is passed, sessions without operator groups are filtered out.

includeFromHistory

boolean

Identifies sessions in which the operator has ever worked. Works if the operatorId is specified.

botStatus

string

enum

The bot status.

Allowed:

status

string

enum

The chat session status.

Allowed:

name

string

The session name template.

chatId

string

The chat identifier.

groupByClientId

boolean

The session grouped by clientId.

200Success

5XXUnexpected error