Получить информацию о нескольких стоп-списков

Описание

Получить информацию о нескольких стоп-списков.

URL-адрес

Метод: POST

https://example.com/api/v1.1/suppresses/list

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

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

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

JSON

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

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <from_id>1</from_id>
    <limit>2</limit>
</xml>

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

JSON

{
    "data": [
        {
            "id": 1,
            "name": "Global suppress list",
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        },
        {
            "id": 3,
            "name": "New suppression list",
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 5
}

XML

<xml>
    <data>
        <groups>
            <id>0</id>
            <name>"main"</name>
        </groups>
        <id>1</id>
        <name>"Global suppress list"</name>
        <ui_tags/>
    </data>
    <data>
        <groups>
            <id>0</id>
            <name>"main"</name>
        </groups>
        <id>3</id>
        <name>"New suppression list"</name>
        <ui_tags/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>5</total_count>
</xml>

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

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