Получение сообщений
get
https://direct.i-dgtl.ru/api
/v1/message
Получение массива сообщений
Данный метод позволяет получить не более 10 000 сообщений из одной выборки. Т.е. независимо от значения total в ответе, постраничный переход возможен до тех пор, пока не превышено количество 10 000 сообщений.
При необходимости выгрузки большего количества сообщений вы можете воспользоваться:
Для возможности получения входящих сообщений необходимо обратиться к менеджеру.
Возможные варианты перечислений:
Параметр
Варианты
sort
  • sentTime:asc
  • sentTime:desc
traffic_type

Описание объекта ответа

Параметр
Тип
Описание
page
integer
Номер запрошенной страницы
perPage
integer
Количество записей на странице
total
integer
Общее количество найденных записей, подходящих под условия фильтрации
items
array
Массив объектов сообщений (описано ниже)

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

Позволяет получить сообщения рассылок 1 и 2 в статусах delivered и undelivered, которым был установлен данный статус в интервале с 2020-11-01 21:00:00 UTC до 2020-11-02 21:00:00 UTC
JSON
cURL
1
GET https://direct.i-dgtl.ru/api/v1/message?time_from=2020-11-01T21:00:00Z&time_to=2020-11-02T21:00:00Z&dispatch_id=1&dispatch_id=2&status=delivered&status=undelivered
2
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Copied!
1
curl -X GET 'https://direct.i-dgtl.ru/api/v1/message?time_from=2020-11-01T21:00:00Z&time_to=2020-11-02T21:00:00Z&dispatch_id=1&dispatch_id=2&status=delivered&status=undelivered' \
2
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
Copied!
get
https://direct.i-dgtl.ru/api
/v1/message/{message_uuid}
Получение сообщения по uuid

Описание объекта сообщения

Параметр
Тип
Описание
createdTime
string
Время создания сообщения (в UTC)
channelType
string
trafficType
string
templateId
integer
Идентификатор шаблона (возможен для сервисных и транзакционных сообщений)
dispatchId
integer
Идентификатор рассылки (-1 для одиночных сообщений)
dispatchName
string
Имя рассылки (при наличии)
messageUuid
string
Идентификатор сообщения
trafficCenterId
integer
Идентификатор ЦРТ
senderName
string
Имя отправителя
destination
string
Номер абонента
direction
string
Параметр может отсутствовать для исходящих сообщений
brand
string
Оператор абонента
country
string
Страна абонента
region
string
Регион абонента
content
string
Текст сообщения
tags
array
Массив тегов (при наличии)
ttl
integer
Время жизни сообщения в секундах
hours
array (integer)
Допустимые часы отправки