Документация API для уведомлений - SMSMobileAPI
Документация по API уведомлений SMSMobileAPI

Быстрый старт

Базовый URL

ПОЛУЧАТЬ https://api.smsmobileapi.com
Все приведенные ниже примеры показаны следующим образом: ПОЛУЧАТЬ требования к простоте. уведомление/отправить конечная точка также принимает ПОЧТА и Тело JSON. Заменять YOUR_API_KEY с вашим настоящим ключом.

Примеры

GET 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=YOUR_API_KEY
GET https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&sidentifiant=TARGET_SIDENTIFIANT&distribued=1&date_from=2026-03-01&date_to=2026-03-18

Аутентификация

Точки уведомлений проходят аутентификацию с использованием апики параметр.

Требуется на обеих конечных точках: Ключ API обязателен для уведомление/отправить и уведомление/список.

Общие понятия

Целевой мобильный

Уведомления отправляются на конкретное мобильное устройство с помощью сторонаКонечная точка списка может фильтровать один и тот же целевой объект, используя идентификант или сторона.

Распределенный статус

  • распределено=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-запроса.

Уведомление – Отправить

Создать новое уведомление для целевого мобильного устройства.

Конечная точка

ПОЛУЧАТЬ ПОЧТА https://api.smsmobileapi.com/notification/send

Параметры запроса/тела

ПараметрТипОписание
апики нить Необходимый Ваш ключ API.
сторона нить Необходимый Целевая мобильная идентификация.
заголовок нить Необязательный Заголовок уведомления. По умолчанию: Уведомление.
сообщение нить Необходимый Содержимое уведомления.
тип нить Необязательный Тип уведомления. По умолчанию: уведомление.

Пример успешного ответа

{ "success": true, "message": "Уведомление создано."", "id": 22087, "apikey": "ВАШ_API_КЛЮЧ", "sid": "508b004b4aadacc4" }

Уведомление – Список

Получайте последние уведомления для ключа API с возможностью фильтрации.

Конечная точка

ПОЛУЧАТЬ https://api.smsmobileapi.com/notification/list/

Параметры запроса

ПараметрТипОписание
апики нить Необходимый Ваш ключ 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": "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нитьВсегда время по Гринвичу.
💬 Онлайн-чат
💬 Доступен онлайн-чат
Есть вопросы или нужна помощь?
Наша команда здесь, чтобы помочь вам!

Введите свой адрес электронной почты
чтобы помочь нам выполнить ваш запрос:
Панель инструментов