INTRODUCTION PRÉREQUIS

Transcription

1 MY SMART COMPANY Utilisation de l'api SMS

2 INTRODUCTION L'API vous permet d'envoyer des SMS avec vos logiciels, votre site internet, etc. My Smart Company fournissant les SMS aux meilleurs prix du marché il devient un allié incontournable afin de réaliser vos campagnes! Confirmation d'inscription, confirmation de paiement, campagnes marketing, informations, etc. Tout est possible pour vous permettre de rester en contact avec votre clientèle. PRÉREQUIS Avoir un compte SMS chez MySmartCompany.be Pour se faire veuillez envoyer un mail à en y indiquant les informations suivantes : - Nom - Prénom - Nom de la société / ASBL / organisation / etc - Numéro de TVA si vous en avez un - Adresse postale - Le login que vous souhaiteriez et le mot de passe. Si rien ne nous est indiqué, nous génèrerons un mot de passe aléatoire. - Rechargez le compte en SMS en choisissant votre plan tarifaire.

3 INTEGRATION Toutes les requêtes doivent être envoyées en POST. Voici la liste des paramètres disponibles. Nom Type Définition token Obligatoire Clé d'identification. (Voir FAQ Question 1) phones Obligatoire Liste des numéros au format international. ["0032*********","0032*********"]. message Obligatoire Votre message a envoyer. Attention si votre message est vide, votre SMS sera envoyé sans générer d'erreur. /!\ Certains caractères spéciaux (non utf-8) vont diminuer le nombre de caractères disponibles dans votre message. (Voir FAQ Question 2) delayed Optionnel Permet d'envoyer un SMS a une date et heure donnée. La date est attendue au format suivant : YYYYmmddHHii Exemple : Sera envoyé le 1er février 2016 à 09h00 Vous pouvez laisser ce champ vide ou ne pas le spécifier si vous souhaitez que le message soit traité immédiatement. Si la date spécifiée est antérieur à la date du jour, le message sera traité immédiatement. Cette requête POST doit être envoyée via l'url :

4 Exemple d'utilisation : C# var request = (HttpWebRequest)WebRequest.Create(" e/sms/api/send"); var postdata = "message=hello world"; postdata += "&token=li3seuoncs2ci1p0fwo04c"; postdata += "&phones=[\" \",\" \"]"; postdata += "&delayed= "; var data = Encoding.ASCII.GetBytes(postData); request.method = "POST"; request.contenttype = "application/x-www-form-urlencoded"; request.contentlength = data.length; using (var stream = request.getrequeststream()) { stream.write(data, 0, data.length); } var response = (HttpWebResponse)request.GetResponse(); var responsestring = new StreamReader(response.GetResponseStream()).ReadToEnd();

5 Java String url = " URL obj = new URL(url); HttpsURLConnection con = (HttpsURLConnection) obj.openconnection(); //add request header con.setrequestmethod("post"); con.setrequestproperty("user-agent", USER_AGENT); con.setrequestproperty("accept-language", "en-us,en;q=0.5"); String urlparameters = "message=hello world"; urlparameters += "&token=li3seuoncs2ci1p0fwo04c"; urlparameters += "&phones=[\" \",\" \"]"; urlparameters += "&delayed= "; // Send post request con.setdooutput(true); DataOutputStream wr = new DataOutputStream(con.getOutputStream()); wr.writebytes(urlparameters); wr.flush(); wr.close(); int responsecode = con.getresponsecode(); System.out.println("\nSending 'POST' request to URL : " + url); System.out.println("Post parameters : " + urlparameters); System.out.println("Response Code : " + responsecode); BufferedReader in = new BufferedReader( new InputStreamReader(con.getInputStream())); String inputline; StringBuffer response = new StringBuffer(); while ((inputline = in.readline())!= null) { response.append(inputline); } in.close(); //print result System.out.println(response.toString());

6 PHP-curl $c = curl_init(); curl_setopt($c, CURLOPT_URL, " curl_setopt($c, CURLOPT_POST, 3); curl_setopt($c, CURLOPT_POSTFIELDS, http_build_query(array( 'token' => ' Li3sEuonCs2Ci1P0Fwo04C ', 'phones' => '[" "," "]', 'message' => 'Hello world' ))); curl_setopt($c, CURLOPT_RETURNTRANSFER, true); $server_output = curl_exec($c); curl_close($c); $result = json_decode($server_output); // Code erreur $result->code;

7 LES REPONSES DE L API Code erreur Description 100 OK 200 Token invalide 201 Pas assez de crédit 300 Numéro de téléphone invalide 301 Le numéro de téléphone xxxxxxxxxxxxxx est invalide 400 Le message est invalide

8 Requête de crédit restant. Toutes les requêtes doivent être envoyées en POST. Voici la liste des paramètres disponibles. Nom Type Définition token Obligatoire Clé d'identification. (Voir FAQ Question 1) Cette requête POST doit être envoyée via l'url :

9 Exemple d'utilisation : $c = curl_init(); PHP curl_setopt($c, CURLOPT_URL, " curl_setopt($c, CURLOPT_POST, 1); curl_setopt($c, CURLOPT_POSTFIELDS, http_build_query(array('token' => ' Li3sEuonCs2Ci1P0Fwo04C '))); curl_setopt($c, CURLOPT_RETURNTRANSFER, true); $server_output = curl_exec($c); curl_close($c); $result = json_decode($server_output); // Code erreur $result->code; // Sms restant $result->credit;

10 LES REPONSES DE LA REQUETE CREDIT RESTANT Code erreur Description 100 OK 200 Token invalide

11 FAQ 1. Où trouver mon token? Rendez-vous sur et identifiez-vous avec votre login et mot de passe. Cliquez sur "Société" et vous trouverez votre token en dessous du nom de la société. Ce token peut contenir des lettres minuscules et majuscules, des chiffres ainsi que des caractères spéciaux. 2. Combien de caractères peut-on mettre dans un sms? De base vos SMS comptent 160 caractères pour un message. Cependant, si vous utilisez dans vos messages des caractères non utf-8 votre SMS ne comptera alors que 70 caractères par message. Voici la liste des caractères utf-8 : ['A', 'a', 'à ', 'B', 'b', 'C', 'c', 'D', 'd', 'E', 'e', 'F', 'f', 'G', 'g', 'H', 'h', 'I', 'i', 'J', 'j', 'K', 'k', 'L', 'l', 'M', 'm', 'N', 'n', 'O', 'o', 'P', 'p', 'Q', 'q', 'R', 'r', 'S', 's', 'T', 't', 'U', 'u', 'V', 'v', 'W', 'w', 'X', 'x', 'Y', 'y', 'Z', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', ' ', '.', ',', '-', '_', '!', '\n', '"', '@', 'â ', '%', '#', '&', '\'', '/', '(', ')', '[', ']', '{', '}', '*', ':', '=', '+', ';', '<', '>', '?', ' ', 'à ', 'à ', 'à ', 'à ', 'à ', 'à ', 'à ', 'à ', 'ò', 'à ', 'Ãœ', 'ü', 'à ', 'à ', 'à ', 'à ','ù', 'Î ', ' ', ' ', '$', 'Î ', ' ', 'Î ', 'Î ', ' ', 'Î ', 'Î ', 'Î ', 'Î ', 'à ', 'Ξ', 'à ', 'à ', 'ñ', 'ß', ' ', '^', '~']

12 3. Comment puis-je réaliser mes tests? Afin de réaliser vos tests correctement, MySmartCompany vous offre 10 SMS. Il vous est alors possible de vérifier que votre intégration c'est bien déroulée. 4. Comment spécifier plusieurs numéros de téléphone dans la requête? Dans le paramètre phones, il vous est possible de spécifier un ou plusieurs numéro de téléphone au format international. Un seul numéro : [" "] Plusieurs numéros (séparé par une virgule) : [" "," "," "]