Проверить номер телефона в стоп-списке

Описание

Проверить номер телефона в стоп-списке.

URL-адрес

Метод: POST

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

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

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

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

JSON

{ 
    "id":1, 
    "token":"abcdefghijklmnqrstuvwxyz", 
    "value":"+79000000001" 
}

XML

<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <value>+79000000001</value>
</xml>

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

JSON

{
    "domain_matched": false,
    "email_matched": false,
    "error": 0,
    "error_text": "Successful operation",
    "matched": true,
    "phone_matched": true
}

XML

<result>
  <domain_matched>false</domain_matched>
  <email_matched>false</email_matched>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <matched>true</matched>
  <phone_matched>true</phone_matched>
</result>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
domain_matched	bool	true, если значение найдено в списке доменов
email_matched	bool	true, если значение найдено в списке email-адресов
matched	bool	true, если значение найдено в списке email-адресов, доменов или телефонных номеров
phone_matched	bool	true, если значение найдено в списке телефонных номеров