Документація SMS
У SMSmobileAPI ми прагнемо зробити наш API максимально сумісним із будь-якою архітектурою чи платформою.
Незалежно від того, чи використовуєте ви REST, SOAP, cURL чи різні мови програмування, такі як Python, JavaScript, PHP тощо, наш API розроблений для безперешкодної інтеграції у ваші проекти.
У нас також є готові до використання плагіни для рішень електронної комерції та програмного забезпечення. Натисніть тут, щоб дізнатися про них.
Надіслати SMS
Ця кінцева точка дозволяє надсилати SMS зі свого мобільного телефону.Кінцева точка:
Параметри:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ваш унікальний ключ API. |
| recipients | Обов'язковий Номер телефону одержувача. |
| message |
Обов'язковий
Повідомлення для надсилання (Довжина повідомлення не обмежена 160 символами; ви можете надсилати довші повідомлення)
|
| shorturl |
1 = усі URL-адреси в повідомленні будуть автоматично перетворені на короткі URL-адреси 0 або порожнє = URL-адреси не будуть перетворені на короткі URL-адреси |
| sIdentifiant |
Якщо до вашого облікового запису підключено кілька телефонів, визначте, з якого телефону слід надсилати SMS. Кожен телефон має унікальний ідентифікатор — використовуйте цей ідентифікатор, щоб вибрати пристрій. Залиште це поле порожнім, щоб перший доступний телефон надсилав SMS, або якщо до вас підключено лише один телефон.
Для доступу до нього потрібна програма версії 3.0.35.3 або вище. |
| sendwa | 1 = повідомлення має бути надіслано через WhatsApp. |
| sendsms |
1 = повідомлення має бути надіслано за допомогою традиційного SMS. (Якщо надсилає смс порожній: надсилається за замовчуванням, встановіть 0, щоб заблокувати SMS) |
| encrypt_message |
так = Повідомлення буде зашифровано, коли його прочитає одержувач. Одержувач повинен буде ввести унікальний ключ, щоб розшифрувати повідомлення. Докладніше про шифрування повідомлень |
| schedule_timestamp | Відображення часу, з якого має бути надіслано SMS - Має бути a Позначка часу UNIX (GMT 0) |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld
Повторно надіслати невідправлене SMS
Ця кінцева точка API використовується для повторного надсилання невідправленого SMS (лише якщо повідомлення має статус помилки)
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| guid | Обов'язковий GUID повідомлення, яке потрібно надіслати повторно. |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE
Журнал SMS, надісланих з API
Ця кінцева точка API використовується для отримання журналу SMS-повідомлень, надісланих через API.
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ваш ключ API. |
| guid_message | Скорочення за унікальним ідентифікатором повідомлення, що використовується для сортування та фільтрації. |
| before | Отримувати повідомлення, надіслані до цієї конкретної позначки часу або GUID. |
| error_api | Введіть 1, щоб переглянути всі SMS-повідомлення, у яких сталася помилка під час запиту API. |
| error_mobile | Введіть 1, щоб переглянути всі SMS-повідомлення, у яких сталася помилка під час обробки мобільним пристроєм. |
| keyword | Ключове слово для фільтрації повідомлень на основі номера одержувача або вмісту SMS. |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/log/sent/sms?apikey=ВАШ_API_КЛЮЧ
SMS отримано
Ця кінцева точка API використовується для отримання SMS-повідомлень, отриманих на смартфон.
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ключ API, який ви маєте або отримаєте. |
| sIdentifiantPhone | Дозволяє ізолювати номер телефону, пов'язаний з отриманим SMS-повідомленням |
| after_timestamp_unix | Введіть «позначку часу». Дозволяє переглядати отримані SMS-повідомлення після заданої позначки часу UNIX. |
| onlyunread | Введіть «так». Дозволяє відображати лише SMS-повідомлення, які ще не позначені як прочитані (відповідно до статусу API). |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/getsms/?apikey=ВАШ_КЛЮЧ_API
Позначити отримані SMS-повідомлення як прочитані
Ця кінцева точка API використовується для позначення одного або кількох отриманих SMS-повідомлень як прочитаних лише у статусі API.
Це означає, що статус прочитання оновлюється на стороні API, що допомагає фільтрувати вже оброблені повідомлення під час використання фільтра onlyunread=yes.
Важливо:
Ця дія не впливає на стан читання на самому смартфоні — зміна стосується лише стану API, а не стану месенджера чи системи на пристрої.
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ключ API, який ви маєте або отримаєте. |
| guid_message | Обов'язковий GUID повідомлення, яке потрібно позначити як прочитане |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE
Видалити SMS
Ця кінцева точка API використовується для видалення SMS-повідомлень із журналу сервера SMS Mobile API
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ключ API, який у вас є. |
| guid_message | Унікальний ідентифікатор повідомлення, яке потрібно видалити. |
| date_start | Якщо використовується окремо, видаляє всі повідомлення за вказаний день. |
| date_start and date_end | Комбіновано для видалення повідомлень протягом визначеного періоду. |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/deletesms/?apikey=ВАШ_API_KEY
Примітка: Видалені SMS-повідомлення зберігаються лише в журналах вашого облікового запису мобільного додатку. SMS-повідомлення на самому мобільному пристрої не будуть видалені, оскільки ми не маємо до них доступу.
Вебхук – SMS отримано
Ця система webhook надсилає запит POST на налаштовану URL-адресу кожного разу, коли надходить SMS. Система забезпечує оновлення в реальному часі, доставляючи деталі SMS на вказану URL-адресу веб-хуку.
Як налаштувати вебхук на інформаційній панелі
Виконайте наведені нижче дії, щоб налаштувати URL-адресу веб-хуку на інформаційній панелі:
- Увійдіть у свій обліковий запис на Інформаційна панель SMS Mobile API.
- Перейдіть до Налаштування Webhook розділ.
- Введіть 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": "Вітаємо, це тест.", "number": "+123456789", "guid": "abcde12345" }Поля корисного навантаження:
- дата: Дата додавання SMS (РРРР-ММ-ДД).
- година: Година додавання SMS (ГГ:хх:сс).
- time_received: Час отримання SMS.
- повідомлення: Зміст смс.
- номер: Номер телефону відправника.
- посібник: Унікальний ідентифікатор SMS.
Приклад кінцевої точки Webhook
Ваш сервер має бути готовий обробляти вхідні запити POST. Нижче наведено приклад сценарію PHP для обробки корисного навантаження вебхуку:
Тестування Webhook
Щоб перевірити конфігурацію вебхуку, скористайтеся такими інструментами, як:
Усунення несправностей
- Переконайтеся, що URL-адреса вебхуку правильна та загальнодоступна.
- Переконайтеся, що ваш сервер повертає код статусу HTTP 200 для успішних запитів.
- Перевірте журнали свого сервера на наявність будь-яких помилок під час обробки корисного навантаження.
Отримати пропущений дзвінок
Ця кінцева точка API використовується для відображення пропущених викликів з вашого мобільного телефону за допомогою SMS Mobile API.
Кінцева точка:
Параметр:
| Параметр | опис |
|---|---|
| apikey | Обов'язковий Ключ API, прив'язаний до вашого мобільного телефону. |
| offset | Початкова позиція пагінації (за замовчуванням: 0). |
| limit | Максимальна кількість результатів для повернення (за замовчуванням: 100). |
| search | Пошук за номером або іменем контакту. |
| date_start | Фільтрувати результати з цієї дати (формат: РРРР-ММ-ДД). |
| date_end | Фільтрувати результати до цієї дати (формат: РРРР-ММ-ДД). |
приклад:
ОТРИМАТИ https://api.smsmobileapi.com/missedcall/list/?apikey=ВАШ_КЛЮЧ_API
Примітка: Щоб використовувати цю кінцеву точку, на вашому мобільному пристрої має бути встановлено додаток SMS Mobile API. У додатку має бути ввімкнено функцію «відновлення пропущених викликів» і надано необхідні дозволи.
Збагачені SMS
СкороАутентифікація
API SMSMobile підтримує два методи автентифікації: за допомогою простого ключа API або протоколу OAuth2 з ідентифікатором клієнта та секретом клієнта.
1. Аутентифікація ключа API
Для цього методу потрібен ключ API, який можна включити як параметр у запит GET або POST. Це простий спосіб автентифікації ваших запитів API.
2. Автентифікація OAuth2
OAuth2 забезпечує більш безпечний і масштабований метод автентифікації.
Вам потрібно буде використовувати ідентифікатор клієнта та секрет клієнта, щоб отримати маркер доступу, який потім слід включити у ваші запити API за допомогою Авторизація заголовок.
Client_id і client_secret доступні на інформаційній панелі після встановлення програми та створення облікового запису на мобільному пристрої.
Завантажте мобільний додаток зараз або
доступ до вашої панелі інструментів.
Отримання маркера доступу
Щоб отримати маркер доступу, надішліть запит POST кінцевій точці маркера з ідентифікатором клієнта та секретом клієнта.
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=1ab0ex4b4c1ef2c800690d" \
-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"
Використання маркера доступу:
Отримавши маркер доступу, додайте його до Авторизація заголовок ваших запитів API:
curl -X POST https://api.smsmobileapi.com/sendsms \
-H "Авторизація: носій abc123xyz456" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "одержувачі=+1234567890" \
-d "повідомлення=Привіт"
Який метод слід використовувати?
- Використовуйте Аутентифікація ключа API для швидкої та простої інтеграції.
- Використовуйте Автентифікація OAuth2 для підвищення безпеки та масштабованості ваших інтеграцій.
Для отримання додаткової інформації зверніться до повної документації.
Надіслати SMS
WSDL URL
Параметри:
- message: Повідомлення для надсилання. (Довжина повідомлення не обмежена 160 символами; ви можете надсилати довші повідомлення)
- 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);
Надсилайте SMS і WhatsApp
Базова команда cURL
Ви можете використовувати таку команду cURL, щоб надіслати SMS через SMSmobileAPI:
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"
Приклад cURL у PHP
Якщо ви використовуєте PHP, ось як ви можете надіслати SMS за допомогою cURL:
<?php
$url = 'https://api.smsmobileapi.com/sendsms/';
$data = array(
'recipients' => 'PHONE_NUMBER',
'message' => 'YOUR_MESSAGE',
'apikey' => 'YOUR_API_KEY',
'sendwa' => '1',
'sendsms' => '1'
);
$options = array(
CURLOPT_URL => $url,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($data),
CURLOPT_RETURNTRANSFER => true,
);
$ch = curl_init();
curl_setopt_array($ch, $options);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Цей приклад PHP демонструє, як надіслати запит POST за допомогою cURL до SMSmobileAPI, передаючи необхідні параметри як асоціативний масив.
Надсилайте SMS і WhatsApp
Використовуйте наш офіційний модуль Python: https://smsmobileapi.com/python/
або скористайтеся ручним способом...
Використання запити Бібліотека
The запити Бібліотека — це популярна та проста HTTP-бібліотека для Python. Ось як ви можете використовувати її для надсилання SMS через SMSmobileAPI:
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)
Використання http.клієнт Бібліотека
The http.клієнт Бібліотека включена до стандартної бібліотеки Python і також може бути використана для взаємодії з вашим API:
import http.client
import urllib.parse
conn = http.client.HTTPSConnection("api.smsmobileapi.com")
params = urllib.parse.urlencode({
"recipients": "PHONE_NUMBER",
"message": "YOUR_MESSAGE",
"apikey": "YOUR_API_KEY"
})
headers = { "Content-type": "application/x-www-form-urlencoded" }
conn.request("POST", "/sendsms/", params, headers)
response = conn.getresponse()
data = response.read()
print(data.decode("utf-8"))
conn.close()
SMS Mobile API - PHP SDK (Composer)
SMS Mobile API PHP SDK доступний через Composer, що полегшує інтеграцію надсилання SMS у ваші програми PHP.композитор вимагає smsmobileapi/sdk
Щоб отримати детальну документацію, інструкції зі встановлення та приклади використання, відвідайте наш репозиторій GitHub:
🔗 SMS Mobile API PHP SDK на GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main
На GitHub ви знайдете:
✔️ Повний посібник зі встановлення
✔️ Приклад використання
✔️ Посилання на API та найкращі практики
Потрібна допомога? Не соромтеся відкривати випуск на GitHub! 🎯
Надсилайте SMS і WhatsApp
Використання принести API
The принести API — це сучасний та універсальний спосіб створення HTTP-запитів у JavaScript. Ось як ви можете використовувати його для надсилання SMS через SMSmobileAPI:
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(response => response.text())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));
Використання XMLHttpRequest
Якщо вам потрібна підтримка старіших браузерів, ви можете скористатися XMLHttpRequest об'єкт:
const xhr = new XMLHttpRequest();
const url = "https://api.smsmobileapi.com/sendsms/";
const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
console.log(xhr.responseText);
}
};
xhr.send(data);
Надсилайте SMS і WhatsApp
Використання аксіос Бібліотека
The аксіос Бібліотека — це популярний HTTP-клієнт для Node.js. Ось як ви можете використовувати її для надсилання SMS через SMSmobileAPI:
const axios = require('axios');
const url = 'https://api.smsmobileapi.com/sendsms/';
const data = {
recipients: 'PHONE_NUMBER',
message: 'YOUR_MESSAGE',
apikey: 'YOUR_API_KEY'
};
axios.post(url, data)
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error('Error:', error);
});
Надсилайте SMS і WhatsApp
Використання Мережа::HTTP Бібліотека
Ви можете використовувати Мережа::HTTP бібліотека в Ruby для надсилання SMS через SMSmobileAPI:
require 'net/http'
require 'uri'
uri = URI.parse("https://api.smsmobileapi.com/sendsms/")
request = Net::HTTP::Post.new(uri)
request.set_form_data(
"recipients" => "PHONE_NUMBER",
"message" => "YOUR_MESSAGE",
"apikey" => "YOUR_API_KEY"
)
req_options = {
use_ssl: uri.scheme == "https",
}
response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(request)
end
puts response.body
Ця проблема виникає через процес, який намагається запуститися у фоновому режимі, коли програма не запускається активно. Однак через заходи з оптимізації акумулятора Android, які відрізняються в різних версіях, цей фоновий процес може розпочатися неправильно. Оптимізація батареї Android призначена для обмеження фонової активності програм для збереження часу роботи батареї, що може ненавмисно вплинути на програми, які потребують фонових процесів для належного функціонування.
Щоб вирішити цю проблему, користувачі можуть вручну налаштувати параметри свого Android, щоб дозволити SmsMobileApi використовувати ресурси без обмежень.
Це передбачає коригування параметрів оптимізації заряду батареї для певної програми, по суті, вказуючи Android, що SmsMobileApi має дозвіл працювати у фоновому режимі та використовувати ресурси за потреби. Завдяки цьому програма повинна мати можливість автоматично надсилати й отримувати SMS-повідомлення, навіть якщо вона не є активною програмою на передньому плані. Це налаштування гарантує, що необхідний фоновий процес може працювати безперервно, обходячи функції оптимізації батареї, які інакше могли б перешкодити його належному виконанню.
FAQ для розробника
Почніть роботу з SMSmobileAPI вже сьогодні!
Відчуйте свободу та гнучкість керування своїми службами SMS у дорозі. Завантажте наш мобільний додаток зараз і зробіть перший крок до повної інтеграції SMS.
Завантажте додаток
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian