Документация по API уведомлений
Эти конечные точки позволяют вам отправлять внутренние мобильные уведомления и получить историю уведомлений Из SMSMobileAPI. Уведомления могут отправляться на конкретное мобильное устройство, а затем отслеживаться через конечную точку списка.
The уведомление/список Конечная точка возвращает время отправки и время распространения уведомления. время по Гринвичувключая полные строки даты и времени и Временные метки Unix.
Быстрый старт
Базовый URL
Примеры
Аутентификация
Точки уведомлений проходят аутентификацию с использованием апики параметр.
Общие понятия
Целевой мобильный
Уведомления отправляются на конкретное мобильное устройство с помощью сторонаКонечная точка списка может фильтровать один и тот же целевой объект, используя идентификант или сторона.
Распределенный статус
- распределено=1 Это означает, что уведомление было разослано.
- распределено=0 означает, что данные не распределены.
- распределенный_статус возвраты распределенный или не_распределено.
Даты и часовые пояса
- отправил_* Поля отображают дату и время отправки уведомления. время по Гринвичу.
- распределенный_* Поля представляют дату/время распространения в время по Гринвичу.
- *_at_unix Поля представляют собой метки времени Unix.
Поведение конечной точки списка
- Конечная точка списка всегда возвращает максимум из 200 рядов.
- Результаты сортируются от самых новых к самым старым с использованием даты и времени отправки.
- Фильтры по дате dateAjout внутренне и подвергаются воздействию как дата_из / дата_до.
Ошибки
| HTTP | Пример ошибки | Значение |
|---|---|---|
| 400 | {"success":false,"message":"Отсутствует обязательный параметр: apikey."} | Отсутствует или пусто апики. |
| 400 | {"success":false,"message":"Отсутствуют обязательные параметры: apikey и sid являются обязательными."} | Отсутствующий сторона на уведомление/отправить. |
| 400 | {"success":false,"message":"Отсутствует обязательный параметр: message."} | Отсутствующий сообщение на уведомление/отправить. |
| 400 | {"success":false,"message":"Неверный формат даты начала. Ожидался формат ГГГГ-ММ-ДД."} | Неверный дата_из формат на уведомление/список. |
| 400 | {"success":false,"message":"Недопустимое распределенное значение. Допустимые значения: 0 или 1."} | Неверный распределенный значение фильтра. |
| 500 | {"success":false,"message":"Сбой подключения к базе данных."} | Проблема с подключением к базе данных. |
| 500 | {"success":false,"message":"Запрос не выполнен: ..."} | Ошибка выполнения SQL-запроса. |
Уведомление – Отправить
Создать новое уведомление для целевого мобильного устройства.
Конечная точка
Параметры запроса/тела
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш ключ API. |
| сторона | нить | Необходимый Целевая мобильная идентификация. |
| заголовок | нить | Необязательный Заголовок уведомления. По умолчанию: Уведомление. |
| сообщение | нить | Необходимый Содержимое уведомления. |
| тип | нить | Необязательный Тип уведомления. По умолчанию: уведомление. |
Пример успешного ответа
{ "success": true, "message": "Уведомление создано."", "id": 22087, "apikey": "ВАШ_API_КЛЮЧ", "sid": "508b004b4aadacc4" }
Уведомление – Список
Получайте последние уведомления для ключа API с возможностью фильтрации.
Конечная точка
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш ключ API. |
| идентификант | нить | Необязательный Фильтрация уведомлений по целевому мобильному телефону. |
| сторона | нить | Необязательный Псевдоним идентификант. |
| распределенный | 0 | 1 | Необязательный 1 = только распределено, 0 = не распространяется. |
| дата_из | ГГГГ-ММ-ДД | Необязательный Дата отправки фильтра начинается с этого дня. |
| дата_до | ГГГГ-ММ-ДД | Необязательный Фильтровать отправленные данные до текущего дня. |
Пример успешного ответа
{ "success": true, "message": "Уведомления успешно получены."", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Уведомление", "message": "vers miano", "distribued": "1", "distribued_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Отправить поля ответа
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| сообщение | нить | Результат в удобочитаемом виде. |
| идентификатор | инт | В базе данных создан идентификатор уведомления. |
| апики | нить | Выведен ключ API. |
| сторона | нить | Целевой мобильный идентификатор, использованный при создании. |
Список полей ответа
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| сообщение | нить | Результат в удобочитаемом виде. |
| фильтры | объект | Использованные фильтры, указанные в запросе. |
| считать | инт | Количество возвращенных уведомлений. |
| данные | множество | Список уведомлений. |
| данные[].идентификатор | нить | Целевой мобильный идентификатор. |
| данные[].title | нить | Заголовок уведомления. |
| данные[].сообщение | нить | Уведомление. |
| данные[].распределенные | нить | Исходный распределенный флаг. |
| данные[].распределенный_статус | нить | распределенный или не_распределено. |
| data[].distributed_date_gmt | нить | Дата распространения указана по Гринвичу. |
| data[].distributed_time_gmt | нить | Время распространения сигнала в формате GMT. |
| data[].distributed_at_gmt | нить | Полная информация о дате и времени распространения указана по Гринвичу. |
| данные[].распределенные_в_unix | целое|пустое | Дата и время распространения в формате метки времени Unix. |
| данные[].распределенный_таймзон | нить | Всегда время по Гринвичу. |
| data[].sent_date_gmt | нить | Укажите дату в формате GMT. |
| данные[].sent_time_gmt | нить | Укажите время в формате GMT. |
| данные[].sent_at_gmt | нить | Полная дата и время отправки указаны по Гринвичу. |
| данные[].sent_at_unix | целое|пустое | Отправляйте дату и время в виде метки времени Unix. |
| data[].sent_timezone | нить | Всегда время по Гринвичу. |
