GetHLRListReport

Метод GetHLRListReport

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Reports

ПараметрТипОписание
file_uuidstringидентификатор отчёта
created_attimestampсрок хранения отчёта (хранится в течение 30 дней с даты создания)
typeenum1 — activity_score, 2 — best_call_time
statusstring Statusтекущий статус отчёта
number_totalint32количество номеров в отчёте
base64stringметаданные с результатами проверки

Status

ПараметрТипЯзык
1ожидает проверки
2в процессе проверки
3отчёт готов
4неуспешно — отчёт готов, но есть ошибки (недостаточно средств, по номерам нет данных и пр.)
5срок хранения отчёта истёк

Примеры

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

{
    "date_from": "2025-05-01T15:07:16.343019Z",
    "date_to": "2025-05-01T15:07:16.343019Z",
    "limit": 20,
    "offset": 0
}

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

{
"reports": [
    {
    "file_uuid": "adff48cc-219c-461b-9481-962b14eb5d24",
    "created_at": "2025-05-13T19:13:38Z",
    "type": 1,
    "status": 2,
    "number_total": 9500
    },
    {
    "file_uuid": "adff47cc-219c-461b-9481-962b14eb5d28",
    "created_at": "2025-05-12T20:57:38Z",
    "type": 2,
    "status": 3,
    "number_total": 25300
    }
]
}

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

КодСтатусПример сообщенияОписание
400Bad Requestinvalid GetHLRListReportRequest.DateFrom: value is requiredне передано значение обязательного параметра date_from
400Bad Requestinvalid GetHLRListReportRequest.DateTo: value is requiredне передано значение обязательного параметра date_to
400Bad Requestinvalid google.protobuf.Timestamp value
400Bad Requestinvalid value for uint32 field limit: *некорректное значение параметра limit
400Bad Requestinvalid value for uint64 field offset: *некорректное значение параметра offset
400Bad Requestdate_from later than date_toдата начала выборки не может быть позже, чем дата её окончания
400Bad Requestinvalid value
400Bad Requestunexpected token
400Bad Requestunknown field
401Unauthorizedincorrect authorization tokenневалидный API-ключ
403Forbiddenнет доступа к данными с предоставленным API-ключом
404Not Foundнекорректно введен URL запроса