GetActivityScore

Метод GetActivityScore

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

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

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

Авторизация

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

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

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

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

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

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

Параметр Тип Описание
number uint64 номер, по которому получена оценка активности
result string оценка активности номера от 0 до 1 (где 0 — самая низкая, 1 — самая высокая оценка)
owner_id string идентификатор оператора, обслуживающего номер
region_code uint32 код региона, в котором куплена SIM-карта номера, список кодов регионов

Примеры

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

{
    "number": "79139999999"
}

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

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

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

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

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

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

Содержание статьи