GetActivityScore

Метод GetActivityScore

Примените метод GetActivityScore для получения оценки телеком-доступности номеров любых операторов РФ. В ответе на запрос вы получите коэффициент активности на сети (от 0 до 1) — благодаря ему вы сможете актуализировать вашу клиентскую базу перед отправкой рассылки или запуска обзвона, убрав из неё неактивные номера.

Точка подключения: Услуга доступна в двух версиях — они отличаются по набору признаков, на основе которых формируется оценка активности. Выполните POST-запрос с входными параметрами к одной из точек подключения:

POST: https://api.exolve.ru/hlr/v1/GetActivityScore
POST: https://api.exolve.ru/hlr/v2/GetActivityScore

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ПараметрТипОписание
numberstringмобильный номер в формате 7ХХХХХХХХХХ, по которому нужно получить оценку активности

Выходные параметры

ПараметрТипОписание
numberuint64номер, по которому получена оценка активности
resultstringоценка активности номера от 0 до 1 (где 0 — самая низкая, 1 — самая высокая оценка)
owner_idstringидентификатор оператора, обслуживающего номер
region_codeuint32код региона, в котором куплена SIM-карта номера, список кодов регионов

Примеры

Входные параметры:

{
    "number": "79139999999"
}

Выходные параметры, если по номеру есть информация в базе:

{
    "number": 79139999999,
    "result": "0.96",
    "owner_id": "mMTS",
    "region_code": 77
}

Выходные параметры, если по номеру нет информации в базе (вероятно, с этого номера не было звонков в течение 2 последних лет) — такой запрос также считается успешным и тарифицируется:

{
    "error": {
        "message": "no information on this number"
    }
}

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requestincorrect number formatневерный формат данных в запросе или отсутствуют обязательные параметры
400Bad Requesthlr is disabled on the applicationуслуга HLR-запросов отключена, подключите её в настройках приложения
400Bad Requestcustomer has not signed, the number must match your confirmed phone numberна тестовом периоде можно проверить только свой подтверждённый номер, в запросе указан иной
401Unauthorizedincorrect authorization tokenневалидный API-ключ
403Forbiddenнет доступа к данными с предоставленным API-ключом
404Not Foundнекорректно введен URL запроса