get
deliveries/get
Получение списка рассылок.
Необязательные параметры:
Параметр
Описание
count (int)
количество элементов, информацию о которых нужно вернуть
максимум: 100
пример: 50
offset (int)
смещение - с какое количества элементов нужно сделать выборку
по умолчанию: 0
| максимум: 100 000
пример: 50
delivery_id (array)
идентификаторы рассылок
пример: [123]
type (array)
типы рассылки:
chain
Автосообщение
subscription
Групповая рассылка
once
Целевая рассылка
single
Разовая рассылка
пример: ['once','auto','subscription','chain','single']
status (array)
статус рассылки:
waiting
Ожидание
progress
В обработке
done
Завершено
пример: [
'waiting', 'progress', 'done', 'error']
Ответ:
Параметр
Описание
success (bool)
true
- операция прошла успешно
false
- при возникновении ошибки
count (int)
количество всех элементов в выборке
пример: 20
items (array)
Структура элемента массива рассылок (items):
Параметр
Описание
delivery_id (int)
идентификатор рассылки
пример: 453754
name (string)
название рассылки
пример: Тест
type (string)
тип рассылки:
chain
Автосообщение
subscription
Групповая рассылка
once
Целевая рассылка
single
Разовая рассылка
пример: once
status (string)
статус рассылки:
waiting
Ожидание
progress
В обработке
done
Завершено
пример: waiting
date (string)
дата и время создания рассылки
формат: d.m.Y H:i:s
пример: 27.11.2018 10:00:00
inactive (int)
состояние рассылки
0
Запущено
1
Остановлена
пример: 0
count_recipients (int)
количество получателей
пример: 256
count_send (int)
количество доставленных сообщений
пример: 250
count_error (int)
количество недоставленных сообщений
пример: 6
count_transits (int)
количество переходов по ссылкам
пример: 0
count_read (int)
количество прочитанных сообщений
пример: 0
count_unsubscribers (int)
количество отписавшихся
пример: 0
Last updated
Was this helpful?