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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
from_id	int	11768	Нет	Идентификатор первой рассылки в списке. По умолчанию – 1.
limit	int	10	Нет	Лимит на количество возвращаемых данных. По умолчанию – 1000.
format	string	"json"	Нет	Формат возвращаемых данных. По умолчанию – "json".
is_active	bool	true	Нет	Статус рассылки
ui_tags	[]String	[ "tag1", "tag2" ]	Нет	Список тегов для поиска. По умолчанию – [].
groups	[]String	[ "group1", "group2" ]	Нет	Список групп для поиска. По умолчанию – [].
groups_id	[]int	[ 0, 1 ]	Нет	Список Id групп для поиска. По умолчанию – [].
attributes	JSON object	"attributes": {    "season": {       "options": ["spring_2024", "summer_2024"]      }   }	Нет	Значения атрибутов для поиска

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

JSON

{
    "limit": 2 
}

XML

<xml>
    <limit>2</limit>
</xml>

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

JSON

{
    "data": [
        {
            "id": 3,
            "name": "New campaign 1",
            "type": "broadcast",
            "is_active": false,
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ],
            "attributes": {
                "season": "spring_2024",
                "branch": "marketing"
            }
        },
        {
            "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

<xml>
    <data>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
        <attributes>
            <season>spring_2024</season>
            <branch>marketing</branch>
        </attributes>
        <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	Список групп
attributes	object	Атрибуты, назначенные рассылке, и их значения
scampaign_id	int	Идентификатор кампании, в которой задействована рассылка (Параметр возвращается, если рассылка задействована в кампании)