Валидация абонентского номера (validatePhoneNumber)

Метод, описанный в этой статье, предназначен только для SME.

В результате выполнения запроса будет выполнена проверка и валидация абонентского номера. Номер телефона получателя phoneNumber следует указывать без ведущего знака «+» перед номером. Например, вот так: 79000000000. Это касается как российских, так и международных номеров.

URL-адрес подключения

Для проверки валидности номера выполняется GET-запрос на URL-адрес: https://sms.edna.ru/connector_sme/api/validatePhoneNumber/{phoneNumber}

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

Запрос имеет один обязательный параметр phoneNumber, который передается как часть URL.

Формат ответа

В ответ на запрос возвращается JSON-объект с проверенным номером. Статусы обработки номера приведены здесь. В случае неправильно заданного номера, значение ключа status будет ERROR в возвращеном JSON-объекте. Номер, приведенный к правильному формату находся в параметре normalize.

{
    "status": "OK",
    "operator": "МТС",
    "region": "Кемеровская область",
    "country": "Russia",
    "normalize": "79000000000"
}

Иностранный абонентский номер

Если иностранный номер будет распознан, то вернется успешный статус с заполненной записью country соответсвующей страны. Если же номер будет невалиден или не определена страна, то значение ключа status будет ERROR. Статусы обработки номера приведены здесь.

{
    "status": "OK",
    "operator": "Beeline",
    "region": "Beeline",
    "country": "kazakhstan",
    "normalize": "77000000000"
}

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

ПараметрТип данныхОписание
statusstring (required)Статус обработки номера телефона. Возможные значения
operatorstring (required)Оператор телефонного номера
regionstring (required)Регион телефонного номера
countrystring (required)Страна сотового оператора
normalizestring (required)Правильный обработанный номер
Callback функция для передачи информации об изменении статуса доставки SMS (smsOutMessageDlvStatusCallback)
Cледующая статья Возможные статусы