GetHLRReport

Метод GetHLRListReport

Примените метод GetHLRReport для получения отчёта с результатами массовой проверки номеров. Последовательность действий:

  1. Отправьте номера на проверку с помощью метода GenerateActivityScoreReport или GenerateBestCallTimeReport. В ответе на запрос вы получите идентификатор отчёта с результатами проверки
  2. Используйте этот идентификатор, чтобы с помощью метода GetHLRReport получить этот отчёт. В нём по каждому проверенному номеру будет доступен коэффициент активности на сети (от 0 до 1) или промежуток времени, в течение которого абонент вероятнее всего ответит на звонок

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
file_uuid string идентификатор отчёта

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

Параметр Тип Описание
file_uuid string идентификатор отчёта
created_at timestamp срок хранения отчёта (хранится в течение 30 дней с даты создания)
type enum 1 — activity_score, 2 — best_call_time
status string Status текущий статус отчёта
number_total int32 количество номеров в отчёте
base64 string метаданные с результатами проверки
Status
Параметр Тип Язык
1 ожидает проверки
2 в процессе проверки
3 отчёт готов
4 неуспешно — отчёт готов, но есть ошибки (недостаточно средств, по номерам нет данных и пр.)
5 срок хранения отчёта истёк

Примеры

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

{
    "file_uuid": "89363af6-45c8-4961-9f4a-06fa363b5fdc=="
}

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

{
    "file_uuid": "adff49cc-219c-461b-9481-962b14eb5d24",
    "created_at": "2025-05-12T20:57:38Z",
    "type": 1,
    "status": 3,
    "number_total": 9500,
    "base64": "89363af6-45c8-4961-9f4a-06fa363b5fdc=="
}

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

Код Статус Пример сообщения Описание
400 Bad Request Fail to get hlr report
400 Bad Request invalid value for string field fileUuid: *
400 Bad Request Invalid value
400 Bad Request Unexpected token
400 Bad Request Unknown field
401 Unauthorized incorrect authorization token невалидный API-ключ
403 Forbidden нет доступа к данными с предоставленным API-ключом
404 Not Found некорректно введен URL запроса

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