Получить список броадкаст кампаний
Описание
Получить список броадкастов.
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 групп для поиска. По умолчанию – []. |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"limit": 2
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<limit>2</limit>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"id": 3,
"name": "New campaign 1",
"type": "broadcast",
"is_active": false,
"for_confirm": false,
"ui_tags": [],
"groups": [
{
"id": 0,
"name": "main"
}
]
},
{
"id": 5,
"name": "New campaign 2",
"type": "broadcast",
"is_active": false,
"for_confirm": false,
"ui_tags": [],
"groups": [
{
"id": 0,
"name": "main"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"total_count": 17
}
<xml>
<data>
<for_confirm>false</for_confirm>
<groups>
<id>0</id>
<name>main</name>
</groups>
<id>3</id>
<is_active>false</is_active>
<name>New campaign 1</name>
<type>broadcast</type>
<ui_tags/>
</data>
<data>
<for_confirm>false</for_confirm>
<groups>
<id>0</id>
<name>main</name>
</groups>
<id>5</id>
<is_active>false</is_active>
<name>New campaign 2</name>
<type>broadcast</type>
<ui_tags/>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
<total_count>17</total_count>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
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 | Список групп |