Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

Chez SMSmobileAPI, nous nous efforçons de rendre notre API aussi compatible que possible avec n'importe quelle architecture ou plate-forme.
Que vous utilisiez REST, SOAP, cURL ou divers langages de programmation comme Python, JavaScript, PHP, etc., notre API est conçue pour s'intégrer de manière transparente à vos projets.

Nous disposons également de plugins prêts à l'emploi pour les solutions et logiciels de commerce électronique. Cliquez ici pour les découvrir.

Si vous avez des questions, des suggestions ou besoin d'aide, notre équipe est là pour vous aider.
N'hésitez pas à nous contacter à api@smsmobileapi.com

API REST

boucle

JavaScript

Python

Node.js

Rubis

WSDL

API d'envoi de 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

Paramètres:

- 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 ou 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.

Obtenir l'API SMS

Ce point de terminaison API est utilisé pour récupérer les messages SMS reçus sur le smartphone.

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

Paramètre:

- destinataires : Le numéro de mobile du destinataire.

- message : Le message à envoyer.

- apikey : la clé API que vous possédez ou que vous recevrez.

Supprimer l'API SMS

Ce point de terminaison d'API est utilisé pour supprimer les messages SMS du journal du serveur de l'API SMS Mobile

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

Paramètre:

- apikey : la clé API dont vous disposez.

- guid_message : l'ID unique du message à supprimer.

- date_start : s'il est utilisé seul, supprime tous les messages du jour spécifié.

- date_start et date_end : combinés pour supprimer les messages dans une période spécifiée.

Remarque : les SMS supprimés sont uniquement ceux stockés dans les journaux de votre compte d'application mobile. Les SMS sur l'appareil mobile lui-même ne seront pas supprimés, car nous n'y avons pas accès.

Envoyer un SMS

URL WSDL

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

Paramètres:

- destinataires : Le numéro de mobile du destinataire.

- message : Le message à envoyer.

- apikey : la clé API que vous possédez ou que vous recevrez.

Exemple

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

Envoyer un SMS

Commande cURL de base

Vous pouvez utiliser la commande cURL suivante pour envoyer un SMS via SMSmobileAPI :

 curl -X POST https://api.smsmobileapi.com/sendsms/ \
 -d "recipients=PHONE_NUMBER" \
 -d "message=YOUR_MESSAGE" \
 -d "apikey=YOUR_API_KEY"

Exemple de cURL en PHP

Si vous utilisez PHP, voici comment vous pouvez envoyer un SMS en utilisant 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;
 
 ?>

Cet exemple PHP montre comment envoyer une requête POST en utilisant cURL à SMSmobileAPI, en passant les paramètres nécessaires sous forme de tableau associatif.

Envoyer un SMS

Utilisez notre module Python officiel : https://smsmobileapi.com/python/
ou utiliser la méthode manuelle ...

Utilisation de la bibliothèque « requests »

La bibliothèque `requests` est une bibliothèque HTTP populaire et simple pour Python. Voici comment vous pouvez l'utiliser pour envoyer un SMS via 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)

Cet exemple illustre une requête POST simple adressée à SMSmobileAPI, envoyant un message à un numéro de téléphone spécifique.

Utilisation de la bibliothèque « http.client »

La bibliothèque `http.client` est incluse dans la bibliothèque standard de Python et peut également être utilisée pour interagir avec votre 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()

Cet exemple montre comment utiliser la bibliothèque `http.client` pour envoyer une requête POST à l'API. Les paramètres sont codés en URL et envoyés avec les en-têtes appropriés.

Envoyer un SMS

Utilisation de l'API « fetch »

L'API `fetch` est une méthode moderne et polyvalente pour effectuer des requêtes HTTP en JavaScript. Voici comment vous pouvez l'utiliser pour envoyer un SMS via l'API SMSmobile :

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

Cet exemple montre comment envoyer une requête POST à l'aide de l'API « fetch », qui est prise en charge dans la plupart des navigateurs modernes.

Utilisation de `XMLHttpRequest`

Si vous devez prendre en charge des navigateurs plus anciens, vous pouvez utiliser l'objet « 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);

Cet exemple montre comment utiliser `XMLHttpRequest` pour envoyer une requête POST, offrant une compatibilité avec les anciens navigateurs qui peuvent ne pas prendre en charge `fetch`.

Envoyer un SMS

Utilisation de la bibliothèque `axios`

La bibliothèque `axios` est un client HTTP populaire pour Node.js. Voici comment vous pouvez l'utiliser pour envoyer un SMS via 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);
 });

Cet exemple montre comment envoyer une requête POST à l'aide de « axios » dans Node.js pour interagir avec SMSmobileAPI.

Envoyer un SMS

Utilisation de la bibliothèque « Net::HTTP »

Vous pouvez utiliser la bibliothèque `Net::HTTP` dans Ruby pour envoyer un SMS via 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

Cet exemple montre comment envoyer une requête POST en utilisant `Net::HTTP` dans Ruby à SMSmobileAPI.

Cliquez ici pour tester la clé API et le service avec le formulaire simple

Selon la version d'Android installée sur un téléphone mobile, le système d'exploitation peut entraver le bon fonctionnement de l'envoi et de la réception automatique des messages SMS lorsque l'application SmsMobileApi n'est pas au premier plan.
Ce problème provient d'un processus qui tente de s'exécuter en arrière-plan lorsque l'application n'est pas lancée activement. Cependant, en raison des mesures d'optimisation de la batterie d'Android, qui varient selon les versions, ce processus d'arrière-plan peut ne pas démarrer correctement. L'optimisation de la batterie d'Android est conçue pour limiter l'activité en arrière-plan des applications afin de préserver l'autonomie de la batterie, ce qui peut affecter par inadvertance les applications qui nécessitent des processus en arrière-plan pour fonctionner correctement.

Pour résoudre ce problème, les utilisateurs peuvent configurer manuellement leurs paramètres Android pour permettre à SmsMobileApi d'utiliser les ressources sans restrictions.
Cela implique d'ajuster les paramètres d'optimisation de la batterie pour l'application spécifique, en indiquant essentiellement à Android que SmsMobileApi est autorisé à s'exécuter en arrière-plan et à utiliser les ressources selon les besoins. Ce faisant, l'application devrait pouvoir envoyer et recevoir automatiquement des messages SMS même lorsqu'elle n'est pas l'application active au premier plan. Ce réglage garantit que le processus d'arrière-plan nécessaire peut fonctionner sans interruption, contournant les fonctionnalités d'optimisation de la batterie qui pourraient autrement empêcher son exécution correcte.

FAQ pour les développeurs

Comment générer une clé API ?

Pour générer une clé API, téléchargez notre application sur votre téléphone mobile et créez un compte gratuitement. Une clé API sera automatiquement générée et liée à votre téléphone mobile. Vous recevrez également un e-mail contenant toutes les informations nécessaires. Ce processus vous permet de commencer à utiliser nos services rapidement et facilement avec une configuration minimale.

Où puis-je toujours trouver ma clé API ?

Dans votre application mobile, accédez au menu PARAMÈTRES ou AIDE, où votre clé API est visible à tout moment. Cela vous permet d'accéder facilement à votre clé API chaque fois que vous en avez besoin pour intégrer ou utiliser nos services.

La création d’une clé API peut-elle être anonyme ?

Oui, nous n'exigeons aucune preuve d'identité pour créer une clé API. La communication entre notre API et votre téléphone mobile est donc 100% anonyme. Cette approche permet aux utilisateurs de préserver leur confidentialité tout en utilisant nos services.

Commencez dès aujourd’hui avec SMSmobileAPI !

Découvrez la liberté et la flexibilité de gérer vos services SMS où que vous soyez. Téléchargez dès maintenant notre application mobile et faites le premier pas vers une intégration SMS transparente.

Téléchargez l'application