Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

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

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

Если у вас есть вопросы, предложения или нужна помощь, наша команда всегда готова помочь.
Не стесняйтесь обращаться к нам по адресу api@smsmobileapi.com

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

cURL

JavaScript

Питон

Node.js

Рубин

WSDL

API отправки СМС

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.

Получить API SMS

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

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

Параметр:

- получатели: номер мобильного телефона получателя.

- сообщение: Сообщение для отправки.

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

Удалить СМС 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 на самом мобильном устройстве не будут удалены, так как у нас нет к ним доступа.

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

URL-адрес WSDL

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

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

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

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

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

Используйте наш официальный модуль 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 и отправляются с соответствующими заголовками.

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

Использование 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`.

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

Использование библиотеки `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.

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

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

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

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

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

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

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

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

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

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

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

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