Получить статус кампании

Описание

Получить текущий статус кампании

Права доступа

Для использования этого метода API-токен должен иметь права:

• Кампании - Просмотр объекта
• Доступ к группам, в которых находятся кампании

Настройте права в разделе Настройки → Токены.

URL-адрес

Метод: POST

https://example.com/api/v1.1/scampaigns/get_status

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	10	Да	Идентификатор кампании

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

JSON

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

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>10</id>
</xml>

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

JSON

{
  "data": {
    "status": "active"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <status>active</status>
  </data>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data	object	Объект с информацией о статусе

Параметры статуса

Параметр	Тип	Описание
status	string	Текущий статус кампании

Возможные статусы

Статус	Описание
cloning	В процессе клонирования
inactive	Неактивна
waiting	Ожидает активации
active	Активна
completed	Завершена
deleted	Удалена