plateforme sAAs d'envoi de sms d o c u m e n t a t i o n t e c h n i q u e API

plateforme sAAs d'envoi de sms d o c u m e n t a t i o n t e c h n i q u e API HTTP 12/05/2015 à 13:50 Bonjour. Votre commande ref : 123456 est à votre disposition à votre point relais 10 rue d’Amiens, 75002 Paris. Venez muni(e) d’une pièce d’identité. GANT Version 3.1 - Mise à jour : 19 novembre 2018 DOCUMENTATION TECHNIQUE API HTTP 2 WWW PLATEFORME SMSMODE VOTRE APPLICATION CoUts • Frais de mise en place : aucun. •  Frais d’utilisation : le prix des SMS envoyés. PrE-Requis • Ouvrir un compte sur sMsmode • Acheter des crédits •  Intégrer les requêtes HTTP à votre application EXEMPLES D'Applications •  Intégration d’un module SMS dans un progiciel de caisse •  SMS d’alerte automatique de serveur “down” ou “up”, etc. qu'est-ce que l'api HTTP ? sMsmode vous fournit une API pour réaliser des envois automatisés de SMS à intégrer dans vos applications. Cette API expose les méthodes suivantes : envoi immédiat ou programmé de SMS gestion des réponses historique des SMS suppression de SMS solde du compte création de sous-comptes transfert de crédits de compte à compte ajout de contact récupération des compte-rendus de réception notification automatique de la mise à jour des comptes-rendus de réception DOCUMENTATION TECHNIQUE API HTTP 3 1 Réglages de compte..................................................... 4 2 Authentification. .................................................................... 5 URL de base....................................................................................5 Paramètres d’authentification.....................................5 Répo nse................................................................................................5 3 Envoi de SMS. ........................................................................... 6 URL de base....................................................................................6 Paramètres d’authentification.....................................6 Paramètres obligatoires.....................................................6 Paramètres optionnels. ........................................................7 Répo nse................................................................................................7 Caractères et encodage....................................................7 Paramètres STOP SMS. ....................................................9 4 Compte-rendu de réception. ............................ 10 URL de base................................................................................10 Paramètres d’authentification.................................10 Paramètres obligatoires.................................................10 Réponse............................................................................................10 5 Solde du compte................................................................. 12 URL de base................................................................................12 Paramètres d’authentification.................................12 Réponse............................................................................................12 6 Création de sous-compte.................................... 13 URL de base................................................................................13 Paramètres d’authentification.................................13 Paramètres obligatoires.................................................13 Réponse............................................................................................14 Suppression de sous-compte.................................14 7 Transfert de crédit de compte à compte..................................................... 15 URL de base................................................................................15 Paramètres d’authentification.................................15 Paramètre obligatoire.......................................................15 Paramètre optionnel...........................................................15 Réponse............................................................................................15 8 Ajout de contact................................................................... 16 URL de base................................................................................16 Paramètres d’authentification.................................16 Paramètres obligatoires.................................................16 Paramètres optionnels. ....................................................16 Réponse............................................................................................16 9 Suppression de SMS................................................... 17 URL de base................................................................................17 Paramètres d’authentification.................................17 Paramètres obligatoires.................................................17 Réponse............................................................................................17 10 Liste des SMS envoyés........................................... 18 URL de base................................................................................18 Paramètres d’authentification.................................18 Paramètre optionnel...........................................................18 Réponse............................................................................................18 11 Récupération du statut du SMS................ 19 URL de base................................................................................19 Paramètres d’authentification.................................19 Paramètre obligatoire.......................................................19 Réponse............................................................................................19 12 Notification de compte-rendu automatique................................................................................ 21 Réponse..............................................................................................................................21 Paramètres retournés par sMsmode..................21 13 Envoi de SMS avec réponse autorisée et notification......................................... 22 Paramètres...................................................................................................................22 14 Récupération des SMS réponses. .......... 23 URL de base................................................................................23 Paramètres d’authentification.................................23 Paramètres optionnels. ....................................................23 Réponse............................................................................................24 15 Envoi de SMS voix (ou SMS vocal)..... 25 URL de base................................................................................25 Paramètres d’authentification.................................25 Paramètres obligatoires.................................................25 Paramètres optionnels. ....................................................25 Réponse............................................................................................26 16 Envoi de SMS Unicode............................................. 27 Caractéristiques des SMS unicode et décompte des caractères.....................................27 URL de base................................................................................27 Paramètres d’authentification.................................28 Paramètres obligatoires.................................................28 Paramètres optionnels. ....................................................28 17 Envoi de SMS en mode batch (fichier joint)............................................................................... 29 URL de base................................................................................29 Paramètres d’authentification.................................29 Paramètres optionnels. ....................................................29 Réponse............................................................................................30 Caractères et encodage................................................30 Exemple Curl...............................................................................30 Fichier joint.....................................................................................30 Annexe : Liste récapitulative des statuts des SMS retournés. ........................................... 31 table des matieres DOCUMENTATION TECHNIQUE API HTTP 4 Les envois de SMS sont réalisés via deux canaux distincts, sur le canal SMS marketing ou sur le canal SMS notifications en fonction du type de SMS que vous envoyez. Par défaut et sans précision de votre part, tous les envois sont réalisés sur le canal marketing (cf. caractéristiques et limitations ci-dessous). Contactez nos commerciaux au 04 91 05 64 62 pour toute information et paramétrage de votre compte. ATTENTION : sMsmode ne peut être tenu responsable des blocages ou changements d’émetteurs potentiels des SMS par les opérateurs français, issus d’un compte mal paramétré. Canal SMS Marketing Le canal marketing peut être utilisé pour tout type de communication (à caractère commercial ou non). Si l’émetteur est personnalisé, la présence de la mention « STOP numéro » est obligatoire. Sans le « STOP numéro », le SMS peut être bloqué par les opérateurs (notamment Free) ou l’émetteur personnalisé peut être remplacé par un shortcode. Information : la mention STOP prend la forme du texte « STOP » suivi du shortcode (numéro court - par exemple 36034). L’utilisation du paramètre STOP (cf. page 8) vous permet d’être assuré de respecter les exigences des opérateurs et de la CNIL (la réglementation de la CNIL stipule qu’il est obligatoire de proposer un moyen de désinscription pour toute campagne à caractère commercial). Si l’émetteur n’est pas personnalisé, la présence de la mention « STOP numéro » n’est pas obligatoire, mais fortement recommandée. L’envoi de SMS sur ce canal bénéficie d’une priorité inférieure à celui de notifications. Des délais dans la livraison peuvent se produire. Quelques exemples d’utilisation : SMS de publicité, soldes, promotions diverses, SMS de prospection, etc. Canal SMS Notifications Le canal de notifications est utilisé pour de la communication à caractère non commercial uniquement. L’émetteur peut être personnalisé. La présence d’un STOP n’est pas nécessaire. L’envoi d’un SMS à caractère commercial sur ce canal est bloqué et peut-être soumis à des sanctions financières (voir nos CGU). Les envois sont effectués en haute priorité et en haute performance. Quelques exemples d’utilisation : Confirmation ou rappel de rendez-vous, confirmation d’achat ou de livraison, SMS d’alerte informatif, relance facturation, notifications diverses, OTP (One Time Password), etc. reglageS de compte 1 DOCUMENTATION TECHNIQUE API HTTP 5 L’interface HTTP prévoit comme façon pour s’identifier à l’API une clé API d’authentification. Cette solution vous permet également d’être en règle avec le RGPD. La clé API est à générer au préalable soit par un appel à la requête de création de clé API, soit directement dans son compte personnel sMsmode. METHODE 1 : Creation d'une cle api via le compte smsmode Se rendre dans la rubrique “Mes données personnelles” > “Clé d’accès API” afin de gérer les clés API. Important : cette méthode est obligatoire lors de la création de la première clé API d’un compte. METHODE 2 : Creation d'une cle api via UNE requete URL DE BASE https://api.smsmode.com/http/2.0/createAuthorisation.do Exemple de requête https://api.smsmode.com/http/2.0/createAuthorisation.do?accessToken=Ab1CD2efg3Hi ParametreS d'authentification Paramètre Description accessToken Clé API à utiliser pour identifier votre compte reponse (au format JSON) Paramètre Description id Identifiant du token accessToken Chaîne de 32 caractères servant d’authentification creationDate Date de création state État du compte expiration Délai d’expiration account Nom du compte lié au token AUTHENTIFICATION 2 DOCUMENTATION TECHNIQUE API HTTP 6 L’interface HTTP permet d’automatiser l’envoi de SMS vers un ou plusieurs destinataires. Ces messages peuvent être envoyés immédiatement ou programmés. Bien que le mode HTTP soit supporté, il est fortement conseillé pour des raisons de sécurité d’utiliser le mode HTTPS. Les méthodes HTTP GET et POST sont supportées, mais seule la méthode POST permet l’envoi de SMS à plus de 300 destinataires en une seule requête. URL DE BASE https://api.smsmode.com/http/1.6/sendSMS.do Exemple de requête https://api.smsmode.com/http/1.6/sendSMS.do?accessToken=Ab1CD2efg3Hi&message= Bonjour+Maman&numero=3363123456,0623123457 https://api.smsmode.com/http/1.6/sendSMS.do?accessToken=Ab1CD2efg3Hi&message=Bon+ anniversaire&numero=3363123456&date_envoi=21122005-14:35 ParametreS d'authentification Paramètre Description accessToken Clé d’accès à utiliser pour identifier votre compte (cf. item 2). PARAMETRES OBLIGATOIRES Paramètre Description message Message du SMS à envoyer. Nombre maximal de caractères pour 1 SMS=160  Pour un texte avec plus de 160 caractères, se reporter aux paramètres optionnels ci-dessous numero (ou groupe) Liste de numéros séparés par une virgule. Ces numéros peuvent être sous le format national (06xxxxxxxx - uniquement accepté pour la France) ou international (336xxxxxxxx)   Limité à 300 destinataires en HTTP GET groupe (ou numero) Nom du groupe contenant les numéros destinataires, préalablement créé sur le compte sMsmode Envoi de sms 3 DOCUMENTATION TECHNIQUE API HTTP 7 PARAMETRES OPTIONNELs Paramètre Description classe_msg • 2 : SMS Pro (par défaut) • 4 : SMS avec réponse autorisée date_envoi Date d’envoi du message (format : ddMMyyyy-HH:mm) refClient Donnée client optionnelle renvoyée lors de la notification automatique de compte-rendu. Peut être utilisée pour “taguer” la requête avec votre propre identifiant emetteur Texte à utiliser pour personnaliser l’émetteur du SMS   Numéro de téléphone non autorisé   Maximum 11 caractères, sans d’accent ni d’espace. Fonctionnalité ne pouvant être utilisée si classe_msg=4 nbr_msg Nombre maximum de message (valeur par défaut 5).   Le message sera coupé s’il dépasse cette limite. Selon le nombre de caractères souhaités, indiquez le nombre de messages à envoyer comme suit :   • nbr_msg=1 : 160 caractères maximum    • nbr_msg=2 : 306 caractères maximum • nbr_msg=3 : 459 caractères maximum notification_url URL de réception de la notification de compte-rendu du SMS (cf. item 12) notification_ url_reponse URL de réception de la notification des SMS entrants (cf. item 12) REPONSE La réponse à une requête d’envoi HTTP est de la forme : code_retour | description | smsID (présent si code retour 0). code retour Description 0 Accepté - le message a été accepté par le système et est en cours de traitement 31 Erreur interne 32 Erreur d’authentification 33 Crédits insuffisants 35 Paramètre obligatoire manquant 50 Temporairement inaccessible CaractEres et encodage Seul un certain nombre de caractères sont gérés pour l’envoi de SMS (spécifications GSM 03.38). Si vous spécifiez un caractère qui n’est pas présent dans la liste, celui ci sera remplacé par “?”. L’encodage utilisé est celui uploads/s3/ fiche-api-http.pdf

Tags
Administrationparamètre description compte erreur message
Documents similaires
  • 27
  • 0
  • 0
Afficher les détails des licences
Licence et utilisation
Gratuit pour un usage personnel Attribution requise
Partager