Документація API сповіщень
Ці кінцеві точки дозволяють вам надсилати внутрішні мобільні сповіщення і отримати історію сповіщень з SMSMobileAPI. Сповіщення можна надсилати на певний мобільний пристрій, а потім відстежувати через кінцеву точку списку.
The сповіщення/список кінцева точка повертає час надсилання сповіщення та час розповсюдження в Грінвіч, включаючи повні рядки дати та часу та Мітки часу Unix.
Потрібна допомога? api@smsmobileapi.com
Швидкий старт
Базова URL-адреса
ОТРИМАТИ https://api.smsmobileapi.com
Усі приклади нижче показано як ОТРИМАТИ запити на простоту. сповіщення/надіслати кінцева точка також приймає ПОСТ і Тіло JSONЗамінити ВАШ_КЛЮЧ_API з вашим справжнім ключем.
Приклади
ОТРИМАТИ https://api.smsmobileapi.com/notification/send?apikey=YOUR_API_KEY&sid=TARGET_SIDENTIFIANT&title=Notification&message=Helloworld&type=notification
ОТРИМАТИ https://api.smsmobileapi.com/notification/list/?apikey=ВАШ_КЛЮЧ_API
ОТРИМАТИ https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&identifiant=TARGET_SIDENTIFIANT&distribued=1&date_from=2026-03-01&date_to=2026-03-18
Аутентифікація
Кінцеві точки сповіщень автентифікуються за допомогою apikey параметр.
Обов'язково на обох кінцевих точках: Ключ API є обов'язковим для
сповіщення/надіслати і сповіщення/список.
Загальні поняття
Цільовий мобільний
Сповіщення надсилаються на певний мобільний пристрій за допомогою СідКінцева точка списку може фільтрувати ту саму ціль за допомогою ідентифікатор або Сід.
Розподілений статус
- розподілено=1 означає, що сповіщення було розіслано.
- розподілено=0 означає не розподілений.
- розподілений_статус повернення розподілений або нерозподілений.
Дати та часові пояси
- надіслано_* поля представляють дату/час надсилання сповіщення в Грінвіч.
- розподілений_* поля представляють дату/час розповсюдження в Грінвіч.
- *_at_unix поля – це позначки часу Unix.
Поведінка кінцевої точки списку
- Кінцева точка списку завжди повертає максимум 200 рядки.
- Результати впорядковані від найновіших до найстаріших, використовуючи дату/час надсилання.
- Використання фільтрів дати датаАйоут внутрішньо та піддаються впливу як дата_від / дата_до.
Помилки
| HTTP | Приклад помилки | Значення |
|---|---|---|
| 400 | {"success":false,"message":"Відсутній обов'язковий параметр: apikey."} | Відсутній або порожній apikey. |
| 400 | {"success":false,"message":"Відсутні обов'язкові параметри: apikey та sid обов'язкові."} | Відсутній Сід на сповіщення/надіслати. |
| 400 | {"success":false,"message":"Відсутній обов'язковий параметр: message."} | Відсутній повідомлення на сповіщення/надіслати. |
| 400 | {"success":false,"message":"Недійсний формат date_from. Очікується РРРР-ММ-ДД."} | Недійсний дата_від форматувати сповіщення/список. |
| 400 | {"success":false,"message":"Недійсне розподілене значення. Допустимі значення: 0 або 1."} | Недійсний розподілений значення фільтра. |
| 500 | {"success":false,"message":"Помилка підключення до бази даних."} | Проблема з підключенням до бази даних. |
| 500 | {"success":false,"message":"Запит не вдався: ..."} | Помилка SQL / виконання. |
Сповіщення – Надіслати
Створіть нове сповіщення для цільового мобільного пристрою.
Кінцева точка
ОТРИМАТИ
ПОСТ
https://api.smsmobileapi.com/notification/send
Параметри запиту / тіла
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API. |
| Сід | рядок | Обов'язковий Цільовий мобільний ідентифікатор. |
| титул | рядок | Необов'язково Заголовок сповіщення. За замовчуванням: Сповіщення. |
| повідомлення | рядок | Обов'язковий Вміст сповіщення. |
| тип | рядок | Необов'язково Тип сповіщення. За замовчуванням: сповіщення. |
Приклад відповіді на успішне завершення
{ "success": true, "message": "Сповіщення створено.", "id": 22087, "apikey": "ВАШ_КЛЮЧ_API", "sid": "508b004b4aadacc4" }
Сповіщення – Список
Отримувати останні сповіщення для ключа API з додатковою фільтрацією.
Кінцева точка
ОТРИМАТИ
https://api.smsmobileapi.com/notification/list/
Параметри запиту
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API. |
| ідентифікатор | рядок | Необов'язково Фільтрувати сповіщення за цільовим мобільним пристроєм. |
| Сід | рядок | Необов'язково Псевдонім ідентифікатор. |
| розподілений | 0 | 1 | Необов'язково 1 = лише розподілений, 0 = лише не розподіляється. |
| дата_від | РРРР-ММ-ДД | Необов'язково Фільтрувати дату відправлення з цього дня. |
| дата_до | РРРР-ММ-ДД | Необов'язково Фільтр відправлено за датою до цього дня. |
Кінцева точка списку повертає щонайбільше 200 рядки та впорядковує їх за найновішими надісланими сповіщеннями.
Приклад відповіді на успішне завершення
{ "success": true, "message": "Сповіщення успішно отримано.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Сповіщення", "message": "надіслано", "distribued": "1", "distribued_status": "розповсюджено", "distributed_date_gmt": "18.03.2026", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "18.03.2026 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "18.03.2026", "sent_time_gmt": "10:15:03", "sent_at_gmt": "18.03.2026 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Надіслати поля відповіді
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| повідомлення | рядок | Результат, зрозумілий для людини. |
| ідентифікатор | ціл. | Створено ідентифікатор сповіщення в базі даних. |
| apikey | рядок | Відтворений ключ API. |
| Сід | рядок | Цільовий мобільний ідентифікатор, який використовується під час створення. |
Список полів відповідей
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| повідомлення | рядок | Результат, зрозумілий для людини. |
| фільтри | об'єкт | Відображені фільтри, що використовуються запитом. |
| рахувати | ціл. | Кількість повернутих сповіщень. |
| дані | масив | Список сповіщень. |
| дані[].ідентифікатор | рядок | Ідентифікатор цільового мобільного пристрою. |
| дані[].назва | рядок | Заголовок сповіщення. |
| дані[].повідомлення | рядок | Повідомлення. |
| дані[].розподілені | рядок | Сирий розподілений прапор. |
| дані[].розподілений_статус | рядок | розподілений або нерозподілений. |
| дані[].distributed_date_gmt | рядок | Дата розповсюдження за Гринвічем. |
| дані[].distributed_time_gmt | рядок | Час розповсюдження за Гринвічем. |
| дані[].distributed_at_gmt | рядок | Дата й час повного розповсюдження за Гринвічем. |
| дані[].distributed_at_unix | ціле число|нуль | Дата й час розповсюдження як позначка часу Unix. |
| дані[].distributed_timezone | рядок | Завжди Грінвіч. |
| дані[].sent_date_gmt | рядок | Дату надсилання у форматі GMT. |
| дані[].sent_time_gmt | рядок | Надсилати час у форматі GMT. |
| дані[].sent_at_gmt | рядок | Повна дата й час надсилання за Гринвічем. |
| дані[].sent_at_unix | ціле число|нуль | Надіслати дату та час як позначку часу Unix. |
| дані[].sent_timezone | рядок | Завжди Грінвіч. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian