Метод GetBestSmsTime
Примените метод GetBestSmsTime для получения периода времени, в течение которого абонент с наибольшей вероятностью прочтёт сообщение
ВАЖНО! Получить данные пока можно только по номерам оператора МТС. Получить оптимальное время на отправки сообщений на номера других операторов можно будет позже
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/hlr/v1/GetBestSmsTime
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| number | string | мобильный номер в формате 7ХХХХХХХХХХ, по которому нужно узнать лучшее время для отправки сообщения |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| number | uint64 | номер, по которому получено лучшее время для отправки сообщения |
| result | string | интервал времени в UTC+0, в течение которого абонент вероятнее всего прочитает сообщение |
Примеры
Входные параметры:
{
"number": "79139999999"
}
Выходные параметры:
{
"number": 79139999999,
"result": "17:00:00,21:00:00"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | incorrect number format | неверный формат данных в запросе или отсутствуют обязательные параметры |
| 400 | Bad Request | enter another number | введите номер оператора МТС |
| 400 | Bad Request | hlr is disabled on the application | услуга умной проверки номеров отключена, подключите её в настройках приложения |
| 400 | Bad Request | customer has not signed, the number must match your confirmed phone number | на тестовом периоде можно проверить только свой подтверждённый номер, в запросе указан иной |
| 400 | Bad Request | incorrect request | неверный запрос |
| 400 | Bad Request | customer is not active | аккаунт заблокирован |
| 401 | Unauthorized | incorrect authorization token | невалидный API-ключ |
| 403 | Forbidden | нет доступа к данными с предоставленным API-ключом | |
| 404 | Not Found | некорректно введен URL запроса |