GetHLRListAggregation
Метод GetHLRListAggregation
Примените метод GetHLRListAggregation для получения агрегированной истории HLR-запросов оценки телеком-доступности и походящих периодов времени для контакта с абонентами. В ответе вы получите не результаты проверки по каждому номеру, а сгруппированное по типу (activity_score и best_call_time) общее число запросов за день с разбивкой по успешности. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
ВАЖНО! Получить историю запросов пока можно только по номеру оператора МТС. Остальные операторы будут доступы позднее
Точка подключения:
POST: https://api.exolve.ru/statistics/hlr/v1/GetHLRListAggregation
Авторизация
Передайте следующие Заголовки 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
Параметр | Тип | Описание |
---|---|---|
date | string | дата запросов RFC-3339 / ISO-8601 |
activity_score_successful | uint64 | успешные запросы оценки активности номеров |
activity_score_not_successfull | uint64 | неуспешные запросы оценки активности номеров |
best_call_time_successful | uint64 | успешные запросы периодов времени, подходящих для звонка абонентам |
best_call_time_not_successful | uint64 | неуспешные запросы периодов времени, подходящих для звонка абонентам |
Запрос считается успешным, даже если в HLR-базе нет данных о запрашиваемом номере. Неуспешный запрос — запрос, в ответе на который вернулась ошибка
Примеры
Входные параметры:
{
"date_from": "2023-10-01T08:49:28.446495Z",
"date_to":"2024-11-29T08:49:28.446495Z",
"limit": 10,
"offset": 0
}
Выходные параметры:
{
"elements": [
{
"date": "2024-11-29T00:00:00Z",
"activity_score_successful": "54",
"activity_score_not_successfull": "0",
"best_call_time_successful": "87",
"best_call_time_not_successful": "3"
},
{
"date": "2024-11-26T00:00:00Z",
"activity_score_successful": "13",
"activity_score_not_successfull": "0",
"best_call_time_successful": "2",
"best_call_time_not_successful": "0"
},
{
"date": "2024-11-25T00:00:00Z",
"activity_score_successful": "11",
"activity_score_not_successfull": "0",
"best_call_time_successful": "28",
"best_call_time_not_successful": "1"
}
]
}
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
400 | Bad Request | invalid google.protobuf.Timestamp value "" | неверный формат данных в запросе или отсутствуют обязательные параметры |
400 | Bad Request | unexpected token | не задано значение в одном из полей (с указанием строки) |
401 | Unauthorized | error while trying to get token from header | нет заголовка авторизации |
401 | Unauthorized | failed to parse token | невалидный API-ключ |
404 | Not Found | некорректно введен URL запроса |