Notifications message list

get

https://analyse.twin24.ai/api/v1/search/messaging/messages

Use this endpoint to search list of notification messages.

Query Params

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.

output

string

enum

Determines the output format. CSV_EXCEL format includes UTF-8 BOM and semicolon delimiter for better Excel compatibility.

Allowed:

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, sentAt, deliveredAt, sendAt, expiredAt, billedAt.

companyId

integer

The company identifier.

allCompanies

boolean

Show all supervised companies.

keyword

string

Any search field (message body, messageId, bulkId, groupId, flowId, taskId, templateId, status, statusCode, channel, destination, from, text, network, mccMnc, templateName).

bulkId

string

Bulk identifiers.

groupId

string

Group identifiers.

flowId

string

FlowId identifiers.

taskId

string

Task identifiers.

templateId

string

Template identifiers.

status

string

enum

The message status.

channel

string

enum

The channel type.

Allowed:

statusCode

integer

Status code identifiers.

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

200Success

5XXUnexpected error