GetHLRListAggregation

Метод GetHLRListAggregation

Примените метод GetHLRListAggregation для получения агрегированной истории запросов оценки телеком-доступности и подходящих периодов времени для контакта с абонентами. В ответе вы получите не результаты проверки по каждому номеру, а сгруппированное по типу (activity_score, best_call_time и base_number_info) общее число запросов за день с разбивкой по успешности.

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

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

Авторизация

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

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

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

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

ПараметрТипОписание
date_fromstringдата начала выборки запросов в формате RFC-3339 / ISO-8601
date_tostringдата окончания выборки запросов в формате RFC-3339 / ISO-8601
limituint32лимит выводимых строк
offsetuint64номер строки, с которой начинать выборку (начинается с 0)

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

ПараметрТипОписание
elementsElementsагрегаты

Elements

ПараметрТипОписание
datestringдата запросов RFC-3339 / ISO-8601
activity_score_successfuluint64успешные запросы оценки активности номеров
activity_score_not_successfulluint64неуспешные запросы оценки активности номеров
best_call_time_successfuluint64успешные запросы периодов времени, подходящих для звонка абонентам
best_call_time_not_successfuluint64неуспешные запросы периодов времени, подходящих для звонка абонентам
base_number_info_successfuluint64успешные запросы базовый информации по номерам
base_number_info_not_successfuluint64неуспешные запросы базовый информации по номерам

Запрос считается успешным, даже если в базе нет данных о запрашиваемом номере. Неуспешный запрос — запрос, в ответе на который вернулась ошибка


Примеры

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

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

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

{
  "elements": [
    {
      "date": "2025-05-29T00:00:00Z",
      "activity_score_successful": "54",
      "activity_score_not_successfull": "0",
      "best_call_time_successful": "87",
      "best_call_time_not_successful": "3",
      "base_number_info_successful": "7",
      "base_number_info_not_successful": "0"
    },
    {
      "date": "2025-04-26T00:00:00Z",
      "activity_score_successful": "13",
      "activity_score_not_successfull": "0",
      "best_call_time_successful": "2",
      "best_call_time_not_successful": "0",
      "base_number_info_successful": "17",
      "base_number_info_not_successful": "0"
    },
    {
      "date": "2025-03-25T00:00:00Z",
      "activity_score_successful": "11",
      "activity_score_not_successfull": "0",
      "best_call_time_successful": "28",
      "best_call_time_not_successful": "1",
      "base_number_info_successful": "32",
      "base_number_info_not_successful": "0"
    }
  ]
}

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

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