Добавить номер телефона в стоп-список
Описание
Добавить номер телефона в стоп-список.
URL-адрес
Метод: POST
https://example.com/api/v1.1/suppresses/phone_add
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
value | string | "+79000000001" | Да | Номер телефона |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
id | int | 1 | Да | Идентификатор стоп-списка |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 1,
"value":"+79000000001"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>1</id>
<value>+79000000001</value>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"+79000000991": true
},
"error": 0,
"error_text": "Successful operation"
}
<xml>
<data><+79000000001>false</+79000000001>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
data | obj | Номер телефона, добавленный в стоп-список |