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

Описание

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

URL-адрес

Метод: POST

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

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

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

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

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

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

{
    "data": {
        "content": [
            {
                "from_email": "",
                "from_name": "John",
                "message_id": 1,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Welcome!"
            },
            {
                "from_email": "",
                "from_name": "Jane",
                "message_id": 1,
                "replyto_email": "",
                "replyto_name": "",
                "subject": "Welcome!"
            }
        ],
        "data_id": 1,
        "data_type": "list",
        "id": 1,
        "update_time": "2010-10-20T00:00:00Z",
        "updated_user": "John",          
		"is_active": false,
        "is_completed": false,
        "name": "Splittest",
        "resource_id": 1,
        "send_email_content": true,
        "send_push_content": false,
        "send_sms_content": false,
        "status": "Inactive",
        "subid": "API",
        "type": "splittest",
        "virtual_sender_id": 1
    },
    "error": 0,
    "error_text": "Successful operation"
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
content	JSON array	Шаблоны, прикрепленные к кампании
data_id	int	Идентификатор источника подписчиков
data_type	string	Тип источника подписчиков
id	int	Идентификатор кампании
update_time	string	Дата последнего редактирования кампании
updated_user	string	Имя пользователя, отредактировавшего кампанию
is_active	bool	Статус кампании
is_completed	bool	Завершена ли кампания
name	string	Название кампании
resource_id	int	Идентификатор ресурса
send_email_content	bool	Включены ли email-сообщения
send_push_content	bool	Включены ли PUSH-сообщения
send_sms_content	bool	Включены ли SMS-сообщения
push_sending_mode	string	Режим отправки push-сообщений (только для push-каналов)
for_confirm	bool	Имеет ли кампания сообщения со ссылкой подтверждения
status	string	Состояние кампании
subid	string	SubID кампании
type	string	Тип кампании
virtual_sender_id	int	Идентификатор виртуального сендера
descr	string	Описание кампании