Guide utilisation API envoi de SMS

De Decanet
Aller à : navigation, rechercher

Description de l'API

Adresse de l'API

L'API est accessible aux adresses :

Toutes les requêtes devront être envoyées en POST.

Identification

L'ensemble de vos requêtes devront posséder les variables d'identification obligatoires:

  • login : Adresse mail de votre compte client Decanet.fr
  • pass : Mot de passe de votre compte client Decanet.fr

Commande status

Requête

Pour récupérer le crédit de votre compte SMS Decanet.fr, vous devrez utiliser la commande status avec les variables suivantes:

  • action = "status" (requis)

Réponse

La réponse sera retournée au format json et contiendra la/les variable(s) suivante(s):

  • credit : (int) Crédit SMS restant sur votre compte Decanet.fr

Commande send

Requête

Il s'agit de la commande vous permettant d'envoyer un message. Vous devrez construire votre requête avec les variables suivantes:

  • action : "send" (requis)
  • recipient : (string) Numéro de téléphone du destinataire au format internationnal. Par exemple pour la France : 0033600000000 (requis)
  • text : (string) Message de votre SMS. Le message doit faire 160 caractères max. (requis si textencoded n'est pas défini)
  • textencoded : (string) Message de votre SMS encodé au format URL (urlencode). Conseillé si vous rencontrez des problèmes d'encodage. Le message décodé doit faire 160 caractères max. (requis si text n'est pas défini)
  • sendername : (string) Nom d'expéditeur pour le SMS. S'il est alphanumérique, il ne devra pas dépasser 11 caractères. (requis)
  • messagetruncationallowed : (int)0 si non, 1 si oui. Tronque le message à 160 caractères pour ne pas dépasser 1 SMS envoyé.
  • campaign : (int) Paramètre facultatif permettant d'attribuer un numéro d'identification à votre campagne d'envoi. Cela vous permettra par exemple de récupérer ultérieurement un rapport complet sur l'ensemble d'une campagne.
  • notify : (string,255 caractères max) URL à laquelle les rapports de livraison ou de demande de STOP SMS seront adressés.

Réponse

En cas d'échec

La réponse sera retournée au format json et contiendra un tableau avec les variables suivantes:

  • code = (int) 1
  • message = "Une erreur est survenue"
  • details : (string) Raison de l'erreur

En cas de réussite

  • code : (int) 0
  • message_id : (string) id unique de votre message
  • message = "Votre message a été envoyé"

Requêtes Notify

Les requêtes Notify sont envoyées par nos serveurs à l'URL que vous aurez configuré dans le paramètre notify de la requête send. Elle contient les informations de suivi de votre message envoyé. La requête est envoyée en POST et contient les variables suivantes:

  • msg_id: (string) Identifiant unique de votre message envoyé
  • state: (int) 2: Message envoyé, 3: Message livré, 4: Message refusé par l'opérateur, 6: Message non livré (téléphone éteint ou hors réseau jusqu'au timeout), 9: Stop SMS demandé
  • date: (datetime) Date de mise à jour du statut

Exemple PHP

function sendRequest($donnees) {
$url = 'https://www.decanet.fr/api/sms.php';
foreach($donnees as $key=>$value) { $donnees_ctn .= $key.'='.$value.'&'; }
rtrim($donnees_ctn,'&');
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch,CURLOPT_POST,count($donnees));
curl_setopt($ch,CURLOPT_POSTFIELDS,$donnees_ctn);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$data=curl_exec($ch);
curl_close($ch);
return json_decode($data);
}

$donnees = array(
'action'=>'status',
'login'=>'adresse@mail.com',
'pass'=>'motdepasse'
);

$result = sendRequest($donnees);

echo "Votre solde est restant de ".$result['credit']." SMS";