Оценка активности телефонного номера

checkPhoneActivity

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

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

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

• 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	Нет	Уникальный идентификатор операции
active	Boolean	Нет	Признак стандартного поведения абонента в сотовой сети, наличия входящих, исходящих звонков за последние полгода

Если по номеру данные отсутствуют, то это может также означать что им никто не пользуется, либо он ни на кого не зарегистрирован, либо не имеет никаких коммуникаций с различными абонентами, то есть им фактически не пользуются, он находятся в блокировке и его скоро закроют"

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

POST /idx/api2/checkPhoneActivity
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",
        "active": true
}

Пример успешного ответа, когда данные НЕ найдены:

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