GetHLRListActivityScore

Метод GetHLRListActivityScore

Примените этот метод получения списка истории HLR-запросов телеком-доступности мобильных номеров абонентов. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

ВАЖНО! Получить данные пока можно только по номеру оператора МТС. Проверить телеком-активность номеров других операторов можно будут позже

Точка подключения:

POST: https://api.exolve.ru/statistics/hlr/v1/GetHLRListActivityScore

Авторизация

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

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

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

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

Параметр Тип Описание
date_from string дата начала выборки запросов в формате RFC-3339 / ISO-8601
date_to string дата окончания выборки запросов в формате RFC-3339 / ISO-8601
limit uint32 лимит выводимых строк
offset uint64 номер строки, с которой начинать выборку (начинается с 0)

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

Параметр Тип Описание
elements Elements номер, по которому получено лучшее время для звонка

Elements

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

Примеры

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

{
    "date_from": "2023-10-01T08:49:28.446495Z",
    "date_to":"2024-11-29T08:49:28.446495Z",
    "limit": 10,
    "offset": 0
}

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

{
    "elements": [
        {
            "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
            "create_date": "2024-06-25T23:27:09.270442Z",
            "number": "7910769XXXX",
            "result": "0.9481",
            "owner_id": "mMTS",
            "region_code": "25"
        },
        {
            "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
            "create_date": "2024-06-26T00:05:04.051718Z",
            "number": "7913107XXXX",
            "result": "0.3047",
            "owner_id": "mMTS",
            "region_code": "45"
        },
        {
            "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
            "create_date": "2024-06-26T23:34:19.311131Z",
            "number": "7918014XXXX",
            "result": "0.6272",
            "owner_id": "mMTS",
            "region_code": "55"
        }
    ]
}

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

Код Статус Пример сообщения Описание
400 Bad Request invalid google.protobuf.Timestamp value "" неверный формат данных в запросе или отсутствуют обязательные параметры
400 Bad Request unexpected token не задано значение в одном из полей (с указанием строки)
401 Unauthorized failed to parse token невалидный API-ключ
401 Unauthorized error while trying to get token from header нет заголовка авторизации
404 Not Found сервер не может найти запрошенный ресурс

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