Dev DOC - SMSMobileAPI

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

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

В SMSmobileAPI мы стремимся сделать наш API максимально совместимым с любой архитектурой или платформой.
Независимо от того, используете ли вы REST, SOAP, cURL или различные языки программирования, такие как Python, JavaScript, PHP и другие, наш API разработан для бесшовной интеграции в ваши проекты.

У нас также есть готовые к использованию плагины для решений и программного обеспечения для электронной коммерции. Нажмите здесь, чтобы узнать о них.

.

API-интерфейс REST

cURL

Composer

JavaScript

Питон

Node.js

Рубин

WSDL

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

Эта конечная точка позволяет вам отправлять SMS с вашего мобильного телефона.

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

ПОЛУЧАТЬ ПОЧТА https://api.smsmobileapi.com/sendsms/

Параметры:

- apikey: Ваш уникальный ключ API.

- recipients: Номер телефона получателя.

- message: Сообщение для отправки (длина сообщения не ограничена 160 символами; вы можете отправлять более длинные сообщения)

- sendwa: 1 = сообщение должно быть отправлено через WhatsApp.

- sendsms: 1 = сообщение должно быть отправлено с помощью традиционного SMS. (Если посылает смс пусто: отправляется по умолчанию, установите 0, чтобы заблокировать SMS)

- schedule_timestamp = Указывает время, с которого должно быть отправлено SMS. Должна быть **метка времени UNIX (GMT 0)**

Пример:


        ПОЛУЧИТЬ https://api.smsmobileapi.com/sendsms?apikey=ВАШ_КЛЮЧ_API&recipients=+1234567890&message=HelloWorld

Примечание: в случае ошибки доставки по вине вашего оператора функция по умолчанию повторяет попытку отправки того же SMS-сообщения до 3 раз в течение определенного интервала времени.

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

Эта конечная точка API используется для повторной отправки неотправленного SMS (только если сообщение имеет статус ошибки)

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

ПОЛУЧАТЬ ПОЧТА https://api.smsmobileapi.com/resend/

Параметр:

- guid: (обязательно) GUID сообщения, которое необходимо отправить повторно.

Пример:


        ПОЛУЧИТЬ https://api.smsmobileapi.com/resend/?apikey=ВАШ_КЛЮЧ_API&guid=GUID_СООБЩЕНИЯ

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

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

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

ПОЛУЧАТЬ https://api.smsmobileapi.com/log/sent/sms/

Параметр:

- apikey: (обязательно) Ваш ключ API.

- guid_message: сокращенно по уникальному идентификатору сообщения, используемому для сортировки и фильтрации.

- before: Извлечь сообщения, отправленные до указанной временной метки или GUID.

- error_api: Введите `1` (`&error_api=1`), чтобы вывести список всех SMS, в которых возникла ошибка во время запроса API.

- error_mobile: Введите `1` (`&error_mobile=1`), чтобы вывести список всех SMS, при обработке которых на мобильном устройстве возникла ошибка.

- keyword: Ключевое слово для фильтрации сообщений по номеру получателя или содержанию SMS.

Пример:


        ПОЛУЧИТЕ https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY

СМС получено

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

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

ПОЛУЧАТЬ https://api.smsmobileapi.com/getsms/

Параметр:

- apikey: API-ключ, который у вас есть или который вы получите.

Пример:


        ПОЛУЧИТЬ https://api.smsmobileapi.com/getsms/?apikey=ВАШ_КЛЮЧ_API

Удалить СМС

Эта конечная точка 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=YOUR_API_KEY

Примечание: Удаляются только те SMS, которые хранятся в журналах вашего аккаунта мобильного приложения. SMS на самом мобильном устройстве не будут удалены, так как у нас нет к ним доступа.

Webhook – получено SMS

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

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

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

Войдите в свою учетную запись на Панель управления SMS Mobile API.
Перейдите к Настройки вебхука раздел.
Введите URL вашего вебхука (например, https://example.com/webhook-endpoint
Нажмите на Сохранить вебхук кнопка.
После сохранения система начнет отправлять SMS-сообщения на настроенный URL-адрес.

Полезная нагрузка веб-перехватчика

При получении SMS-сообщения система отправляет следующую полезную нагрузку JSON на ваш URL-адрес веб-перехватчика:

{

    "дата": "2025-01-20",

    "час": "10:15:00",

    "время_получения": "2025-01-20 10:14:50",

    "message": "Привет, это тест.",

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

    "руководство": "abcde12345"

}

Поля полезной нагрузки:

дата: Дата добавления SMS (ГГГГ-ММ-ДД).
час: Час добавления SMS (ЧЧ:мм:сс).
время_получения: Время получения SMS.
сообщение: Содержание СМС.
число: Номер телефона отправителя.
руководство: Уникальный идентификатор SMS.

Пример конечной точки WebHook

Ваш сервер должен быть готов обрабатывать входящие запросы POST. Ниже приведен пример скрипта PHP для обработки полезной нагрузки веб-перехватчика:

<?php

// Прочитать входящую полезную нагрузку

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

$data = json_decode($payload, true);




// Обработка данных SMS

если ($data) {

    // Пример: запись данных SMS в файл

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




    // Ответить со статусом HTTP 200

    http_код_ответа(200);

    echo "Webhook успешно получен.";

} еще {

    // Ответить статусом HTTP 400 для плохих запросов

    http_код_ответа(400);


    echo "Недопустимая полезная нагрузка.";

}

?>

Тестирование Webhook

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

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

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

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

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

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

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

Этот метод требует API Key, который может быть включен в качестве параметра в запрос GET или POST. Это простой способ аутентификации ваших API-запросов.

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

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

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

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

Чтобы получить токен доступа, отправьте 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 "Тип содержимого: application/x-www-form-urlencoded" \

-d "получатели=+1234567890" \

-d "сообщение=Привет"

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

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

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

Более подробную информацию можно найти в полной документации.

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

URL-адрес WSDL

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);

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

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

Для отправки SMS через SMSmobileAPI можно использовать следующую команду cURL:


        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, передав необходимые параметры в виде ассоциативного массива.

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

Используйте наш официальный модуль Python: https://smsmobileapi.com/python/
или используйте ручной способ ...

Использование библиотеки `requests`

Библиотека `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 и лучшие практики

Нужна помощь? Не стесняйтесь открыть issue на GitHub! 🎯

Отправить СМС и 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`.

Отправить СМС и 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.

Отправить СМС и 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-сообщения, даже если оно не является активным приложением на переднем плане. Эта настройка гарантирует, что необходимый фоновый процесс может работать бесперебойно, обходя функции оптимизации батареи, которые в противном случае могли бы помешать его правильному выполнению.

Часто задаваемые вопросы для разработчиков

Как сгенерировать ключ API?

Описание примера аккордеонаЧтобы сгенерировать ключ API, загрузите наше приложение на свой мобильный телефон и создайте учетную запись бесплатно. Ключ API будет автоматически сгенерирован и привязан к вашему мобильному телефону. Вы также получите электронное письмо со всей необходимой информацией. Этот процесс гарантирует, что вы сможете быстро и легко начать пользоваться нашими услугами с минимальной настройкой.

Где я всегда могу найти свой ключ API?

В вашем мобильном приложении перейдите в меню НАСТРОЙКИ или ПОМОЩЬ, где ваш ключ API виден в любое время. Это гарантирует, что вы сможете легко получить доступ к своему ключу API, когда он вам понадобится для интеграции или использования наших сервисов.

Может ли создание API-ключа быть анонимным?

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

Начните работу с SMSmobileAPI уже сегодня!

Ощутите свободу и гибкость управления вашими SMS-сервисами на ходу. Загрузите наше мобильное приложение сейчас и сделайте первый шаг к бесшовной интеграции SMS.

Загрузить приложение

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

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

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

LOG SMS отправлено

Получить СМС получено

Удалить СМС

Получено SMS - Webhook

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

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

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

Параметры:

Пример:

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

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

Параметр:

Пример:

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

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

Параметр:

Пример:

СМС получено

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

Параметр:

Пример:

Удалить СМС

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

Параметр:

Пример:

Webhook – получено SMS

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

Полезная нагрузка веб-перехватчика

Поля полезной нагрузки:

Пример конечной точки WebHook

Тестирование Webhook

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

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

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

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

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

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

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

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

URL-адрес WSDL

Параметры:

Пример

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

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

Пример cURL на PHP

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

Использование библиотеки `requests`

Использование библиотеки `http.client`

SMS Mobile API - PHP SDK (Composer)

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

Использование API `fetch`

Использование `XMLHttpRequest`

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

Использование библиотеки `axios`

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

Использование библиотеки `Net::HTTP`

Часто задаваемые вопросы для разработчиков

Как сгенерировать ключ API?

Где я всегда могу найти свой ключ API?

Может ли создание API-ключа быть анонимным?

Начните работу с SMSmobileAPI уже сегодня!