История страницы

limit

Нет

10

Количество элементов в ответе (максимум 1000)

page

Номер "страницы" с элементами (начиная с 0).

Например, если в limit указано 1000, а всего элементов 1500, то первая 1000 будет в ответе при page = 0, а остальные 500 при page =1 

from

Дата начала промежутка поиска. 

Задается в формате:

2023-10-31T00:00:00+00:00

ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

Обязательно url-encoded

to

Дата окончания промежутка поиска. 

Задается в формате:

2023-10-31T00:00:00+00:00

ГГГГ-ММ-ДДTчч:мм:сс+чч:мм

Обязательно url-encoded

sort

Способ сортировки. 

Задается в формате:

+(по возрастанию)/-(по убыванию)название поля сортировки (см пример в значении по умолчанию)

Возможные поля для сортировки:

createdAt, sentAt, deliveredAt, sendAt, expiredAt, billedAt

companyId

keyword

Фильтр по значению в любом из полей:

message body, messageId, bulkId, groupId, flowId, taskId, templateId, status, statusCode, channel, destination, from, text, network, mccMnc, templateName

bulkId

groupId

flowId

status

Фильтр по статусу сообщения. 

Возможные статусы:

• CREATED CREATED - Сообщение успешно обработано, но ещё не отправлено.
• SENT - Сообщение успешно отправлено оператору.
• PENDING - Сообщение успешно отправлено получателю, но отчёт о доставке ещё не получен.
• DELAYED - Сообщение успешно обработано, но его отправка отложена.
• QUEUED - Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта.
• SKIPPED - Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow).
• DELIVERED - Сообщение успешно доставлено получателю.
• UNDELIVERED - Сообщение успешно отправлено, но не было доставлено получателю.
• CANCELED - Отправка сообщения отменена по запросу клиента.
• ERROR - При отправке сообщения возникла непредвиденная ошибка.
• PAUSED - Отправка сообщения приостановлена.
• READ - Сообщение прочитано.

channel

Фильтр по каналу отправки. 

Например, CHAT