Получить информацию о регулярной кампании

Описание

Получить информацию о регулярной кампании.

URL-адрес

Метод: POST

https://example.com/api/v1.1/campaigns/regulars/get

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	11768	Да	Идентификатор кампании
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"

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

{
    "id": 11768,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Пример ответа

{
  "data": {
    "id": 4428,
    "name": "Regular campaign name",
    "is_active": false,
    "data_id": 2416,
    "data_type": "segment",
    "content": [
      {
        "subject": "Hello",
        "from_email": "",
        "from_name": "",
        "replyto_email": "",
        "replyto_name": "",
        "message_id": 4
      }
    ],
    "content_type": "",
    "send_channel": "email",
    "channel": "email",
    "resource_id": 1,
    "subid": "api_campaign",
    "limit": 0,
    "aglimit_count": 0,
    "aglimit_percent": 0,
    "start_schedule": {
      "start_mins": [ 0 ],
      "start_hours": [ 0 ],
      "start_mdays": [ 1 ],
      "start_wdays": [],
      "start_months": [ 12 ],
      "start_years": [ 2016 ]
    },
    "virtual_sender_id": 98,
    "is_random_tracking_prefix": false,
    "custom_tracking_domains": [],
    "watcher_list_id": 0,
    "watcher_limit": 0
  },
  "error": 0,
  "error_text": "Successful operation"
}

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор
name	string	Название кампании
is_active	bool	Статус кампании
resource_id	int	Идентификатор ресурса
data_id	int	Идентификатор баз данных или сегмента
data_type	string	Тип источника подписчиков
content	JSON array	Контент, присоединенный к кампании
send_channel	string	Канал отправки
channel	string	Канал
for_confirm	bool	Имеет ли кампания сообщения со ссылкой подтверждения
subid	string	subid кампании
start_shedule	JSON-object	Start schedule object
limit	int	Лимит на каждый запуск
aglimit_count	int	Приращивать лимит по количеству
agllimit_percent	float	Приращивать лимит по проценту
policy_id	int	Идентификатор политики отправки
push_sending_mode	string	Режим отправки push-сообщений (только для push-каналов)
descr	string	Описание кампании
Smart настройки
virtual_sender_id	int	Идентификатор виртуального сендера Только для smart-аккаунтов
is_random_tracking_prefix	bool	Случайный префикс трекинг-домена Только для smart-аккаунтов
custom_tracking_domains	JSON array	Список произвольных трекинг-доменов Только для smart-аккаунтов
blind_carbon_copy	JSON array	Адреса для скрытой копии Только для smart-аккаунтов
unconditional_sending	bool	Отправка вне зависимости от статуса подписки Только для smart-аккаунтов
watcher_list_id	int	Идентификатор базы наблюдателей Только для smart-аккаунтов
watcher_limit	int	Лимит наблюдателей Только для smart-аккаунтов