Call chat sessions list

Use this endpoint to search list of chat sessions.

Query Params
string
required

Comma-separated list of enum names. Example- id,chatId,companyId,name,chatName,whatsappPhone,botId,botName,markedAsSpam,userId,operatorGroupIds,operatorName,operatorType,operatorMessageCount,clientMessageCount,botMessageCount,clientDeviceId,clientId,clientExternalId,clientIp,location,timeZone,countryCode,countryName,regionCode,regionName,city,zipCode,messengerType,status,referer,dialogResults,operatorResults,nps,createdAt,operatorLastMessageCreatedAt,updatedAt,noResponseOperatorToClient,botLastMessageCreatedAt,lastMessageCreatedAt,clientLastMessageCreatedAt,clientOnlineAt,clientOfflineAt,operatorAssignedAt,price,operatorDialogDuration,operatorFirstMessageCreatedAt,switchAnotherOperator,haveExternalMessage,botStatus,closedAt,closedByUserId,closedByOperatorName,closedByBotId,clientUserAgent,csi,csiMax,csiPercent,rating,fcr,operatorTimerFirstAnswer,operatorTimerNextAnswers,metrics,operatorNotFoundAt,takenByOperatorAt,isLostSession

integer
≤ 1000
Defaults to 10

Maxium number of returning records. (max 1000)

integer

Starting point to return records from a result set.

integer

Page number, used to paginate over all records.

string

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

The bot identifier.

integer

The company identifier.

boolean

Show all supervised companies.

string

The chat session identifier.

string

The chat identifier.

string

The client identifier.

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: createdAt,startedAt,finisheAt,billedAt,speakerFinishedAt,duration,price. Default - startedAt.

Responses

400

Invalid input parameters

401

User is not authenticated

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