Проверка срока жизни телефонного номера¶

getPhoneLifetime¶

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

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

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

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

Параметры:

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

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

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
score	Integer	Нет	Числовой результат проверки. Варианты результатов см. расшифровка скоринга

Пример вызова:

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

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "phone": "79991112233",
    "agreement": true 
}

Пример успешного ответа:

{
        "resultCode": 0,
        "resultMessage": "",
        "operationToken": "82e9d6ec643242e348bbefbe4d7b",
        "score": 5
}

Пример неуспешного ответа:

{
        "resultCode": -100,
        "resultMessage": "Номер не найден",
        "operationToken": "edeee3ec059b429089ba2d963ec4029a"
}

Расшифровка скоринга¶

Значение	Описание
0	Срок жизни номера менее 30 дней
1	Срок жизни номера от 1 месяца до 2 месяцев
2	Срок жизни номера от 2 месяцев до 6 месяцев
3	Срок жизни номера от 6 месяцев до 1 года
4	Срок жизни номера от 1 года до 3-х лет
5	Срок жизни номера более 3-х лет