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

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

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

campaigns.get

campaigns.get (int campaign_id, string status, int list_id, string type)

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

Категория метода
Campaigns
Параметры
campaign_id int опционально - id запрашиваемой рассылки
status string опционально - {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE} - статус рассылки
list_id int опционально - фильтр рассылок по адресным базам
type string опционально - {online_builder, html} - тип кампании (онлайн-редактор, html-шаблон)
Возвращаемые значения (значения data)
array Массив подписчиков с параметрами.
idid рассылки
typeтип рассылки. возможные значения: online_builder, html.
status{DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} - статус рассылки
nameназвание рассылки
list_idадресная база, по котором производится рассылка
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текстовый тег, как рассылка будет отображаться в Google Analytics™
htmlкод html-версии письма
csscss-код html-версии письма в случае использования онлайн-редактора
plain_textтекстовая версия письма
delivery_timeвремя отправки рассылки
autoстатус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве)
emails_sentобщее число отправленных писем в рамках этой рассылки