Добавить один или несколько номеров в стоп-список
Описание
Добавить один или несколько телефонных номеров в стоп-список.
URL-адрес
Метод: POST
https://example.com/api/v1.1/suppresses/phones_add
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
values | JSON array | [ | Да | Список номеров |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
id | int | 1 | Да | Идентификатор стоп-списка |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 1,
"values": [
"+79000000001",
"+79999999991"
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>1</id>
<values>+79000000001</values>
<values>+79999999991</values>
</xml>
Пример ответа
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation",
"total_count": 2,
"total_duplicated": 0,
"total_imported": 2,
"total_invalid": 0
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<total_count>2</total_count>
<total_duplicated>1</total_duplicated>
<total_imported>1</total_imported>
<total_invalid>0</total_invalid>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
total_count | int | Всего номеров |
total_duplicated | int | Номера, добавленные в стоп-список ранее |
total_imported | int | Номеров добавлено |
total_invalid | int | Количество невалидных номеров |