Avant de commencer

Avant de commencer, merci de lire les informations ci-dessous et de suivre toutes les instructions.
Vous pourrez ensuite passer à la section « pour commencer ».

---

Deux choses à faire avant de commencer

étape 1

Vous devez être membre de NesmaSms pour pouvoir utiliser l'API SMS. Si vous ne l'êtes pas déjà, devenez membre de NesmaSms Partner dès maintenant

étape 2

Une fois votre session ouverte sur le site de NesmaSms, accédez à l'API SMS, sous le menu UrlSMS et notez soigneusement votre clé d'accès à l'API.

---

Qu'est-ce que l'API SMS ?

L'API SMS vous permet de contrôler et de configurer tous les aspects de l'API SMS. Notamment…

votre clé d'accès à l'API	Vous devez utiliser la clé d'accès à l'API dans votre application pour permettre votre authentification sur notre plateforme API. L'API SMS vous permet de visualiser votre clé d'accès unique et de la réinitialiser si vous le souhaitez.
votre compte	Vous pouvez vérifier combien de crédits il vous reste sur votre compte, créditer votre compte.
votre historique	Vous pouvez voir tous les appels d'API effectués avec la date.

Pour commencer

Maintenant que vous avez lu la section « avant de commencer » et que l'API SMS vous est plus familière, vous êtes fin prêt à créer une application « hello world » et à découvrir les méthodes des API.

Une fois que vous maîtrisez bien cette section, jetez un coup d'œil à l' « exemple d'application » pour avoir une idée de la façon dont elles sont utilisées dans une application.

---

Créer et envoyer un SMS « hello world » (bonjour le monde)

Copiez et collez l'URL suivante dans votre navigateur Web : http://www.nesmasms.com/Sms-To-World/Api/Sendsms.aspx?key=[api access key]&mobile=[mobile number]&sms=[your text message]

Avant d'appuyer sur la touche entrée, remplacez les composants suivants de l'URL par vos propres valeurs :

• [api access key]- remplacez-la par votre propre clé d'accès à l'API
• [mobile number] - remplacez-le par le numéro du mobile de destination au format international. Par ex. : 0021612345678 (Tunisie)
• [your message]- remplacez-le par le message que vous souhaitez envoyer en utilisant « + » pour indiquer l'espace. Par ex. : « Bonjour+le+monde »

Votre URL devrait ressembler à ce qui suit :

http://www.nesmasms.com/Sms-To-World/Api/Sendsms.aspx? key=xyz123&mobile=0021612345678&sms=Hello+World

---

La méthode sendSMS en détail

La méthode sendSMS est une fonction simple vous permettant d'envoyer un SMS sur le réseau SMS via les requêtes Web HTTP GET ou HTTP POST.

Pour appeler l'API, vous devez créer le format d'URL suivant dans votre application Web et l'invoquer :

http://www.nesmasms.com/Sms-To-World/Api/Sendsms.aspx? key=[access key]&mobile=[mobile number]&sms=[your text message]

Paramètres d'entrée

nom	description	obligatoire / facultatif	type
key	C'est la clé d'accès à l'API qui se trouve dans l'API SMS.	obligatoire	string
mobile	C'est le numéro du mobile de destination au format international. ex. : 0012612345678 (Tunisie) ou un alias.	obligatoire	string
sms	Ceci est le contenu du SMS, limité à 160 caractères (keyword inclus).	obligatoire	string

*Vous devez utiliser le bon numéro dans le paramètre "mobile" suivant votre destination lorsque vous utilisez la méthode sendSMS.

Codes de statut de réponse

<?xml version="1.0" encoding="UTF-8" ?> <response>   <status>      <status_code>200</status_code>      <status_msg>ok</status_msg>   </status> </response>

Le tableau ci-dessous répertorie toutes les réponses possibles (codes et messages de statut) que la méthode sendSMS peut donner...

Code de Statut	Message de Statut
200	![CDATA[OK]]
400	absence d'id
401	id non autorisé
402	crédit insuffisant
430	contenu manquant
431	destination manquante
440	contenu trop long
441	destination non autorisée
500	erreur interne

Votre application doit fournir un code de statut HTTP 200.

---

exemple d'application

Vous trouverez ci-dessous des exemples d'applications utilisant les méthodes des API. Cela vous fournira un point de départ et vous aidera dans votre développement.

Exemple1 : FILE_GET_CONTENTS

Nous allons éffectuer une requete GET en utilisant la fonction file_get_contents() pour envoyer le SMS.
Le premier script correspond au code HTML du formulaire et le deuxieme permet de traiter les données de l'utilisateur et d'envoyer le SMS.

Formulaire HTML :

<form name="envoyersms" method="post" action="handler.php"> <label>Numero : <input type="text" name="number" />Message : <textarea name="message"></textarea> <input type="submit" name="envoyer" value="Envoyer" /> </form>

Formulaire PHP :(handler.php)

<?php function send($api, $number, $message) { $request = "&api=".urlencode($api)."&number=".urlencode($number); $request .= "&message=".urlencode($message); $r=file_get_contents("http://www.nesmasms.com/Sms-To-World/Api/Sendsms.aspx?".$request);    return $r; } );               if (!empty($_POST['envoyer'])) { $api = ""; # votre API       echo $responses[$r]; } ?>

Pour plus d'exemple consulter votre espace personnel