Dev DOC – SMSMobileAPI

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

Документація розробника SMSmobileAPI

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

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

.

API REST

cURL

Composer

JavaScript

Python

Node.js

рубін

WSDL

Надіслати SMS

Ця кінцева точка дозволяє надсилати SMS зі свого мобільного телефону.

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

ОТРИМАТИ ПОСТ https://api.smsmobileapi.com/sendsms/

Параметри:

Параметр	Параметр	опис
apikey	Обов'язковий Ваш унікальний ключ API.
recipients	Обов'язковий Номер телефону одержувача.
message	Обов'язковий Повідомлення для надсилання (Довжина повідомлення не обмежена 160 символами; ви можете надсилати довші повідомлення)
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 до 3 разів протягом визначеного інтервалу.

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

Ця кінцева точка API використовується для повторного надсилання невідправленого SMS (лише якщо повідомлення має статус помилки)

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

ОТРИМАТИ ПОСТ https://api.smsmobileapi.com/resend/

Параметр:

Параметр	опис
guid	Обов'язковий GUID повідомлення, яке потрібно надіслати повторно.

приклад:


        ОТРИМАТИ https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

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

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

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

ОТРИМАТИ https://api.smsmobileapi.com/log/sent/sms/

Параметр:

Параметр	опис
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-повідомлень, отриманих на смартфон.

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

ОТРИМАТИ https://api.smsmobileapi.com/getsms/

Параметр:

Параметр	опис
apikey	Обов'язковий Ключ API, який ви маєте або отримаєте.

приклад:


        ОТРИМАТИ https://api.smsmobileapi.com/getsms/?apikey=ВАШ_API_KEY

Видалити SMS

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

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

ОТРИМАТИ https://api.smsmobileapi.com/deletesms/

Параметр:

Параметр	опис
apikey	Обов'язковий Ключ API, який у вас є.
guid_message	Унікальний ідентифікатор повідомлення, яке потрібно видалити.
date_start	Якщо використовується окремо, видаляє всі повідомлення за вказаний день.
date_start and date_end	Комбіновано для видалення повідомлень протягом визначеного періоду.

приклад:


        ОТРИМАТИ https://api.smsmobileapi.com/deletesms/?apikey=ВАШ_API_KEY

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

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

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

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

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

Увійдіть у свій обліковий запис на Інформаційна панель SMS Mobile API.
Перейдіть до Налаштування Webhook розділ.
Введіть URL-адресу веб-хуку (наприклад, https://example.com/webhook-endpoint
Натисніть на Зберегти вебхук кнопку.
Після збереження система почне надсилати деталі SMS на налаштовану URL-адресу.

Корисне навантаження вебхуку

Коли надходить SMS, система надсилає таке корисне навантаження JSON на вашу URL-адресу веб-хука:

{

    "дата": "20.01.2025",

    "hour": "10:15:00",

    "time_received": "20.01.2025 10:14:50",

    "message": "Привіт, це тест.",

    "номер": "+123456789",

    "guid": "abcde12345"

}

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

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

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

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

<?php

// Читання вхідного корисного навантаження

$payload = file_get_contents('php://input');

$data = json_decode($payload, істина);




// Обробка даних SMS

if ($data) {

    // Приклад: зареєструвати дані SMS у файл

    file_put_contents('sms_log.txt', print_r($data, true), FILE_APPEND);




    // Відповісти статусом HTTP 200

    http_response_code(200);

    echo "Вебхук отримано успішно.";

} ще {

    // Відповідь статусом HTTP 400 на неправильні запити

    http_response_code(400);


    echo "Недійсне корисне навантаження.";

}

?>

Тестування Webhook

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

Ці інструменти дозволяють перевіряти корисне навантаження, надіслане системою, і виправляти будь-які проблеми з налаштуванням веб-хуку.

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

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

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

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

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

Параметри:

- recipients: Мобільний номер одержувача.

- 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/
або скористайтеся ручним способом...

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

Бібліотека `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 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 `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 і WhatsApp

Використання бібліотеки `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 і WhatsApp

Використання бібліотеки `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.

Ви можете надсилати повідомлення WhatsApp лише через наш API. Натисніть тут, щоб дізнатися більше.

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

Клацніть тут, щоб перевірити ключ і службу 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.

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

Функції SMS

Функції WhatsApp

Загальні плагіни

Плагіни Інтернет-магазину

API та документи для розробників

Інструменти та журнал змін

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

Надіслати SMS

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

LOG SMS надіслано

Отримайте SMS

Видалити SMS

Отримано SMS - вебхук

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

Надіслати SMS

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

Параметри:

приклад:

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

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

Параметр:

приклад:

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

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

Параметр:

приклад:

SMS отримано

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

Параметр:

приклад:

Видалити SMS

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

Параметр:

приклад:

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

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

Корисне навантаження вебхуку

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

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

Тестування Webhook

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

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

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

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

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

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

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

Надіслати SMS

WSDL URL

Параметри:

Приклад

Надсилайте SMS і WhatsApp

Базова команда cURL

Приклад cURL у PHP

Надсилайте SMS і WhatsApp

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

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

SMS Mobile API - PHP SDK (Composer)

Надсилайте SMS і WhatsApp

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

Використання `XMLHttpRequest`

Надсилайте SMS і WhatsApp

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

Надсилайте SMS і WhatsApp

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

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

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

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

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

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