Documentation SMS
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 et bien d'autres, notre API est conçue pour s'intégrer parfaitement à 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.
Envoyer un SMS
Ce point de terminaison vous permet d'envoyer un SMS depuis votre téléphone mobile.Point final :
Paramètres:
| Paramètre | Description |
|---|---|
| apikey | Requis Votre clé API unique. |
| recipients | Requis Le numéro de téléphone du destinataire. |
| message |
Requis
Le message à envoyer (La longueur du message n'est pas limitée à 160 caractères ; vous pouvez envoyer des messages plus longs)
|
| shorturl |
1 = toutes les URL du message seront automatiquement converties en URL courtes 0 ou vide = les URL ne seront pas converties en URL courtes. |
| sIdentifiant |
Si plusieurs téléphones sont associés à votre compte, indiquez lequel doit envoyer le SMS. Chaque téléphone possède un identifiant unique ; utilisez-le pour sélectionner l’appareil. Laissez ce champ vide pour que le premier téléphone disponible envoie le SMS, ou si vous n’avez qu’un seul téléphone associé.
Vous avez besoin de la version 3.0.35.3 ou supérieure de l'application pour y accéder. |
| sendwa | 1 = le message doit être envoyé via WhatsApp. |
| sendsms |
1 = le message doit être envoyé via un SMS traditionnel. (Si envoie des SMS est vide : envoyé par défaut, mettre à 0 pour bloquer le SMS) |
| encrypt_message |
Oui = Le message sera crypté lors de sa lecture par le destinataire. Le destinataire devra saisir une clé unique pour décrypter le message. En savoir plus sur le cryptage des messages |
| schedule_timestamp | Représentant l'heure à partir de laquelle le SMS doit être envoyé - Doit être un Horodatage UNIX (GMT 0) |
Exemple:
GET https://api.smsmobileapi.com/sendsms?apikey=VOTRE_CLÉ_API&recipients=+1234567890&message=HelloWorld
Renvoyer un SMS non envoyé
Ce point de terminaison API est utilisé pour renvoyer un SMS non envoyé (uniquement si le message a un statut d'erreur)
Point final :
Paramètre:
| Paramètre | Description |
|---|---|
| guid | Requis GUID du message à renvoyer. |
Exemple:
OBTENEZ https://api.smsmobileapi.com/resend/?apikey=VOTRE_CLÉ_API&guid=GUID_DU_MESSAGE
Journal des SMS envoyés depuis l'API
Ce point de terminaison API est utilisé pour récupérer le journal des messages SMS envoyés via l'API.
Point final :
Paramètre:
| Paramètre | Description |
|---|---|
| apikey | Requis Votre clé API. |
| guid_message | Abrégé par l'identifiant unique du message utilisé pour le tri et le filtrage. |
| before | Récupérer les messages envoyés avant cet horodatage ou GUID spécifique. |
| error_api | Saisissez 1 pour afficher la liste de tous les SMS ayant rencontré une erreur lors de la requête API. |
| error_mobile | Saisissez 1 pour afficher la liste de tous les SMS ayant rencontré une erreur lors du traitement mobile. |
| keyword | Un mot-clé pour filtrer les messages en fonction du numéro du destinataire ou du contenu du SMS. |
Exemple:
OBTENEZ https://api.smsmobileapi.com/log/sent/sms?apikey=YOUR_API_KEY
SMS reçu
Ce point de terminaison API est utilisé pour récupérer les messages SMS reçus sur le smartphone.
Point final :
Paramètre:
| Paramètre | Description |
|---|---|
| apikey | Requis La clé API que vous possédez ou que vous recevrez. |
| sIdentifiantPhone | Permet d'isoler un numéro de téléphone lié au SMS reçu |
| after_timestamp_unix | Entrez l'horodatage Permet de lister les messages SMS reçus après un horodatage UNIX donné |
| onlyunread | Entrer « oui » Permet de lister uniquement les messages SMS qui n'ont pas encore été marqués comme lus (selon le statut de l'API). |
Exemple:
OBTENEZ https://api.smsmobileapi.com/getsms/?apikey=VOTRE_CLÉ_API
Marquer les messages SMS reçus comme lus
Ce point de terminaison d'API est utilisé pour marquer un ou plusieurs messages SMS reçus comme lus dans le statut de l'API uniquement.
Cela signifie que l'état de lecture est mis à jour côté API, vous aidant à filtrer les messages déjà traités lorsque vous utilisez le filtre onlyunread=yes.
Important:
Cette action n’affecte pas l’état de lecture sur le smartphone lui-même : la modification s’applique uniquement à l’état de l’API, pas à l’application de messagerie ou à l’état du système sur l’appareil.
Point final :
Paramètre:
| Paramètre | Description |
|---|---|
| apikey | Requis La clé API que vous possédez ou que vous recevrez. |
| guid_message | Requis GUID du message à marquer comme lu |
Exemple:
OBTENEZ https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE
Supprimer les SMS
Ce point de terminaison d'API est utilisé pour supprimer les messages SMS du journal du serveur de l'API SMS Mobile
Point final :
Paramètre:
| Paramètre | Description |
|---|---|
| apikey | Requis La clé API dont vous disposez. |
| guid_message | L'ID unique du message à supprimer. |
| date_start | Si utilisé seul, supprime tous les messages du jour spécifié. |
| date_start and date_end | Combiné pour supprimer les messages dans une période spécifiée. |
Exemple:
OBTENEZ https://api.smsmobileapi.com/deletesms/?apikey=VOTRE_CLÉ_API
Remarque : Seuls les SMS enregistrés dans les journaux de votre compte d’application mobile seront supprimés. Les SMS présents sur votre appareil mobile ne seront pas supprimés, car nous n’y avons pas accès.
Webhook – SMS reçus
Ce système de webhook envoie une requête POST à l'URL configurée à chaque réception d'un SMS. Le système assure des mises à jour en temps réel en envoyant les détails du SMS à l'URL du webhook spécifiée.
Comment configurer le Webhook dans le tableau de bord
Suivez ces étapes pour configurer l’URL de votre webhook dans le tableau de bord :
- Connectez-vous à votre compte sur le Tableau de bord de l'API mobile SMS.
- Accédez au Paramètres du webhook section.
- Saisissez l'URL de votre webhook (par exemple,
https://example.com/webhook-endpoint). - Cliquez sur le Enregistrer le Webhook bouton.
- Une fois enregistré, le système commencera à envoyer les détails du SMS à l'URL configurée.
Charge utile du webhook
Lorsqu'un SMS est reçu, le système envoie la charge utile JSON suivante à l'URL de votre webhook :
{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Bonjour, ceci est un test.", "number": "+123456789", "guid": "abcde12345" }Champs de charge utile :
- date: Date à laquelle le SMS a été ajouté (AAAA-MM-JJ).
- heure: Heure à laquelle le SMS a été ajouté (HH:mm:ss).
- heure_reçue : Heure à laquelle le SMS a été reçu.
- message: Contenu du SMS.
- nombre: Numéro de téléphone de l'expéditeur.
- guide: Identifiant unique du SMS.
Exemple de point de terminaison Webhook
Votre serveur doit être prêt à gérer les requêtes POST entrantes. Vous trouverez ci-dessous un exemple de script PHP pour traiter la charge utile du webhook :
Tester le Webhook
Pour tester la configuration de votre webhook, utilisez des outils tels que :
Dépannage
- Assurez-vous que l’URL du webhook est correcte et accessible au public.
- Vérifiez que votre serveur renvoie un code d’état HTTP 200 pour les requêtes réussies.
- Vérifiez les journaux de votre serveur pour détecter d’éventuelles erreurs dans le traitement de la charge utile.
SMS enrichis
À venirAuthentification
L'API SMSMobile prend en charge deux méthodes d'authentification : à l'aide d'une simple clé API ou du protocole OAuth2 avec un ID client et un secret client.
1. Authentification par clé API
Cette méthode nécessite une clé API qui peut être incluse comme paramètre dans une requête GET ou POST. Il s'agit d'un moyen simple d'authentifier vos requêtes API.
2. Authentification OAuth2
OAuth2 fournit une méthode d’authentification plus sécurisée et évolutive.
Vous devrez utiliser un identifiant client et un secret client pour obtenir un jeton d'accès, qui doit ensuite être inclus dans vos requêtes API à l'aide de l' Autorisation en-tête.
Le client_id et le client_secret sont disponibles dans votre tableau de bord, accessibles après l'installation de l'application et la création d'un compte sur votre appareil mobile.
Téléchargez l'application mobile maintenant ou
Accédez à votre tableau de bord.
Obtention d'un jeton d'accès
Pour obtenir un jeton d'accès, envoyez une requête POST au point de terminaison du jeton avec votre ID client et votre secret client.
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"
Utilisation du jeton d’accès :
Une fois que vous avez le jeton d'accès, incluez-le dans le Autorisation en-tête de vos requêtes API :
curl-X POST https://api.smsmobileapi.com/sendsms \
-H "Autorisation : Porteur abc123xyz456" \
-H "Type de contenu : application/x-www-form-urlencoded" \
-d "destinataires=+1234567890" \
-d "message=Bonjour"
Quelle méthode devriez-vous utiliser ?
- Utiliser Authentification par clé API pour des intégrations rapides et simples.
- Utiliser Authentification OAuth2 pour une sécurité et une évolutivité améliorées dans vos intégrations.
Pour plus de détails, veuillez vous référer à la documentation complète.
Envoyer un SMS
URL WSDL
Paramètres:
- message: Le message à envoyer. (La longueur du message n'est pas limitée à 160 caractères ; vous pouvez envoyer des messages plus longs)
- 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 des SMS et WhatsApp
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"
-d "sendwa=1"
-d "sendsms=1"
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',
'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;
?>
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 des SMS et WhatsApp
Utilisez notre module Python officiel : https://smsmobileapi.com/python/
ou utiliser la méthode manuelle ...
En utilisant le demandes Bibliothèque
Le demandes Cette bibliothèque est une bibliothèque HTTP populaire et simple pour Python. Voici comment l'utiliser pour envoyer un SMS via l'API SMSmobile :
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)
En utilisant le http.client Bibliothèque
Le http.client Cette bibliothèque 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()
API mobile SMS - PHP SDK (Composer)
Le SDK PHP SMS Mobile API est disponible via Composer, ce qui facilite l'intégration de l'envoi de SMS dans vos applications PHP.le compositeur nécessite smsmobileapi/sdk
Pour une documentation détaillée, des instructions d'installation et des exemples d'utilisation, visitez notre référentiel GitHub :
🔗 API mobile SMS PHP SDK sur GitHub : https://github.com/SmsMobileApi/smsmobileapi-php/tree/main
Sur GitHub, vous trouverez :
✔️ Guide d'installation complet
✔️ Exemple d'utilisation
✔️ Référence API et bonnes pratiques
Besoin d'aide ? N'hésitez pas à ouvrir un ticket sur GitHub ! 🎯
Envoyer des SMS et WhatsApp
En utilisant le aller chercher API
Le aller chercher L'API est une méthode moderne et polyvalente pour effectuer des requêtes HTTP en JavaScript. Voici comment 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));
En utilisant Requête XMLHttp
Si vous devez prendre en charge les navigateurs plus anciens, vous pouvez utiliser Requête XMLHttp objet:
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);
Envoyer des SMS et WhatsApp
En utilisant le axios Bibliothèque
Le axios Cette bibliothèque est un client HTTP populaire pour Node.js. Voici comment l'utiliser pour envoyer un SMS via l'API SMSmobile :
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);
});
Envoyer des SMS et WhatsApp
En utilisant le Net::HTTP Bibliothèque
Vous pouvez utiliser le Net::HTTP Bibliothèque Ruby permettant d'envoyer des SMS via l'API SMSmobile :
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
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
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
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian