Документация СМС
В SMSmobileAPI мы стремимся сделать наш API максимально совместимым с любой архитектурой или платформой.
Независимо от того, используете ли вы REST, SOAP, cURL или различные языки программирования, такие как Python, JavaScript, PHP и другие, наш API разработан для бесшовной интеграции в ваши проекты.
У нас также есть готовые к использованию плагины для решений и программного обеспечения для электронной коммерции.
Нажмите здесь, чтобы узнать о них.
Отправить СМС
Эта конечная точка позволяет вам отправлять SMS с вашего мобильного телефона.Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш уникальный ключ API. |
| recipients | Необходимый Номер телефона получателя. |
| message | Необходимый Сообщение для отправки (без ограничения в 160 символов). |
| port |
Укажите SIM-порт, который будет использоваться для отправки SMS: 1, 2или оставьте его пустым. Если поле оставить пустым, SMS-сообщение будет отправлено автоматически с использованием доступного SIM-порта. Этот параметр доступен начиная с версии Android. 4.1.15.0 и работает, когда приложение находится в передний план (первый план). |
| shorturl | 1 = преобразовать URL-адреса в короткие ссылки 0 или пусто = преобразование не выполняется |
| sIdentifiant | Выберите, какой из подключенных телефонов отправит SMS. Оставьте поле пустым для первого доступного устройства. Требуется приложение версии 3.0.35.3 и выше. |
| sendwa | 1 = отправить через WhatsApp. |
| sendsms | 1 = отправить по SMS (по умолчанию, если поле пустое). Установите значение 0, чтобы заблокировать отправку SMS. |
| encrypt_message | да = Получателю необходим ключ для расшифровки. Узнать больше |
| schedule_timestamp | Временная метка UNIX (GMT 0), с которой следует отправлять SMS. |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld
Повторно отправить неотправленное SMS
Этот API-интерфейс используется для повторной отправки неотправленного SMS-сообщения (только если сообщение имеет статус ошибки).
Конечная точка:
Параметр:
| Параметр | Описание |
|---|---|
| guid | Необходимый GUID сообщения, которое необходимо отправить повторно. |
Пример:
ПОЛУЧИТЬ https://api.smsmobileapi.com/resend/?apikey=ВАШ_КЛЮЧ_API&guid=GUID_СООБЩЕНИЯ
Журнал СМС, отправленных из API
Эта конечная точка API используется для извлечения журнала SMS-сообщений, отправленных через API.
Конечная точка:
Параметр:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| guid_message | Фильтрация по уникальному идентификатору сообщения. |
| before | Получить сообщения, отправленные до указанной метки времени или GUID. |
| error_api | 1 = ошибка при отправке списка SMS-сообщений через API. |
| error_mobile | 1 = список SMS с ошибкой обработки мобильного сообщения. |
| keyword | Фильтрация по количеству получателей или содержимому сообщения. |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY
Список отправленных SMS с мобильного телефона
Данная конечная точка API используется для отображения списка SMS-сообщений, отправленных с вашего мобильного устройства и синхронизированных с вашей учетной записью SMSMobileAPI.
Важный: Эта функция доступна начиная с версии Android. 4.1.20.
Важный: Эта функция По умолчанию отключено в приложении для Android.
Конфиденциальность: Вся синхронизированная информация анонимизирована, конфиденциальна и обрабатывается безопасным способом.
Ограничение на количество страниц в истории: Этот API всегда возвращает данные из последнего источника. 7 дней только.
Примечание: Если вы отправляете SMS, используя стандартную конечную точку API. https://api.smsmobileapi.com/sendsms/Эти SMS-сообщения также могут отображаться в этом списке, поскольку они физически отправляются с вашего мобильного устройства.
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| date | Необязательно. Фильтр по точной дате в YYYY-MM-DD формат. |
| date_from | Необязательно. Дата начала периода в YYYY-MM-DD формат. |
| date_to | Необязательно. Дата окончания периода в YYYY-MM-DD формат. |
| period | Необязательный параметр. Предопределенный фильтр по периоду. Допустимые значения: today, yesterday, last_24h, last_3days, last_7days. |
| number | Необязательно. Фильтр по номеру телефона получателя. |
| sIdentifiant | Необязательно. Фильтрация по мобильному идентификатору. |
| message | Необязательно. Фильтрация по содержимому SMS. |
| search | Необязательно. Глобальный поиск по sIdentifiant, number, message, mobile_date_formatted, и synchro_time. |
| sort_by | Необязательно. Поле для сортировки. Допустимые значения: sIdentifiant, number, message, mobile_date_ms, mobile_date_formatted, synchro_time. |
| sort_order | Необязательно. Порядок сортировки: ASC или DESC. |
| limit | Необязательный параметр. Максимальное количество возвращаемых строк. Максимально допустимое значение: 200. |
Возвращенные поля:
| Поле | Описание |
|---|---|
| sIdentifiant | Идентификатор мобильного телефона, связанный с отправленным SMS-сообщением. |
| number | Номер телефона получателя. |
| message | Содержимое SMS-сообщения. |
| mobile_date_ms | Исходная метка времени SMS в миллисекундах. |
| mobile_date_formatted | Дата в отформатированном виде получена с мобильного устройства. |
| synchro_time | Дата и время синхронизации SMS-сообщения с SMSMobileAPI. |
Пример:
Получите https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY
Пример с фильтрами:
GET https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&date=2026-03-13&number=32470000000&sort_by=synchro_time&sort_order=DESC
Пример с заданным периодом:
Получите https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200
СМС получено
Эта конечная точка API используется для извлечения SMS-сообщений, полученных на смартфоне.
Конечная точка:
Параметр:
| Параметр | Описание |
|---|---|
| apikey | Необходимый API-ключ, который у вас есть или который вы получите. |
| sIdentifiantPhone | Изолируйте телефон, связанный с полученными SMS-сообщениями. |
| after_timestamp_unix | Список полученных SMS-сообщений, следующих за меткой времени UNIX. |
| onlyunread | "Да" = отображает только SMS-сообщения, не помеченные как прочитанные (статус API). |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY
Отметить полученные SMS-сообщения как прочитанные
Этот API-интерфейс используется для пометки полученного SMS-сообщения как прочитанного. Только статус API.
Это не меняет статус чтения на смартфоне.
Конечная точка:
Параметр:
| Параметр | Описание |
|---|---|
| apikey | Необходимый API-ключ, который у вас есть или который вы получите. |
| guid_message | Необходимый GUID сообщения, которое нужно пометить как прочитанное. |
Пример:
ПОЛУЧИТЬ https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE
Обновить псевдоним SMS
Данная конечная точка API используется для обновления псевдонима полученного SMS-сообщения с помощью его GUID.
Примечание: The alias Параметр может быть пустым. В этом случае псевдоним будет очищен.
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| guid | Необходимый GUID полученного SMS-сообщения для обновления. |
| alias | Необходимый Псевдоним для этого SMS-сообщения. Это значение может быть пустым, чтобы удалить текущий псевдоним. |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE&alias=JohnDoe
Пример очистки псевдонима:
ПОЛУЧИТЕ https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE&alias=
Удалить СМС
Данная конечная точка API используется для удаления SMS-сообщений из журналов сервера SMS Mobile API.
Конечная точка:
Параметр:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Имеющийся у вас ключ API. |
| guid_message | Уникальный идентификатор сообщения, которое нужно удалить. |
| date_start | При использовании отдельно удаляет все сообщения за указанный день. |
| date_start and date_end | Объединено для удаления сообщений в течение указанного периода. |
Пример:
ПОЛУЧИТЬ https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY
Примечание: Удалены только те SMS-сообщения, которые хранятся в журналах сервера. SMS-сообщения на устройстве удалены не будут.
Список SMS-сообщений
Этот API-интерфейс используется для отображения переписки SMS-сообщений, связанных с вашей учетной записью.
Каждая переписка сгруппирована по номеру телефона и содержит соответствующие входящие и исходящие SMS-сообщения.
Примечание: Отправной точкой разговора является... origineConversation параметр:
- receivedРазговоры сначала обнаруживаются по полученным SMS-сообщениям в logsmsreceive
- sent: разговоры сначала обнаруживаются по отправленным SMS-сообщениям в logsmssent
Примечание: Если numero Если параметр не указан, API возвращает только последние беседы. По умолчанию возвращается последняя беседа. 20 На разговоры отвечают.
Примечание: Для исходящих SMS, если timearea_of_message доступно (пример: UTC+02), отображаемая дата автоматически преобразуется с использованием этого значения. Преобразованная дата также используется для сортировки.
Примечание: Если resume=1Возвращаются только последние сообщения из каждой переписки. Используйте resume_line_how определить, сколько последних сообщений следует включить.
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| origineConversation | Необходимый Определяет начальную точку списка диалогов. Допустимые значения: received или sent. |
| numero | Необязательный Отфильтруйте результаты, указав только один конкретный номер телефона. |
| date_from | Необязательный Фильтр по дате начала для переписок и сообщений. Допустимый формат: YYYY-MM-DD или полное значение даты и времени. |
| date_to | Необязательный Фильтр по дате окончания для переписок и сообщений. Допустимый формат: YYYY-MM-DD или полное значение даты и времени. |
| sort | Необязательный Порядок сортировки диалогов. Допустимые значения: DESC или ASC. По умолчанию: DESC. |
| limit | Необязательный Максимальное количество ответов на сообщения при numero не предоставлено. По умолчанию: 20. |
| resume | Необязательный Если установлено значение 1Возвращаются только последние сообщения из каждой переписки. |
| resume_line_how | Необязательный Количество последних сообщений, на которые нужно ответить в рамках одной беседы, когда resume=1. По умолчанию: 1. |
Подробности поведения:
- Входящие SMS-сообщения считываются из logsmsreceive.
- Исходящие SMS-сообщения считываются из logsmssent.
- Входящие сообщения всегда возвращаются. direction = "incoming".
- Исходящие сообщения всегда возвращаются. direction = "outgoing".
- Контактный псевдоним берётся из logsmsreceive.alias при наличии.
- Для входящих SMS-сообщений идентификатор мобильного телефона (SID) определяется следующим образом: sIdentifiant_pour_read.
- Для исходящих SMS-сообщений идентификатор мобильного телефона (SID) определяется следующим образом: send_from_mobile_sIdentifiant.
- Для исходящих SMS отображаемая дата корректируется следующим образом. timearea_of_message если это поле не пустое.
Пример 1 — Список последних переписок из полученных SMS:
ПОЛУЧИТЕ https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received
Пример 2 — Список последних переписок из отправленных SMS:
ПОЛУЧИТЕ https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=sent
Пример 3. Фильтрация по одному конкретному номеру телефона:
ПОЛУЧИТЕ https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&numero=32470000001
Пример 4. Фильтрация по диапазону дат:
ПОЛУЧИТЕ https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&date_from=2026-03-01&date_to=2026-03-31
Пример 5 — Режим возобновления с сохранением последних 3 сообщений из каждой переписки:
ПОЛУЧИТЕ https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=sent&resume=1&resume_line_how=3
Пример успешного ответа:
{ "success": true, "origineConversation": "received", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "John Doe", "messages": [ { "direction": "incoming", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Hello, I would like more information.", "status": "received", "mobile_sid": "device_sid_1" }, { "direction": "outgoing", "message_id": "msg_1002", "date": "2026-03-13 10:46:03", "timestamp_utc": "2026-03-13T08:46:03Z", "message": "Конечно, что бы вы хотели узнать?", "status": "sent", "mobile_sid": "device_sid_2" } ] } ] }
Поля ответа:
| Поле | Описание |
|---|---|
| success | Указывает, был ли запрос выполнен успешно. |
| origineConversation | Начальный режим, используемый для формирования списка диалогов. |
| resume | Указывает, включен ли режим возобновления работы. |
| resume_line_how | Количество последних строк, возвращаемых в ходе беседы при включенном режиме возобновления. |
| conversations | Множество разговоров. |
| phone_number | Номер телефона использовался для идентификации разговора. |
| contact_alias | Если доступен псевдоним, связанный с номером телефона. |
| messages | Массив SMS-сообщений внутри переписки. |
| direction | incoming для полученных SMS, outgoing для отправленных SMS. |
| message_id | Уникальный идентификатор сообщения. |
| date | Отображает дату сообщения. Для исходящих SMS-сообщений это значение можно настроить с помощью... timearea_of_message. |
| timestamp_utc | Временная метка UTC сообщения. |
| message | Содержание сообщения. |
| status | received для входящих SMS, sent для исходящих SMS. |
| mobile_sid | Идентификатор SID мобильного устройства, которое получило или отправило сообщение. |
Пример ошибки:
{ "success": false, "error": "Отсутствует обязательный параметр: apikey" }
Примечания:
- Если numero Если указанный номер телефона предоставлен, API возвращает только тот разговор, который связан с данным номером телефона.
- Если numero Если параметр не указан, API возвращает последние беседы в соответствии с выбранным режимом источника.
- Входящие и исходящие сообщения объединяются в единую временную шкалу для каждого телефонного номера.
- При сортировке исходящих сообщений учитывается скорректированная локальная дата. timearea_of_message доступно.
- Режим возобновления полезен для панелей мониторинга, виджетов, предварительного просмотра и сводок диалогов.
Шлюз – Список подключенных мобильных устройств
Список мобильных телефонов, подключенных к вашему устройству. СМС-шлюз.
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| sid | Фильтрация по точному SID (sIdentifiant_pour_check). |
| search | Поиск по полям (id, дата, батарея, версия, метка...). |
Пример:
Получите https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY
Шлюз – Обновление мобильной метки
Обновить метку (nom_reference) подключенного мобильного устройства.
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| sid | Необходимый Идентификатор устройства (sIdentifiant_pour_check). |
| label | Новая этикетка |
| phone_number | Новый номер телефона |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=SID&label=OfficePhone
Важный: Метка обязательна, но может быть пустой. (метка=).
Шлюз – Удаление подключенного мобильного устройства
Удалите подключенное мобильное устройство из шлюза (это удалит все строки истории для данного SID).
Конечная точка:
Параметры:
| Параметр | Описание |
|---|---|
| apikey | Необходимый Ваш ключ API. |
| sid | Необходимый Идентификатор устройства (sIdentifiant_pour_check). |
Пример:
ПОЛУЧИТЕ https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=SID
Webhook – получено SMS
Эта система веб-перехватчиков отправляет запрос POST на настроенный URL-адрес всякий раз, когда получено SMS. Система обеспечивает обновления в реальном времени, доставляя данные SMS на указанный URL-адрес веб-перехватчика.
Как настроить Webhook на панели управления
Чтобы настроить URL-адрес веб-перехватчика на панели управления, выполните следующие действия:
- Войдите в свою учетную запись на Панель управления SMS Mobile API.
- Перейдите к Настройки вебхука раздел.
- Введите URL вашего вебхука (например,
https://example.com/webhook-endpoint). - Нажмите на Сохранить вебхук кнопка.
- После сохранения система начнет отправлять SMS-сообщения на настроенный URL-адрес.
Полезная нагрузка веб-перехватчика
При получении SMS-сообщения система отправляет следующую полезную нагрузку JSON на ваш URL-адрес веб-перехватчика:
{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Hello, this is a test."", "number": "+123456789", "guid": "abcde12345" }
Поля полезной нагрузки:
- дата: Дата добавления SMS (ГГГГ-ММ-ДД).
- час: Час добавления SMS (ЧЧ:мм:сс).
- время_получения: Время получения SMS.
- сообщение: Содержание СМС.
- число: Номер телефона отправителя.
- руководство: Уникальный идентификатор SMS.
Пример конечной точки WebHook
Ваш сервер должен быть готов обрабатывать входящие запросы POST. Ниже приведен пример скрипта PHP для обработки полезной нагрузки веб-перехватчика:
Тестирование Webhook
Чтобы проверить конфигурацию вашего вебхука, используйте такие инструменты, как:
Поиск неисправностей
- Убедитесь, что URL-адрес веб-хука правильный и общедоступный.
- Убедитесь, что ваш сервер возвращает код состояния HTTP 200 для успешных запросов.
- Проверьте журналы сервера на наличие ошибок при обработке полезной нагрузки.
Обогащенные SMS
ВскореАутентификация
API SMSMobile поддерживает два метода аутентификации: с использованием простого ключа API или протокола OAuth2 с идентификатором клиента и секретным ключом клиента.
1. Аутентификация API-ключа
Для этого метода требуется ключ API, который можно указать в качестве параметра в запросе GET или POST.
2. Аутентификация OAuth2
OAuth2 предоставляет более безопасный метод аутентификации.
Используйте идентификатор клиента и секретный ключ клиента для получения токена доступа, а затем включите его в Авторизация заголовок.
Параметры client_id и client_secret доступны на панели управления.
Загрузите мобильное приложение прямо сейчас или
получить доступ к своей панели управления.
Получение токена доступа
curl -X POST https://api.smsmobileapi.com/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET"
Использование токена доступа:
curl -X POST https://api.smsmobileapi.com/sendsms \
-H "Авторизация: владелец YOUR_ACCESS_TOKEN" \
-H "Тип содержимого: application/x-www-form-urlencoded" \
-d "получатели=+1234567890" \
-d "сообщение=Привет"
Какой метод следует использовать?
- Использовать Аутентификация API-ключа для быстрой и простой интеграции.
- Использовать Аутентификация OAuth2 для повышения безопасности и масштабируемости.
Отправить СМС
URL-адрес WSDL
Параметры:
- message: Сообщение для отправки.
- apikey: API-ключ, который у вас есть или который вы получите.
Пример
require_once "lib/nusoap.php";
$client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);
$error = $client->getError();
$result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));
print_r($result);
Отправить СМС и WhatsApp
Базовая команда cURL
curl -X POST https://api.smsmobileapi.com/sendsms/ \
-d "recipients=PHONE_NUMBER" \
-d "message=YOUR_MESSAGE" \
-d "apikey=YOUR_API_KEY"
-d "sendwa=1"
-d "sendsms=1"
Отправить СМС и WhatsApp
Используйте наш официальный модуль Python: https://smsmobileapi.com/python/
import requests
url = "https://api.smsmobileapi.com/sendsms/"
payload = {"recipients":"PHONE_NUMBER","message":"YOUR_MESSAGE","apikey":"YOUR_API_KEY"}
response = requests.post(url, data=payload)
print(response.text)
SMS Mobile API - PHP SDK (Composer)
композитор требует smsmobileapi/sdk
GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main
Отправить СМС и WhatsApp
const url = "https://api.smsmobileapi.com/sendsms/";
const data = {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"};
fetch(url,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded"},body:new URLSearchParams(data)})
.then(r=>r.text()).then(console.log);
Отправить СМС и WhatsApp
const axios = require("axios");
axios.post("https://api.smsmobileapi.com/sendsms/", {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"})
.then(r=>console.log(r.data));
Отправить СМС и WhatsApp
require "net/http"
require "uri"
uri = URI.parse("https://api.smsmobileapi.com/sendsms/")
req = Net::HTTP::Post.new(uri)
req.set_form_data({"recipients"=>"PHONE_NUMBER","message"=>"YOUR_MESSAGE","apikey"=>"YOUR_API_KEY"})
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true){|http| http.request(req)}
puts res.body

Эта проблема возникает из-за процесса, который пытается работать в фоновом режиме, когда приложение не запущено активно. Однако из-за мер оптимизации батареи Android, которые различаются в разных версиях, этот фоновый процесс может запускаться некорректно. Оптимизация батареи Android предназначена для ограничения фоновой активности приложений с целью экономии заряда батареи, что может непреднамеренно повлиять на приложения, которым для правильной работы требуются фоновые процессы.
Чтобы решить эту проблему, пользователи могут вручную настроить параметры Android, чтобы разрешить SmsMobileApi использовать ресурсы без ограничений.
Это включает в себя настройку параметров оптимизации батареи для конкретного приложения, по сути, указав Android, что SmsMobileApi разрешено работать в фоновом режиме и использовать ресурсы по мере необходимости. При этом приложение должно иметь возможность автоматически отправлять и получать SMS-сообщения, даже если оно не является активным приложением на переднем плане. Эта настройка гарантирует, что необходимый фоновый процесс может работать бесперебойно, обходя функции оптимизации батареи, которые в противном случае могли бы помешать его правильному выполнению.


Часто задаваемые вопросы для разработчиков
Начните работу с SMSmobileAPI уже сегодня!
Ощутите свободу и гибкость управления вашими SMS-сервисами на ходу. Загрузите наше мобильное приложение сейчас и сделайте первый шаг к бесшовной интеграции SMS.
Загрузить приложение