Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

У SMSmobileAPI ми прагнемо зробити наш API максимально сумісним із будь-якою архітектурою чи платформою.
Незалежно від того, чи використовуєте ви REST, SOAP, cURL або різні мови програмування, як-от Python, JavaScript, PHP тощо, наш API створено для бездоганної інтеграції у ваші проекти.

У нас також є готові до використання плагіни для рішень електронної комерції та програмного забезпечення. Натисніть тут, щоб дізнатися про них.

Якщо у вас виникли запитання, пропозиції чи потрібна допомога, наша команда готова допомогти.
Не соромтеся звертатися до нас за адресою api@smsmobileapi.com

API REST

cURL

JavaScript

Python

Node.js

рубін

WSDL

API надсилання SMS

The SMSMobile API supports two authentication methods: using a simple API Key or the OAuth2 protocol with a client ID and client secret.

1. API Key Authentication for Send SMS

This method requires an API Key that can be included as a parameter in either a GET or POST request. It is a straightforward way to authenticate your API requests.

https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=PHONE_NUMBER&message=MESSAGE_TO_SEND

Параметри:

- apikey: Your unique API key.

- recipients: The recipient's phone number.

- message: The message to send.

Example:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=Hello%20World

2. OAuth2 Authentication for Send SMS

OAuth2 provides a more secure and scalable authentication method.
You will need to use a client ID and client secret to obtain an access token, which should then be included in your API requests using the Authorization header.

The client_id and client_secret are available in your dashboard, accessible after installing the app and creating an account on your mobile device.
Download the mobile app now або access your dashboard.

Obtaining an Access Token

To get an access token, send a POST request to the token endpoint with your client ID and 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=1ab0ex4b4c1ef2c800690d" \
 -d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

Using the Access Token:

Once you have the access token, include it in the Authorization header of your API requests:

 curl -X POST https://api.smsmobileapi.com/sendsms \
 -H "Authorization: Bearer abc123xyz456" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "recipients=+1234567890" \
 -d "message=Hello"

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

For more details, please refer to the full documentation.

Отримати SMS API

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

https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

Параметр:

- одержувачі: номер мобільного телефону одержувача.

- повідомлення: повідомлення для надсилання.

- apikey: ключ API, який ви маєте або отримаєте.

Видалити SMS API

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

https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

Параметр:

- apikey: ключ API, який у вас є.

- guid_message: унікальний ідентифікатор повідомлення для видалення.

- date_start: якщо використовується окремо, видаляє всі повідомлення за вказаний день.

- date_start і date_end: об’єднані для видалення повідомлень протягом зазначеного періоду.

Примітка. Видалені SMS – це лише ті, що зберігаються в журналах вашого облікового запису мобільного додатку. СМС на самому мобільному пристрої видалятися не будуть, так як ми не маємо до них доступу.

Надіслати SMS

WSDL URL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

Параметри:

- одержувачі: номер мобільного телефону одержувача.

- повідомлення: повідомлення для надсилання.

- 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

Базова команда 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"

Приклад cURL у PHP

Якщо ви використовуєте PHP, ось як ви можете надіслати SMS за допомогою cURL:

 <?php
 
 $url = 'https://api.smsmobileapi.com/sendsms/';
 $data = array(
     'recipients' => 'PHONE_NUMBER',
     'message' => 'YOUR_MESSAGE',
     'apikey' => 'YOUR_API_KEY'
 );
 
 $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

Використовуйте наш офіційний модуль Python: https://smsmobileapi.com/python/
або скористайтеся ручним способом...

Використання бібліотеки запитів

Бібліотека `requests` — популярна та проста бібліотека 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)

Цей приклад демонструє простий запит POST до SMSmobileAPI, надсилаючи повідомлення на певний номер телефону.

Використання бібліотеки `http.client`

Бібліотека `http.client` входить до стандартної бібліотеки 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()

У цьому прикладі показано, як використовувати бібліотеку `http.client` для надсилання запиту POST до API. Параметри кодуються в URL-адресі та надсилаються з відповідними заголовками.

Надіслати SMS

Використання API `fetch`

API `fetch` — це сучасний і універсальний спосіб робити 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));

Цей приклад демонструє, як надіслати запит POST за допомогою API `fetch`, який підтримується в більшості сучасних браузерів.

Використання `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);

У цьому прикладі показано, як використовувати `XMLHttpRequest` для надсилання запиту POST, забезпечуючи сумісність зі старими браузерами, які можуть не підтримувати `fetch`.

Надіслати SMS

Використання бібліотеки `axios`

Бібліотека `axios` є популярним 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);
 });

Цей приклад демонструє, як надіслати запит POST за допомогою `axios` у Node.js для взаємодії з SMSmobileAPI.

Надіслати SMS

Використання бібліотеки `Net::HTTP`

Ви можете використовувати бібліотеку `Net::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

Цей приклад демонструє, як надіслати запит POST за допомогою `Net::HTTP` у Ruby до SMSmobileAPI.

Клацніть тут, щоб перевірити ключ і службу API за допомогою простої форми

Залежно від версії Android, встановленої на мобільному телефоні, операційна система може перешкоджати належному функціонуванню автоматичного надсилання та отримання SMS-повідомлень, коли програма SmsMobileApi не працює на передньому плані.
Ця проблема виникає через процес, який намагається запуститися у фоновому режимі, коли програма не запускається активно. Однак через заходи з оптимізації акумулятора Android, які відрізняються в різних версіях, цей фоновий процес може розпочатися неправильно. Оптимізація батареї Android призначена для обмеження фонової активності програм для збереження часу роботи батареї, що може ненавмисно вплинути на програми, які потребують фонових процесів для належного функціонування.

Щоб вирішити цю проблему, користувачі можуть вручну налаштувати параметри свого Android, щоб дозволити SmsMobileApi використовувати ресурси без обмежень.
Це передбачає коригування параметрів оптимізації заряду батареї для певної програми, по суті, вказуючи Android, що SmsMobileApi має дозвіл працювати у фоновому режимі та використовувати ресурси за потреби. Завдяки цьому програма повинна мати можливість автоматично надсилати й отримувати SMS-повідомлення, навіть якщо вона не є активною програмою на передньому плані. Це налаштування гарантує, що необхідний фоновий процес може працювати безперервно, обходячи функції оптимізації батареї, які інакше могли б перешкодити його належному виконанню.

FAQ для розробника

Як створити ключ API?

Зразок опису Accordion Щоб згенерувати ключ API, завантажте нашу програму на свій мобільний телефон і створіть обліковий запис безкоштовно. Ключ API буде автоматично згенеровано та пов’язано з вашим мобільним телефоном. Ви також отримаєте електронний лист із усією необхідною інформацією. Цей процес гарантує, що ви зможете швидко та легко почати користуватися нашими послугами з мінімальними налаштуваннями.

Де я можу завжди знайти свій ключ API?

У своїй програмі для мобільних пристроїв перейдіть до меню НАЛАШТУВАННЯ або ДОВІДКА, де весь час буде видно ваш ключ API. Це гарантує, що ви можете легко отримати доступ до свого ключа API, коли він вам потрібен для інтеграції або використання наших послуг.

Чи може створення ключа API бути анонімним?

Так, нам не потрібні жодні підтвердження особи для створення ключа API. Тому зв’язок між нашим API і вашим мобільним телефоном є 100% анонімним. Такий підхід дозволяє користувачам зберігати конфіденційність під час використання наших послуг.

Почніть роботу з SMSmobileAPI вже сьогодні!

Відчуйте свободу та гнучкість керування своїми службами SMS у дорозі. Завантажте наш мобільний додаток зараз і зробіть перший крок до повної інтеграції SMS.

Завантажте додаток