Document de développement

Documentation SMS

Documentation du développeur de SMSmobileAPI

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.

.

API REST

cURL

Composer

JavaScript

Python

Node.js

Rubis

WSDL

Authentification

CLÉ API
OAuth2

Envoyer un SMS

Ce point de terminaison vous permet d'envoyer un SMS depuis votre téléphone mobile.

Point final :

OBTENIR POSTE https://api.smsmobileapi.com/sendsms/

Paramètres:

- apikey:Votre clé API unique.

- recipients:Le numéro de téléphone du destinataire.

- message:Le message à envoyer (La longueur du message n'est pas limitée à 160 caractères ; vous pouvez envoyer des messages plus longs)

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

- schedule_timestamp = Représente l'heure à partir de laquelle le SMS doit être envoyé - Doit être un **horodatage UNIX (GMT 0)**

Exemple:


        OBTENEZ https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld

Remarque : En cas d'erreur de livraison causée par votre opérateur, une fonction par défaut réessaie d'envoyer le même SMS jusqu'à 3 fois dans un intervalle défini.

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 :

OBTENIR POSTE https://api.smsmobileapi.com/resend/

Paramètre:

- guid: (obligatoire) 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 :

OBTENIR https://api.smsmobileapi.com/log/sent/sms/

Paramètre:

- apikey: (obligatoire) 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: Entrez « 1 » (`&error_api=1`) pour répertorier tous les SMS qui ont rencontré une erreur lors de la requête API.

- error_mobile: Entrez « 1 » (`&error_mobile=1`) pour lister tous les SMS qui ont 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 :

OBTENIR https://api.smsmobileapi.com/getsms/

Paramètre:

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

Exemple:


        OBTENEZ https://api.smsmobileapi.com/getsms/?apikey=VOTRE_CLÉ_API

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 :

OBTENIR https://api.smsmobileapi.com/deletesms/

Paramètre:

- apikey: 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 : 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.

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",

    "heure": "10:15:00",

    "time_received": "2025-01-20 10:14:50",

    "message": "Bonjour, ceci est un test.",

    "numéro": "+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 :

<?php

// Lire la charge utile entrante

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

$data = json_decode($charge utile, vrai);




// Traiter les données SMS

si ($données) {

    // Exemple : enregistrer les données SMS dans un fichier

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




    // Répondez avec le statut HTTP 200

    http_response_code(200);

    echo "Webhook reçu avec succès.";

} autre {

    // Répondez avec le statut HTTP 400 pour les requêtes incorrectes

    http_response_code(400);


    echo "Charge utile non valide.";

}

?>

Tester le Webhook

Pour tester la configuration de votre webhook, utilisez des outils tels que :

Ces outils vous permettent d'inspecter la charge utile envoyée par le système et de déboguer tout problème avec la configuration de votre webhook.

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.

Authentification

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

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

Paramètres:

- recipients: Le numéro de téléphone portable du destinataire.

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

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.

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

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 des SMS et WhatsApp

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 des SMS et WhatsApp

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.

Vous ne pouvez envoyer des messages WhatsApp que via notre API. Cliquez ici pour en savoir plus.

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

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

Documentation SMS

Envoyer un SMS

Renvoyer les SMS non envoyés

SMS envoyés

Obtenir les SMS reçus

Supprimer les SMS

SMS reçus - Webhook

Authentification

Envoyer un SMS

Point final :

Paramètres:

Exemple:

Renvoyer un SMS non envoyé

Point final :

Paramètre:

Exemple:

Journal des SMS envoyés depuis l'API

Point final :

Paramètre:

Exemple:

SMS reçu

Point final :

Paramètre:

Exemple:

Supprimer les SMS

Point final :

Paramètre:

Exemple:

Webhook – SMS reçus

Comment configurer le Webhook dans le tableau de bord

Charge utile du webhook

Champs de charge utile :

Exemple de point de terminaison Webhook

Tester le Webhook

Dépannage

Authentification

1. Authentification par clé API

2. Authentification OAuth2

Obtention d'un jeton d'accès

Utilisation du jeton d’accès :

Quelle méthode devriez-vous utiliser ?

Envoyer un SMS

URL WSDL

Paramètres:

Exemple

Envoyer des SMS et WhatsApp

Commande cURL de base

Exemple de cURL en PHP

Envoyer des SMS et WhatsApp

Utilisation de la bibliothèque « requests »

Utilisation de la bibliothèque « http.client »

API mobile SMS - PHP SDK (Composer)

Envoyer des SMS et WhatsApp

Utilisation de l'API « fetch »

Utilisation de `XMLHttpRequest`

Envoyer des SMS et WhatsApp

Utilisation de la bibliothèque `axios`

Envoyer des SMS et WhatsApp

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

FAQ pour les développeurs

Comment générer une clé API ?

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

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

Commencez dès aujourd’hui avec SMSmobileAPI !