Описание

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

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
valuestring"+79000000001"ДаНомер телефона
formatstring"json"НетФормат возвращаемых данных
по умолчанию – "json"
idint1ДаИдентификатор стоп-списка

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

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

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

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

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
domain_matchedbooltrue, если значение найдено в списке доменов
email_matchedbooltrue, если значение найдено в списке email-адресов
matchedbooltrue, если значение найдено в списке email-адресов, доменов или телефонных номеров
phone_matchedbooltrue, если значение найдено в списке телефонных номеров
  • No labels