POST | Получение отчетов о доставке сообщений из кампании

Получение отчетов о доставке осуществляется "пачками". Получить отчеты о доставке таким образом можно только один раз на каждое сообщение. Если есть необходимость повторного получение отчета о доставке, необходимо воспользоваться методом получения идентификаторов сообщений и запросить отчет о доставке по каждому идентификатору.

Осуществляется POST запросом, все параметры передаются в формате JSON в теле запроса.

URL

https://api.quantumtec.eu/v1/sms/report/bulk

Параметры заголовка

Параметр Значение
Content-Type application/json
Accept application/json
X-ApiKey API ключ

Параметры запроса

Параметры отправляются в формате JSON

Параметр Формат Применение Описание
bulkId string Обязательно Идентификатор кампании
Limit integer Не обязательно Ограничивает количество отправляемых отчетов о доставке. В случае отсутствия данного параметра применяется значение по умолчанию равное 50. Максимальное значение 500

В ответ на запрос будет направлен набор данных в формате JSON.

Параметры ответа

Параметр Описание
bulkId ID кампании
status

Статус кампании:

  1. Новая
  2. На модерации
  3. Модерация пройдена
  4. Подготавливается
  5. Подготовлена
  6. В процессе
  7. Отправляется
  8. Приостановлена
  9. Отправлена
  10. Остановлена
  11. Отклонена
  12. Выполнена
deliveryResults Массив данных содержащий отчеты о доставке по каждому сообщению
deliveryResults(messageID) ID сообщения
deliveryResults(partId) ID частей сообщения, если сообщение многосоставное
deliveryResults(state)

Статус доставки сообщения:

  1. Доставлено
  2. Истек срок жизни сообщения
  3. Удалено
  4. Не доставлено
  5. Принято
  6. Неизвестно
  7. Отклонено
deliveryResults(delivered) Время получения отчета о доставке сообщения в UTC
deliveryResults(errorCode) Код ошибки (Поддерживается не всеми операторами сотовой связи)

Пример запроса