Документация СМС

Отправить СМС

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

Параметры:

Пример запроса:

Пример JSON-ответа:

{ "result": { "error": 0, "sent": "1", "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "note": "sent by mobile", "datetime": "2026-03-20T21:07:44Z", "datetimeLocal": "2026-03-20T22:07:44+01:00", "port": null, "iac_control": "1", "iac_authorized": "1", "send_with_whatsapp": "0", "encrypted": { "status": "0" }, "trial_account": { "status": "0", "sms_sent": 0 } } }

Пояснение к ответу:

Повторно отправить неотправленное SMS

Этот интерфейс позволяет повторно отправить ранее не отправленное SMS-сообщение, только если сообщение в данный момент находится в состоянии ошибки.

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

Параметры: 

Пример запроса: 

Пример JSON-ответа:

{ "result": { "error": "0", "sms": "resent with successfully", "attempt": 1 } }

Пояснение к ответу:

Журнал СМС, отправленных из API

Этот конечный пункт позволяет получить журнал SMS-сообщений, отправленных через API.

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

Параметры:

Пример запроса:

Пример JSON-ответа:

{ "result": { "error": "0", "sms": [ { "sIdentifiantPhone": "abbg00055x5", "port": 0, "date_add": "2026-03-20", "hour_add": "22:07:44", "timestamp": 1774044464, "send_from_mobile": 1, "send_from_mobile_date": "2026-03-20", "send_from_mobile_heure": "22:10:05", "send_from_mobile_timestamp": 1774044605, "recipients": "32495898697", "sms": "test", "error_api": "", "send_from_mobile_erreur": "", "guid_message": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "timearea": "UTC+01", "date_add_server": "2026-03-20", "hour_add_server": "21:07:44", "timestamp_server": 1774040864, "send_from_mobile_date_server": "2026-03-20", "send_from_mobile_heure_server": "21:10:05" } ] } }

Пояснение к ответу:

Список отправленных SMS с мобильного телефона

Этот конечный пункт позволяет получить список SMS-сообщений, отправленных с вашего мобильного устройства и синхронизированных с вашей учетной записью SMSMobileAPI.

Важный: Эта функция доступна начиная с версии Android. 4.1.20.

Важный: Эта функция По умолчанию отключено в приложении для Android.

Конфиденциальность: Вся синхронизированная информация анонимизирована, конфиденциальна и обрабатывается безопасным способом.

Ограничение на количество страниц в истории: Этот API возвращает данные только за последний период. 7 дней.

Примечание: Если вы отправляете SMS, используя стандартную конечную точку API. https://api.smsmobileapi.com/sendsms/Эти SMS-сообщения также могут отображаться в этом списке, поскольку они физически отправляются с вашего мобильного устройства.

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

Параметры: 

Возвращенные поля: 

Пример запроса: 

Пример с фильтрами:

Пример с заданным периодом:

Пример JSON-ответа:

{ "result": { "error": "0", "count": 200, "limit": 200, "history_limit_days": 7, "sort_by": "mobile_date_ms", "sort_order": "DESC", "sms": [ { "sIdentifiant": "508b004b4aadacc4", "number": "+15551234567", "message": "Здравствуйте, ваша запись подтверждена."", "mobile_date_ms": 1774041004692, "mobile_date_formatted": "2026-03-20 22:10:04", "synchro_time": "2026-03-20 21:10:05" }, { "sIdentifiant": "e5b70a8a28b2ec3d", "number": "+447700900123", "message": "Ваш код подтверждения: 482915."", "mobile_date_ms": 1774040902284, "mobile_date_formatted": "2026-03-20 22:08:22", "synchro_time": "2026-03-20 21:08:35" }, { "sIdentifiant": "e5b70a8a28b2ec3d", "number": "+33198765432", "message": "Спасибо за ваш заказ. Он обрабатывается."", "mobile_date_ms": 1774026491230, "mobile_date_formatted": "2026-03-20 18:08:11", "synchro_time": "2026-03-20 17:19:19" ] } }

Пояснение к ответу:

СМС получено

Этот интерфейс позволяет получать SMS-сообщения, поступающие на смартфон. 

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

Параметры: 

Пример запроса:

Пример JSON-ответа:

{ "result": { "error": "", "sms": [ { "id": 466340, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320222332804", "indice": "27593", "message": "Здравствуйте, ваша посылка доставлена."", "number": "+15551234567", "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122", "alias": null, "apikey": "ВАШ_API_KEY_HASH" }, { "id": 466341, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320221005892", "indice": "27591", "message": "Ваша запись подтверждена на завтра."", "number": "+447700900123", "guid": "BF3B38D7-8401-4A8C-8BA6-D8D58ACBB23E", "alias": null, "apikey": "ВАШ_API_KEY_HASH" }, { "id": 466324, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:08:24", "timestamp_unix": 1774040904, "time_received": "20260320220822763", "indice": "27590", "message": "Пожалуйста, перезвоните нам, когда будете свободны."", "number": "+33198765432", "guid": "08C88E20-9B98-453F-B361-9BB06D3275D6", "alias": null, "apikey": "ВАШ_API_KEY_HASH" }, { "id": 466156, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "19:05:22", "timestamp_unix": 1774033522, "time_received": "20260320200026246", "indice": "27588", "message": "Напоминание: проверка вашей учетной записи находится в процессе."", "number": "10001", "guid": "551B2CF4-9330-4DD2-B2BA-5A4026EEEB15", "alias": null, "apikey": "ВАШ_API_KEY_HASH" } ] } }

Пояснение к ответу:

Отметить полученные SMS-сообщения как прочитанные

Этот API-интерфейс используется для пометки полученного SMS-сообщения как прочитанного. Только статус API.
Это не меняет статус чтения на смартфоне.  

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

Параметр: 

Пример:

Обновить псевдоним SMS

Данная конечная точка API используется для обновления псевдонима полученного SMS-сообщения с помощью его GUID.

Примечание: The alias Параметр может быть пустым. В этом случае псевдоним будет очищен.

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

Параметры: 

Пример: 

Пример очистки псевдонима:

Удалить СМС

Этот конечный пункт позволяет удалять SMS-сообщения из журнала сервера SMSMobileAPI.

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

Параметры:

Пример запроса:

Пример JSON-ответа:

{ "result": { "error": null, "count_delete": 1 } }

Пояснение к ответу:

Примечание: удаляются только SMS-сообщения, хранящиеся в журналах сервера SMSMobileAPI. 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 определить, сколько последних сообщений следует включить.

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

Параметры: 

Подробности поведения: 

Пример 1 — Список последних переписок из полученных SMS: 

Пример 2 — Список последних переписок из отправленных SMS:

Пример 3. Фильтрация по одному конкретному номеру телефона:

Пример 4. Фильтрация по диапазону дат:

Пример 5 — Режим возобновления с сохранением последних 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": false, "error": "Отсутствует обязательный параметр: apikey" }

Примечания:

Шлюз – Список подключенных мобильных устройств

Список мобильных телефонов, подключенных к вашему устройству. СМС-шлюз.

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

Параметры:

Пример:

Шлюз – Обновление мобильной метки

Обновить метку (nom_reference) подключенного мобильного устройства.

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

Параметры:

Пример:

Важный: Метка обязательна, но может быть пустой. (метка=).

Шлюз – Удаление подключенного мобильного устройства

Удалите подключенное мобильное устройство из шлюза (это удалит все строки истории для данного SID).

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

Параметры:

Пример:

Webhook – получено SMS

Эта система веб-перехватчиков отправляет запрос POST на настроенный URL-адрес всякий раз, когда получено SMS. Система обеспечивает обновления в реальном времени, доставляя данные SMS на указанный URL-адрес веб-перехватчика.

Как настроить Webhook на панели управления

Чтобы настроить URL-адрес веб-перехватчика на панели управления, выполните следующие действия:

1. Войдите в свою учетную запись на Панель управления SMS Mobile API.
2. Перейдите к Настройки вебхука раздел.
3. Введите URL вашего вебхука (например, https://example.com/webhook-endpoint).
4. Нажмите на Сохранить вебхук кнопка. 
5. После сохранения система начнет отправлять 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

Чтобы проверить конфигурацию вашего вебхука, используйте такие инструменты, как:

• Webhook.сайт
• ЗапросБин

Поиск неисправностей

• Убедитесь, что URL-адрес веб-хука правильный и общедоступный.
• Убедитесь, что ваш сервер возвращает код состояния HTTP 200 для успешных запросов.
• Проверьте журналы сервера на наличие ошибок при обработке полезной нагрузки.

Обогащенные SMS

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

API SMSMobile поддерживает два метода аутентификации: с использованием простого ключа API или протокола OAuth2 с идентификатором клиента и секретным ключом клиента.

1. Аутентификация API-ключа

 Для этого метода требуется ключ API, который можно указать в качестве параметра в запросе GET или POST.

2. Аутентификация OAuth2

OAuth2 предоставляет более безопасный метод аутентификации.
Используйте идентификатор клиента и секретный ключ клиента для получения токена доступа, а затем включите его в Авторизация заголовок.

Параметры client_id и client_secret доступны на панели управления.
Загрузите мобильное приложение прямо сейчас или получить доступ к своей панели управления.

Получение токена доступа

Использование токена доступа:

Какой метод следует использовать?

- Использовать Аутентификация API-ключа для быстрой и простой интеграции.

- Использовать Аутентификация OAuth2 для повышения безопасности и масштабируемости.