GetHLRListBestSmsTime

Метод GetHLRListBestSmsTime

Примените метод GetHLRListBestSmsTime для получения истории запросов по интервалам оптимального времени для отправки текстового сообщения абоненту.

ВАЖНО! Получить историю запросов пока можно только по номеру оператора МТС. Остальные операторы будут доступны позднее

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

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

Авторизация

Передайте следующие Заголовки 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

Параметр Тип Описание
application_uuid string идентификатор приложения, из которого отправлены запросы
create_date string дата отправки запроса
number uint64 номер, по которому получено лучшее время для отправки сообщеия
result string интервал времени в UTC+0, в течение которого абонент вероятнее всего получит/прочтёт сообщение

Примеры

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

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

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

{
   "elements": [
       {
           "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
           "create_date": "2024-11-27T13:52:02.393979Z",
           "number": "7913765XXXX",
           "result": "17:00:00,21:00:00"
       },
       {
           "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
           "create_date": "2024-10-11T14:06:11.074975Z",
           "number": "7950880XXXX",
           "result": "15:00:00,16:00:00"
       },
       {
           "application_uuid": "8403eaef-01ed-4161-93fd-cd0c2e8ce3cf",
           "create_date": "2024-10-28T08:48:58.537060Z",
           "number": "7995880XXXX",
           "result": "3:00:00,5:00:00"
       }
   ]
}

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

Код Статус Пример сообщения Описание
400 Bad Request invalid google.protobuf.Timestamp value "" неверный формат данных в запросе или отсутствуют обязательные параметры
400 Bad Request unexpected token не задано значение в одном из полей (с указанием строки)
400 Bad Request “invalid value for uint32 field limit: *” неверный формат данных поля limit
400 Bad Request “invalid value for uint64 field offset: *” неверный формат данных поля offset
400 Bad Request “hlr is disabled on the application” услуга умной проверки номеров не подключена в настройках этого приложения
400 Bad Request “incorrect request” неверный запрос
401 Unauthorized error while trying to get token from header нет заголовка авторизации
401 Unauthorized failed to parse token невалидный API-ключ
404 Not Found некорректно введен URL запроса

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