Получить информацию о броадкаст кампании

Описание

Получить информацию о броадкасте.

URL-адрес

Метод: POST

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

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

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

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

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

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

{
    "data": {
        "aglimit_count": 0,
        "aglimit_percent": 0,
        "content": [
            {
                "from_email": "",
                "from_name": "",
                "message_id": 4,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Hello"
            }
        ],
        "content_type": "",
        "custom_tracking_domains": [],
        "data_id": 2416,
        "data_type": "segment",
        "id": 4428,
        "is_active": false,
        "is_random_tracking_prefix": false,
        "limit": 0,
        "name": "Broadcast campaign name",
        "resource_id": 1,
        "send_channel": "email",
        "channel": "email",
        "start_schedule": {
            "start_hours": [
                0
            ],
            "start_mdays": [
                1
            ],
            "start_mins": [
                0
            ],
            "start_months": [
                12
            ],
            "start_wdays": [],
            "start_years": [
                2016
            ]
        },
        "subid": "api_campaign",
        "virtual_sender_id": 98,
        "watcher_limit": 0,
        "watcher_list_id": 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 настройки (только для smart-аккаунтов)
virtual_sender_id	int	Идентификатор виртуального сендера
is_random_tracking_prefix	bool	Случайный префикс трекинг-домена
custom_tracking_domains	json array	Список произвольных трекинг-доменов
blind_carbon_copy	json array	Адреса для скрытой копии
unconditional_sending	bool	Отправка вне зависимости от статуса подписки
watcher_list_id	int	Идентификатор базы наблюдателей
watcher_limit	int	Лимит наблюдателей