Общая информация

Формат передаваемых данных

application/json

Формат ответа

application/json

Авторизация

Сервер-сервер API проверяет авторизацию и IP адрес клиента. Логин и секрет передаются с помощью Basic HTTP Authorization, в заголовке Authorization Authorization: Basic base64('login:secret') Логин и секрет и список разрешенных IP адресов могут быть изменены в настройках проекта

Описание методов

GET /api/v2/posts/single/

Получение списка рассылок

POST /api/v2/posts/single

Создание рассылки

Параметры
Параметр Тип Обязательный Описание
message_type char Да Тип сообщения рассылки ("L" - письмо)
message_id int Да Id сообщения
source_type char Да Тип источника ("U" - загружаемый, "S" - сегметн, "A" - API источник
source_id int Нет Id источника, в случае загрузки файла, не передается
source_uploaded_csv datafile Нет Файл с адерсами
config JSON Нет Описание смотрите ниже
tags string Нет Теги
priority int Нет Приоритет рассылки
planned_at datetime Нет Время начала рассылки
send_during_hours int Нет Отправлять в течении нескольких часов
additional_source_file datafile Нет Файл с дополнительными параметрами
start_immediately bool Нет Запустить рассылку сразу после создания

GET /api/v2/posts/single/{id}/

Получение конкретной рассылки

PUT /api/v2/posts/single/{id}/

Перезапись рассылку

Параметры

см выше

GET /api/v2/posts/single/{id}/start/

Запустить рассылку

GET /api/v2/posts/single/{id}/pause/

Поставить рассылку на паузу

GET /api/v2/posts/single/{id}/resume/

Продолжить рассылку

GET /api/v2/posts/single/{id}/archive/

Зархивировать рассылку рассылку

config json

Параметр Тип Описание
not_check_subscription bool
not_check_sent_quarantine bool
retry_sent_quarantine_rejected bool
retry_sent_quarantine_rejected_interval int
min_send_interval int
hook_url_template url
hook_use_auth bool
hook_pre_post bool
not_check_spam_quarantine bool
send_to_corp bool
send_by_uid bool