Получение информации об операторе связи по номеру телефона¶

getPhoneInfo¶

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/getPhoneInfo

Поддерживаются следующие форматы передачи параметров:

JSON, Content-Type: application/json
Form submit, Content-Type: application/x-www-form-urlencoded

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
phone	String	Да	Номер телефона

Функция возвращает:

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
homeOperator	String	Нет	Название оператора связи - владельца номерной емкости
homeOperatorId	Int	Нет	Идентификатор оператора связи - владельца номерной емкости (1 - МТС, 2 - Мегафон, 3 - Билайн, 4 - Теле-2, 5 - Тинькофф, 6 - Yota, 7 - Ростелеком, 8 - Мотив, 9 - Сбербанк, 10 - ВТБ Мобайл, 0 - другой)
operator	String	Нет	Название текущего оператора связи
operatorId	Int	Нет	Идентификатор текущего оператора связи
regionName	String	Нет	Регион регистрации номера телефона
regionTimeZone	Int	Нет	Временная зона региона регистрации номера телефона
type	String	Нет	Тип связи номера телефона (Mobile - мобильная, Stationary - стационарная, Unknown - неизвестно)

Пример вызова (передача параметров в формате json):

POST /idx/api2/getPhoneInfo
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{ 
    "accessKey": "Выданный accessKey", 
    "secretKey": "Выданный secretKey", 
    "phone": "9220123456"
}

Пример ответа, когда данные найдены и номер принадлежит оператору мобильной связи:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "homeOperator": "ООО \"Т2 Мобайл\"",
    "homeOperatorId": 4,
    "operator": "ООО \"Т2 Мобайл\"",
    "operatorId": 4,
    "regionName": "Свердловская обл.",
    "regionTimeZone": 5,
    "type": "Mobile"
}

Пример ответа, когда номер телефона не принадлежит оператору мобильной связи:

{
    "resultCode": 0,
    "resultMessage": "",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "homeOperatorId": 0,
    "operatorId": 0,
    "type": "Unknown"
}