Comment envoyer un SMS depuis l'API LWS

Définition

Qu'est qu'une API et quel est l'intérêt de passer par celle ci ?

API signifie "Application Programming INterface". Il s'agit d'un ensemble de moyens utilisés par un logiciel et/ou une plateforme afin de doner accès à certaines de ces fonctionnalitées.

De nos jours, les API sont très utilisé sur internet, en particulier par des fournisseurs de services ou de données, tel que le service SMS. 

Grâce aux API, il est possible, par le biais de votre propre script, d'expédier un SMS instantanément ou de manière différé.

Procédure

Qu'est qu'une API et quel est l'intérêt de passer par celle ci ?-?

API signifie "Application Programming INterface". Il s'agit d'un ensemble de moyens utilisés par un logiciel et/ou une plateforme afin de doner accès à certaines de ces fonctionnalitées.

De nos jours, les API sont très utilisé sur internet, en particulier par des fournisseurs de services ou de données, tel que le service SMS. 

Grâce aux API, il est possible, par le biais de votre propre script, d'expédier un SMS instantanément ou de manière différé.

Comment envoyer un SMS depuis l'API LWS

Envoyer un SMS par appel simple:

Afin d'envoyer un SMS simplement et rapidement, il suffit d'envoyer une requête HTTPS avec ses paramètres à l'adresse suivante:

https://sms.lws.fr/sms/api?action=send-sms&api_key=SMS_API_KEY=&to=DESTINATAIRE&from=SenderID&sms=VOTRE_MESSAGE

Les données à remplacer sont les suivantes: 

• SMS_API_KEY: Il s'agit de votre clé API accessible dans la rubrique "SMS API" de votre espace SMS
• DESTINATAIRE: Il s'agit du numéro de téléphone du destinataire au format international
• SenderID: Il s'agit de votre identifiant expéditeur
• VOTRE_MESSAGE: contenu du SMS

Utilisation de l'API en PHP:

Vous pouvez envoyer un SMS par le biais d'un API PHP:

<?php

/* On prépare les variables */

/* Url de l'API */
$gateway_url = "https://sms.lws.fr/sms/api";

/* Action appelé via l'API */
$action = "send-sms";

/* Clé API */
$apiKey  = "Votre clé API";

/* Numéro vers lequel sera envoyé le SMS
 * Format International - exemple 33600000000 
 */
$to = "33600000000";

/* SenderID qui sera affiché sur le téléphone portable. */
$senderID  = "Votre SenderID";

/* Encode le message en version SMS qui sera envoyé */
$message  = urlencode("Ceci est un message de test");


// Prepare le tableau de données pour la requête API 
$data = array('action' => $action,
              'api_key' => $apiKey,
              'to' => $to,
              'from' => $senderID,
              'sms' => $message,
);

// Envoie la requête API via cURL
$ch = curl_init($gateway_url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$get_data = json_decode($response, true);


/* On traite le retour.
 * get_data['code'] récupére un code selon la réussite ou l'erreur de l'API
 * get_data['Message'] récupére le message Success ou explication de l'erreur.
 */

if($get_data['code'] === 'ok'){
    echo 'Le SMS a bien été envoyé';
} else {
    echo 'Code Erreur : '.$get_data['code'].' -- '.$get_data['message'];
}

?>

• Votre clé API: Doit être la clé API que vous avez généré sur la plateforme SMS
• Le numéro de téléphone du destinataire: Il s'agit du numéro de destinataire du SMS
• Votre Nom d'expéditeur: Il s'agit de votre SenderID, ce dernier peut être créé sur la plateforme SMS
• Votre message: Le message que vous allez envoyé par SMS

 

Les codes erreurs possibles :

100 : Problème avec l'opérateur;
103 : Numéro de téléphone invalide;
105 : Utilisation d'un mot interdit;
106 : SenderID invalide ou non validé;
107 : Problème de typage SMS;
112 : Numéro blacklisté ou API non disponible;

 

 

Comment envoyer un SMS différé depuis l'API LWS

Envoyer un SMS par appel simple:

https://sms.lws.fr/sms/api?action=send-sms&api_key=SMS_API_KEY=&to=DESTINATAIRE&from=SenderID&sms=VOTRE_MESSAGE&schedule=DATE_HEURE

• SMS_API_KEY: Doit être remplacé par votre clé API
• DESTINATAIRE: Doit être remplacé par le numéro de destinataire du message
• SenderID: doit être remplacé par votre nom d'expéditeur
• VOTRE_MESSAGE: doit être remplacé par votre message
• DATE_HEURE: Doit être remplacé par la date et l'heure d'envoi. Vous pouvez convertir la date et l'heure en vous rendant sur le site Timestamp

 

 

Présentation des fonctions API LWS lié à la plateforme SMS

 

Conclusion

Vous êtes désormais en mesure de créer votre propre API par le biais de la plateforme SMS de LWS. Vous pouvez utiliser une API afin d'envoyer un SMS de façon instantanée mais aussi de manière différée. L'API vous permettra aussi de prendre connaissance du crédit restant sur votre compte.

N'hésitez pas à partager vos remarques et vos questions !

Vidéos

Présentation des fonctions API LWS lié à la plateforme SMS

 

Pour aller plus loin

Conclusion

Vous êtes désormais en mesure de créer votre propre API par le biais de la plateforme SMS de LWS. Vous pouvez utiliser une API afin d'envoyer un SMS de façon instantanée mais aussi de manière différée. L'API vous permettra aussi de prendre connaissance du crédit restant sur votre compte.

N'hésitez pas à partager vos remarques et vos questions !

comments powered by Disqus