Документація SMS

Надіслати SMS

Кінцева точка: 

Параметри:

Приклад запиту:

Приклад JSON-відповіді:

{ "результат": { "помилка": 0, "відправлено": "1", "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "примітка": "відправлено з мобільного", "datetime": "2026-03-20T21:07:44Z", "datetimeLocal": "2026-03-20T22:07:44+01:00", "порт": null, "iac_control": "1", "iac_authorized": "1", "send_with_whatsapp": "0", "encrypted": { "status": "0" }, "trial_account": { "status": "0", "sms_sent": 0 } } }

Пояснення відповіді:

Повторно надіслати невідправлене SMS

Ця кінцева точка дозволяє повторно надіслати раніше невідправлене SMS-повідомлення, лише якщо повідомлення наразі перебуває у стані помилки.

Кінцева точка:

Параметри: 

Приклад запиту: 

Приклад JSON-відповіді:

{ "результат": { "помилка": "0", "sms": "повторно надіслано успішно", "спроба": 1 } }

Пояснення відповіді:

Журнал SMS, надісланих з API

Ця кінцева точка дозволяє отримувати журнал SMS-повідомлень, надісланих через API.

Кінцева точка: 

Параметри:

Приклад запиту:

Приклад JSON-відповіді:

{ "результат": { "помилка": "0", "sms": [ { "sIdentifiantPhone": "abbg00055x5", "порт": 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, "одержувачі": "32495898697", "sms": "тест", "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-відповіді:

{ "результат": { "помилка": "0", "кошт": 200, "ліміт": 200, "хистори_лиміт_дайс": 7, "сорт_би": "мобильна_дата_мс", "сорт_ордер": "ДЕСК", "смес": [ { "sIdentifiant": "508b004b4aadacc4", "нумбер": "+15551234567", "повідомлення": "Вітаємо, вашу зустріч підтверджено.", "мобильна_дата_мс": 1774041004692, "мобильна_дата_форматований": "2026-03-20 22:10:04", "синхронна_тим": "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 отримано

Ця кінцева точка дозволяє отримувати SMS-повідомлення, отримані на смартфоні. 

Кінцева точка:

Параметри: 

Приклад запиту:

Приклад JSON-відповіді:

{ "результат": { "помилка": "", "sms": [ { "id": 466340, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "дата": "2026-03-20", "годинник": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320222332804", "indice": "27593", "message": "Вітаємо, вашу посилку доставлено.", "нумбер": "+15551234567", "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122", "псевдонім": null, "apikey": "YOUR_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": "YOUR_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": "YOUR_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": "YOUR_API_KEY_HASH" } ] } }

Пояснення відповіді:

Позначити отримані SMS-повідомлення як прочитані

Ця кінцева точка API використовується для позначення одного отриманого SMS-повідомлення як прочитаного в Тільки статус API.
Це не змінює стан читання на смартфоні.  

Кінцева точка:

Параметр: 

приклад:

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

Ця кінцева точка API використовується для оновлення псевдоніма отриманого SMS-повідомлення за допомогою його GUID.

Примітка: The alias Параметр може бути порожнім. У такому разі псевдонім буде очищено.

Кінцева точка:

Параметри: 

приклад: 

Приклад очищення псевдоніма:

Видалити SMS

Ця кінцева точка дозволяє видаляти SMS-повідомлення з журналу сервера SMSMobileAPI.

Кінцева точка: 

Параметри:

Приклад запиту:

Приклад JSON-відповіді:

{ "результат": { "помилка": 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": "отримано", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "Іван Доу", "messages": [ { "direction": "вхідне", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Вітаю, я хотів би отримати більше інформації.", "status": "отримано", "mobile_sid": "device_sid_1" }, { "direction": "вихідне", "message_id": "msg_1002", "date": "2026-03-13 10:46:03", "timestamp_utc": "2026-03-13T08:46:03Z", "message": "Звичайно, а що б ви хотіли знати?", "status": "відправлено", "mobile_sid": "device_sid_2" } ] } ] }

Поля відповідей:

Приклад помилки:

{ "success": false, "error": "Відсутній обов'язковий параметр: apikey" }

Примітки:

Шлюз – Список підключених мобільних телефонів

Список мобільних телефонів, підключених до вашого SMS-шлюз.

Кінцева точка:

Параметри:

приклад:

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

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

Кінцева точка:

Параметри:

приклад:

Важливо: Мітка обов'язкова, але може бути порожньою (мітка=).

Gateway – Видалення підключеного мобільного телефону

Видалити підключений мобільний телефон зі шлюзу (видаляє всі рядки історії для цього SID).

Кінцева точка:

Параметри:

приклад:

Вебхук – SMS отримано

Ця система webhook надсилає запит POST на налаштовану URL-адресу кожного разу, коли надходить SMS. Система забезпечує оновлення в реальному часі, доставляючи деталі SMS на вказану URL-адресу веб-хуку.

Як налаштувати вебхук на інформаційній панелі

Виконайте наведені нижче дії, щоб налаштувати URL-адресу веб-хуку на інформаційній панелі:

1. Увійдіть у свій обліковий запис на Інформаційна панель SMS Mobile API.
2. Перейдіть до Налаштування Webhook розділ.
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": "Вітаємо, це тест.", "number": "+123456789", "guid": "abcde12345" }

Поля корисного навантаження:

• дата: Дата додавання SMS (РРРР-ММ-ДД).
• година: Година додавання SMS (ГГ:хх:сс).
• time_received: Час отримання SMS.
• повідомлення: Зміст смс. 
• номер: Номер телефону відправника.
• посібник: Унікальний ідентифікатор SMS.

Приклад кінцевої точки Webhook

Ваш сервер має бути готовий обробляти вхідні запити POST. Нижче наведено приклад сценарію PHP для обробки корисного навантаження вебхуку:

Тестування Webhook

Щоб перевірити конфігурацію вебхуку, скористайтеся такими інструментами, як:

• Webhook.site
• RequestBin

Усунення несправностей

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

Збагачені SMS

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

API SMSMobile підтримує два методи автентифікації: за допомогою простого ключа API або протоколу OAuth2 з ідентифікатором клієнта та секретом клієнта.

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

 Цей метод вимагає API-ключ, який можна включити як параметр у запит GET або POST.

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

OAuth2 забезпечує безпечніший метод автентифікації.
Використайте ідентифікатор клієнта та секретний код клієнта, щоб отримати токен доступу, а потім додайте його до Авторизація заголовок.

client_id і client_secret доступні на панелі інструментів.
Завантажте мобільний додаток зараз або доступ до вашої панелі інструментів.

Отримання маркера доступу

Використання маркера доступу:

Який метод слід використовувати?

- Використовуйте Аутентифікація ключа API для швидкої та простої інтеграції.

- Використовуйте Автентифікація OAuth2 для покращеної безпеки та масштабованості.