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

Описание

Получить список броадкастов.

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
from_id	int	2	Нет	Идентификатор первой кампании в списке. По умолчанию – 1.
limit	int	10	Нет	Лимит на количество возвращаемых данных. По умолчанию – 1000.
format	string	"json"	Нет	Формат возвращаемых данных. По умолчанию – "json".
type	string	"broadcast"	Да	Тип кампании
is_active	bool	true	Нет	Статус кампании
ui_tags	[]String	[ "tag1", "tag2" ]	Нет	Список тегов для поиска. По умолчанию – [].
groups	[]String	[ "group1", "group2" ]	Нет	Список групп для поиска. По умолчанию – [].
groups_id	[]int	[ 0, 1 ]	Нет	Список Id групп для поиска. По умолчанию – [].

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

{
    "limit": 2,
    "token": "abcdefghijklmnqrstuvwxyz"
}

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

    
{
   "data": [
      {
         "id": 1,
         "name": "New campaign1",
         "type": "broadcast",
         "is_active": false,
         "for_confirm": false,
         "ui_tags": [
            "tag1",
            "tag2"
         ],
         "Groups": [
            {
               "Id": 1,
               "Name": "subaccount"
            }
         ]
      },
      {
         "id": 2,
         "name": "New campaign2",
         "type": "broadcast",
         "is_active": false,
         "for_confirm": false,
         "ui_tags": [
            "tag3"
         ],
         "Groups": [
            {
               "Id": 0,
               "Name": "main"
            }
         ]
      }
   ],
   "error": 0,
   "error_text": "Successful operation",
   "total_count": 6
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор кампании
name	string	Название кампании
type	string	Тип кампании
is_active	bool	Статус кампании
for_confirm	bool	Имеет ли кампания сообщения со ссылкой подтверждения
total_count	int	Общее количество кампаний
ui_tags	[]String	Список тегов
groups	[]String	Список групп