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 номер, по которому нужно получить оценку активности

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

Параметр Тип Описание
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
}

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

Код Статус Пример сообщения Описание
400 Bad Request неверный формат данных в запросе или отсутствуют обязательные параметры
401 Unauthorized malformed token невалидный API-ключ
403 Forbidden нет доступа к данными с предоставленным API-ключом
404 Not Found сервер не может найти запрошенный ресурс

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