Chat message list

get https://analyse.twin24.ai/api/v1/statistics/chat/messages

Use this endpoint to get list of chat messages.

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

output

string

Determines the output format.

filename

string

Base filename (without extension) to be downloaded.

archive

boolean

Determines whether the zip archive should be returned.

from

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)

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: createdAt, readAt.

companyId

integer

The company identifier (only for not authorized users).

chatId

string

The chat identifier.

sessionId

string

The chat session identifier.

botId

string

The bot identifier.

clientId

string

The client identifier.

clientExternalId

string

The client external identifier.

withBotId

string

The bot identifier to filter bot chat sessisons.

withOperatorId

integer

The operator identifier to filter operator chat sessisons.

withClientId

string

The client identifier to filter client chat sessisons.

withClientExternalId

string

The client external identifier to filter client chat sessisons.

authorType

string

The message author type.

Responses

400

Invalid input parameters

401

User is not authenticated

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://analyse.twin24.ai/api/v1/statistics/chat/messages?withoutCount=false&withoutItems=false&limit=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

5XXUnexpected error