Сравнение версий

Старая версия 4

changes.mady.by.user Владимир Диев

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Владимир Диев

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Параметр

Обязательно

Значение по умолчанию

Описание

limit

Нет

10

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

page

Нет0

Номер "страницы" с элементами (начиная с 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

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

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

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

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

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

НетОтсутствуетФильтр по bulkId

groupId

НетОтсутствуетФильтр по groupId

flowId

НетОтсутствуетФильтр по flowId

status

НетОтсутствует

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

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

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

channel

НетОтсутствует

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

Например, CHAT

...

Поле

Тип

Описание

count

IntОбщее количество найденных элементов

items

Array[Object]Массив найденных элементов

|    id

StringИдентификатор сообщения

|    bulkId

StringИдентификатор рассылки

|    groupId

StringВнутренний идентификатора

|    flowId

StringВнутренний идентификатора

|    taskId

StringИдентификатор задания на отправку (при отправке из личного кабинета)

|    status

String

Статус сообщения

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

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

|    statusRu

StringСтатус сообщения в человеко читаемом формате на русском языке

|    statusEn

StringСтатус сообщения в человеко читаемом формате на английском языке

|    statusCode

IntКод статуса

|    companyId

IntИдентификатор компании, отправившей сообщение

|    companyName

StringИмя компании, отправившей сообщение

|    channel

StringКанал отправки сообщения

|    destination

String

Идентификатор клиента в мессенджере. 

Для WhatsApp - номер телефона

|    from

String

Отправитель сообщения.  

Не актуально для канала CHAT

|    text

StringТекст сообщения

|    price

StringЦена за сообщение

|    network

StringНе актуально для канала CHAT

|    mccMnc

StringНе актуально для канала CHAT

|    templateId

StringИдентификатор шаблона для отправки

|    templateName

StringИмя шаблона для отправки

|    variables

StringСписок переменных, приложенных к отправке

|    partCount

IntНе актуально для канала CHAT

|    tracks

ArrayНе актуально для канала CHAT

|    read

StringНе актуально для канала CHAT

|    createdAt

StringДата создания сообщения

|    sentAt

StringДата отправки сообщения

|    deliveredAt

StringДата доставки сообщения

|    sendAt

StringДата попадания сообщения в очередь отправки

|    expiredAt

StringДата истечения срока доставки сообщения

|    billedAt

StringДата билинга за сообщение

|    providerMessageId

StringИдентификатор сообщения у провайдера

|    resellerPrice

StringСтоимость сообщения у ресселлера 

|    resellerCompanyId

IntИдентификатор компании ресселлера

|    resellerCompanyName

StringИмя компании ресселлера

...