GetHLRListReport
Метод GetHLRListReport
Примените метод GetHLRListReport для получения списка отчётов с результатами массовых проверок номеров. Последовательность действий:
- Отправьте номера на проверку с помощью метода GenerateActivityScoreReport или GenerateBestCallTimeReport. В ответе на запрос вы получите идентификатор отчёта с результатами проверки
- Используйте этот идентификатор, чтобы с помощью метода GetHLRReport получить этот отчёт. В нём по каждому проверенному номеру будет доступен коэффициент активности на сети (от 0 до 1) или промежуток времени, в течение которого абонент вероятнее всего ответит на звонок
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/hlr/v1/GetHLRListReport
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
date_from | timestamp | дата начала выборки отчётов в формате RFC-3339 / ISO-8601 |
date_to | string | дата окончания выборки отчётов в формате RFC-3339 / ISO-8601 |
limit | uint64 | лимит выводимых строк |
offset | uint64 | номер строки, с которой начинать выборку (начинается с 0) |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
reports | array Reports | идентификатор отчёта |
Reports
Параметр | Тип | Описание |
---|---|---|
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 | срок хранения отчёта истёк |
Примеры
Входные параметры:
{
"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
}
]
}
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
400 | Bad Request | invalid GetHLRListReportRequest.DateFrom: value is required | не передано значение обязательного параметра date_from |
400 | Bad Request | invalid GetHLRListReportRequest.DateTo: value is required | не передано значение обязательного параметра date_to |
400 | Bad Request | invalid google.protobuf.Timestamp value | |
400 | Bad Request | invalid value for uint32 field limit: * | некорректное значение параметра limit |
400 | Bad Request | invalid value for uint64 field offset: * | некорректное значение параметра offset |
400 | Bad Request | date_from later than date_to | дата начала выборки не может быть позже, чем дата её окончания |
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 запроса |