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

Описание

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

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

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

XML

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

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

JSON

    
{
  "data": [
    {
      "id": 1,
      "name": "Global suppress list",
      "ui_tags": ["tag1", "tag2"]
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "total_count": 1
}

XML

<result>
  <data>
    <id>1</id>
    <name>Global suppress list</name>
    <ui_tags>tag1</ui_tags>
    <ui_tags>tag2</ui_tags>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <total_count>1</total_count>
</result>

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

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