Документация для разработчиков

Документация API версии 1.1

« Назад на Обзор Документации

campaigns.get

campaigns.get (int campaign_id, string external_campaign_id, string status, int list_id, date start, date end , string type, int offset, int limit, int merge_json)

Получаем список рассылок пользователя

Категория метода
Campaigns
Параметры
campaign_id int опционально - id запрашиваемой рассылки
external_campaign_id string опционально - внешний id запрашиваемой рассылки
status string опционально - {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE, BLOCKED-SPAM, NEED-FIX} - статус рассылки
list_id int опционально - фильтр рассылок по адресным базам
start date опционально - фильтр рассылок по времени, начальная дата, формат: YYYY-MM-DD
end date опционально - фильтр рассылок по времени, конечная дата, формат: YYYY-MM-DD
type string опционально - {online_builder, html} - тип кампании (онлайн-редактор, html-шаблон)
offset int опционально - номер записи с которой начинать вывод. по умолчанию: 0
limit int опционально - количество записей для вывода. по умолчанию: без ограничений
merge_json int опционально - вывод параметров дополнительных полей (merge_{1..10}) в формате JSON вместо сериализованного массива
Возвращаемые значения (значения data)
array Массив рассылок с параметрами.
idid рассылки
external_idвнешний id рассылки
channelканал рассылки. возможные значения: email, sms, viber, whatsapp, telegram, notify, push, webpush
typeтип рассылки. возможные значения: online_builder, html.
status{DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} - статус рассылки
nameназвание рассылки
list_idid адресной базы, по которой была отправлена рассылка.
subjectзаголовок письма
from_nameот кого письмо?
from_emailобратный адрес
personalizeToEmail{on/off} - включить/выключить персонализацию в поле "Кому:"
to_emailперсонализация в поле "Кому:" [можно использовать %ТЭГИ% из дополнительных полей базы, например %EMAIL%]
track_opens{Y,N} - следить за открыванием
track_clicks{Y,N} - отслеживать клики
plain_clicks{Y,N} - отслеживать клики в текстовой версии
analytics{google,N} - добавить Google Analytics™ для отслеживания всех URLs
analytics_tagтекстовый тег utm_campaign для отображения кликов в Google Analytics™
analytics_sourceutm_source для отображения кликов в Google Analytics™
analytics_mediumutm_medium для отображения кликов в Google Analytics™
analytics_contentutm_content для отображения кликов в Google Analytics™
analytics_termutm_term для отображения кликов в Google Analytics™
htmlкод html-версии письма
csscss-код html-версии письма в случае использования онлайн-редактора
plain_textтекстовая версия письма
delivery_timeвремя отправки рассылки
autoстатус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве)
limitлимит отправки писем на рассылку или, в случае задания wait_time для плавной отправки, на временной период.
wait_timeвременной период в секундах для ожидания перед отправкой следующей части отправкой частями.
allow_time_zone{Y,N} - учитывать локальное время подписчика при запланированной на определенное время отправке
allow_best_time{Y,N} - оптимизировать время получения письма, функция "лучшее время доставки"