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

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
id	int	1	Да	Идентификатор стоп-списка

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

JSON

{
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
    "data": {
        "id": 1,
        "is_global": true,
        "name": "Global suppress list"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<result>
  <data>
    <id>1</id>
    <is_global>true</is_global>
    <name>Global suppress list</name>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</result>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
id	int	Идентификатор стоп-списка
name	string	Название стоп-списка
is_global	bool	true, если это глобальный список
descr	string	Описание стоп-списка