API SMS
15084
page-template-default,page,page-id-15084,bridge-core-2.2,ajax_fade,page_not_loaded,,qode-title-hidden,qode-child-theme-ver-1.0.0,qode-theme-ver-20.7,qode-theme-bridge,qode_header_in_grid,wpb-js-composer js-comp-ver-6.1,vc_responsive

API SMS

Envoyer vos SMS automatiquement depuis votre application

 

 

Vous voulez envoyer des codes de validation aux clients afin qu’ils puissent confirmer leur inscription à votre service  ?

 

Vous voulez que vos clients soient informés lorsque leur colis est prêt pour la livraison ?

 

Vous voulez garder le contact avec vos clients  en envoyant les dernières nouvelles au sujet de votre service ?

 

Avec notre API SMS, vous pouvez maintenant envoyer des SMS automatique de votre service numérique à tous clients du réseau d’Orange et de non-Orange au Sénégal. Le service est facile à intégrer et vous pouvez l’utiliser pour toute une gamme d’activités marketing et de service à la clientèle.

 

 

 

 

 

 

 

 

Integrez l’API en quelques minutes

 

Notre API SMS est facile à intégrer dans votre service numérique car il est basé sur les normes de l’industrie.

 

Vous avez juste besoin de :

 

Inscrire votre application (sélectionnez « utiliser l’API »)

 

Choisir le SMS bundle vous avez besoin

 

Configurer votre service avec la clé API que vous avez reçu

 

Des règles établies en fonction de vos besoins (votre logique d’envoi de SMS), par exemple pour envoyer des codes de validation

 

Utlisez une SIM Orange pour acheter vos SMS

Orange souhaite que chaque développeur soit en mesure d’utiliser l’API SMS. Vous n’êtes pas obligé d’avoir un compte bancaire ou une carte de crédit pour acheter nos SMS: il suffit d’utiliser une carte SIM Orange.

Le prix des SMS est déduit de votre compte prépayé ou postpayé.

 

Testez l’API SMS avec le pack SMS de bienvenue : 25 SMS pour 25 F CFA.

 

Nous offrons des paquets de 100 à 5000 SMS à des prix préférentiels.

 

Le service est limité à un achat 100.000 F CFA par jour et par carte SIM. Si vous avez besoin d’envoyer des volumes plus élevés, ou une solution plus personnalisée d’envoi de SMS, veuillez contacter notre l’équipe commerciale d’Orange par e-mail à l’adresse support.apis@orange-sonatel.com.

1. choisissez « sms sénégal »

Connectez-vous sur developer.orange.com, créer un compte et choississez SMS SENEGAL …

 

 

 

2. Acceptez les conditions d’utilisation

Vous devez accepter les conditions générales d’utilisation des API d’Orange et les termes spécifiques de l’API SMS pour continuer…

 

 

 

3. Déclarez votre application

Remplissez une courte description du projet dans lequel vous allez utiliser l’API pour accéder à votre clé …

 

 

 

4. Envoyez vos documents d’identification

Afin que Orange valide votre demande d’accès à l’API SMS, vous devez envoyez vos document d’identification …

 

 

 

5. Utilisez votre clé API et achetez vos SMS

Vous disposez d’une clé API qui va être intégrée dans votre code, maintenant acheter vos SMS avec une carte SIM Orange.

CONDITIONS SPÉCIFIQUES DU SERVICE API SMS

Description du Service SMS API (le « Service »). Le Service permet à tout Client, abonné prépayé ou postpayé de Sonatel Mobiles (le « Client»), d’acquérir des lots de SMS sur le site www.orangepartner.com (le « Site ») avec son crédit téléphonique, et d’envoyer, à partir de son application/service (« API Client »), des SMS à destination d’abonnés Sonatel Mobiles ou d’autres opérateurs. Le Client doit donc être raccordé au réseau internet, et il déclare expressément en faire son affaire personnelle.Le Client doit détenir légitimement les numéros de téléphone des destinataires des SMS, notamment dans le cadre de relations contractuelles préexistantes ou d’activités caritatives ou associatives.

Création d’un compte Orange Partner. Le Client, pour pouvoir acquérir et envoyer des SMS sur le site Orange Partner, doit créer un compte. Pour créer un compte, le Client doit fournir ses informations personnelles (prénom, nom, email, adresse, pays, activité) et éventuellement les informations de l’entreprise (nom entreprise, activité entreprise) s’il souscrit au nom de celle-ci.

Souscription à l’API SMS du Sénégal: Le client pour pouvoir accéder à l’API SMS et envoyer des SMS, il doit souscrire à l’API SMS Sénégal. Pour souscrire il doit être titulaire d’une SIM prépayé régulièrement identifiée auprès de Sonatel Mobiles. Sa demande est rejetée s’il n’y a pas de correspondance entre les éléments d’identification figurant sur le système d’information de Sonatel Mobiles et ceux figurant sur les pièces d’identité remises par le Client; fournir une pièce d’identité en cours de validité (CNI ou passeport pour les personnes physiques et Registre de Commerce ou document équivalent pour les personnes morales).Sonatel effectuera une vérification de la régularité de tous les documents exigés ci-dessus avant de valider la souscription à l’API SMS. Dans le cas où une seule des conditions fixées ci-dessus n’est pas remplie, Sonatel pourra rejeter la demande de souscription du Client sans que sa responsabilité ne puisse être engagée.

Contenu des SMS MT (Mobile Terminated). Les SMS contiennent des informations relatives au Client, et/ou à ses activités, et/ou à ses produits et services, et/ou rentrant dans le cadre de ses relations contractuelles avec les destinataires (statistiques, relances commerciales, etc.), lesdites informations ayant été développées et stockées par le Client.

Autorisation des destinataires. Le Service n’est pas un service de spamming, le Client déclarant, sous son entière responsabilité, avoir été autorisé par les destinataires à leur envoyer les SMS visés au paragraphe 3.

Envoi de SMS. Pour envoyer des SMS, le Client rentre le(s) code(s) privé(s) fourni(s) par Orange Partner dans son application/service, et envoi des SMS aux numéros mobiles destinataires, selon le nombre et les modalités requis, dans la limite des fonctionnalités de l’offre et en fonction de la disponibilité des réseaux des opérateurs tiers. Le nombre de SMS acquis par le Client est diminué du nombre de SMS envoyés.

Réception des SMS. Le destinataire d’un SMS ne peut le recevoir que si :

il dispose d’un terminal mobile compatibles SMS ;

son terminal est sous tension et que la mémoire de SMS n’est pas saturée ;

son terminal se situe dans une zone de couverture du réseau de son opérateur.

Validité des SMS. Les prix et la durée de validité des lots de SMS à compter de la date d’acquisition, sont fixés comme suit :

 LOTS     PRIX VALIDITE
100 SMS 2 000 F CFA 1 mois
500 SMS 7 500 F CFA 3 mois
1 000 SMS 12 000 F CFA 6 mois
5 000 SMS 50 000 F CFA illimitée

Les SMS non consommés dans ce délai ne sont pas annulés, mais sont inutilisables jusqu’à un autre achat. Les SMS nouvellement acquis seront alors majorés des SMS non consommés, avec une nouvelle date de validité.

Le service permet à tout client de recharger un maximum de 5 000 SMS par jour.

Confidentialité du(des) code(s) privé(s). Le Client est seul responsable de la conservation et de l’utilisation du(des) code(s) privé(s) communiqué(s) par Orange Partner. Il prend toutes les précautions nécessaires pour en sauvegarder la confidentialité et s’assure de sa déconnexion du Site à l’issue de chaque session.

Utilisation des SMS. Sonatel n’a aucune connaissance ni aucun accès au contenu des SMS conçus et émis par le Client dans le cadre du Service. Le Client en est seul responsable. A ce titre, il déclare et garantit notamment à Sonatel que :

il est propriétaire et/ou peut librement disposer de l »intégralité des droits afférents au contenu des SMS qui seront diffusés via le Service ;

il n’utilisera pas les SMS acquis sur le site Orange Partner pour adresser des messages commerciaux et/ou promotionnels à toute personne qui n’aurait pas préalablement et expressément donné son consentement à cet effet, sauf dans les cas permis par la loi ;

il n’utilisera pas les SMS acquis sur le site Orange Partner pour organiser des jeux d’argent illicites en ligne (jeux de hasard, loterie illicite, publicité de loterie prohibée, prise de paris illicite) ;

les SMS ne portent pas atteinte à la personne, à la dignité humaine, à la vie privée ou à la propriété intellectuelle de tiers (notamment par reproduction ou représentation d’œuvres de l’esprit sans l’autorisation de leurs auteurs ou ayants droit), aux bonnes mœurs, à l’ordre public, à la sécurité ou à la défense nationale ;

les SMS n’encouragent pas la consommation ou la fabrication de substances et produits interdits ;

le contenu des SMS n’est pas mensonger, obscène, pornographique, diffamatoire, injurieux, raciste, xénophobe ou n’incite pas à la discrimination ;

le contenu des SMS n’est pas susceptible de porter atteinte de quelque manière que ce soit à Sonatel, notamment à son image, ses intérêts commerciaux ;

le contenu des SMS n’est pas susceptible de mettre en jeu la responsabilité (y compris pénale) de Sonatel, de quelque manière que ce soit.Le Client ne pourra faire qu’une utilisation personnelle et privée des SMS acquis.Le Client s’engage à signer personnellement tous ses SMS, de sorte à être clairement identifié comme émetteur par les destinataires, et à ne faire aucune référence à Sonatel dans ceux-ci.Il appartient au Client de vérifier la validité des numéros de mobile vers lesquels il envoie des SMS. En cas d’erreur, notamment d’erreur de manipulation, d’indication de faux numéros, de numéros erronés ou incomplets, de numéros d’appel non affectés à des abonnés, la responsabilité de Sonatel ne pourra être engagée et aucun SMS ne sera re-crédité sur le compte du Client.

Responsabilité. Le Client est pleinement responsable de (i) toute utilisation du Service avec son (ses) code(s) privé(s), tant à l’égard de Sonatel que des tiers ; (ii) toutes conséquences du non-respect de son obligation de confidentialité telle que définie à l’article 8.Le Client s’engage à respecter toutes les dispositions légales et règlementaires lui permettant d’envoyer des SMS vers les destinataires notamment la loi 2008-12 du 25 janvier 2008 relative à la protection des données personnelles au Sénégal.Le Client garantit Sonatel et l »indemnisera de toute réclamation et/ou recours de tous tiers, fondé et/ou trouvant sa cause dans une violation par le Client de ses obligations en vertu du présent contrat et, de manière plus générale, en cas de violation des dispositions législatives et réglementaires en vigueur.Sonatel n’assure que la transmission par son SMS-C des SMS émis par le Client. Le Client reconnaît et accepte que l’exécution des présentes dépend dans une large mesure de tiers, et en particulier d’autres opérateurs de téléphonie mobile et des fournisseurs d’accès internet. Il en résulte que la responsabilité de Sonatel ne peut être engagée en cas de difficultés liées directement et/ou indirectement au raccordement du Client au réseau internet, telles que notamment toutes difficultés d’utilisation et/ou indisponibilité du réseau internet, ou en cas de défaillance des opérateurs tiers.La responsabilité de Sonatel à l’égard du Client, pour autant qu’elle ait été prouvée devant la juridiction compétente, est expressément limitée, toutes demandes confondues, à une somme égale aux montants cumulés des SMS acquis au cours des six (6) mois précédant le ou les faits dommageables. La présente limitation de responsabilité ne  saurait trouver application si elle est écartée en application de la loi et en cas de vol.

Portée des conditions spécifiques. Les présentes conditions spécifiques complètent les conditions générales disponibles sur le site orangepartner.com et constituent avec celles-ci le contrat liant Sonatel au Client (le « Contrat»). Toutefois, en cas de contradiction entre les conditions générales et les présentes conditions spécifiques, les conditions spécifiques prévaudront.

Droit applicable – Litiges. Le Contrat est régi par le droit sénégalais. Tout litige né du Contrat ou en relation avec celui-ci, sera soumis par la partie la plus diligence au Tribunal de Grande Instance de Dakar.

 

Démarrer avec l’API SMS

Ce document décrit les étapes détaillées afin que vous puissiez envoyer des SMS et accéder à votre compte, à travers les API d »Orange.

La documentation technique complète des API est disponible en 2 parties :

Envoi de SMS, qui permet d »envoyer 1 SMS à 1 destinataire (https://www.orangepartner.com/content /api-reference-messaging-sms)

Admin SMS, qui permet d »accéder aux informations de son compte (https://www.orangepartner.com /content/api-reference-admin-sms)

Terminologie:

client: l »application qui va faire l »appel aux API d »Orange

endpoint: l »url d »accès afin d »appeler une fonction de l »API

header: un en-tête HTTP contenant une information nécessaire afin de faire une requête REST

 

 

A propos

Afin de pouvoir envoyer des requêtes sur les API d »Orange, vous avez besoin d »identifier votre application auprès de notre plateforme technique qui vous autorisera alors à accéder aux API SMS. Vous obtiendrez ces identifiants quand vous vous enregistrerez sur le portail d »Orange Partner : https://www.orangepartner.com

Une fois votre enregistrement effectué et votre application créée, vous obtiendrez :

Un « Client Id » : un identifiant unique fournit par la plateforme Orange

Un « client secret » : utilisé pour signer/crypter la requête et qui doit être partagé par le client et le serveur.

Dans les exemples de code ci-dessous, et si vous n »êtes pas familié avec CURL, le paramètre « -H » indique un Header (en-tête http) et « -d » correspond au corps de la requête.

Si vous avez des problèmes de connectivité en utilisant CURL, merci d »utiliser le paramètre « -1″ afin de forcer l »utilisation SSL/TLSv1 pour sécuriser la connexion HTTP.

 

Utilisez les API

Les API d »Orange requièrent une authentification, basée sur les standards (oAuth 2.0) au format REST, afin que vous n »ayez aucune difficulté à créer les requêtes.

Cela consiste à des requêtes HTTP (GET, POST, etc.) utilisant la norme SSL, avec des paramètres en en-tête pour sécuriser les appels. Si vous n »êtes pas familié avec REST, n »hésitez pas à vous documenter sur le sujet : wikipedia (http://fr.wikipedia.org/wiki/Representational_State_Transfer) ou des tutoriaux tel que http://code.tutsplus.com/tutorials/a-beginners-guide-to-http-and-rest–net-16340 .

 

Obtenir un token

Vous devez générer un token valide afin d »appeler les API SMS. Pour cette action, vous devez utiliser la méthode POST sur le endpoint /oauth/v2/token :

Comme le montre l »exemple ci-dessus, vous devez utiliser l »Authentification Basic, via le header « Authorization », avec le mot clé « Basic », suivi par un espace et de l »encodage en base64 de la concaténation de votre client_id, « : » et de votre client_secret. Dans un pseudo code, vous devriez avoir quelque chose comme :

Si la méthode POST retourne un succès, le corps de la réponses au format JSON, doit être similaire à :

Félicitation! vous avez maintenant un token qui vous permettra d »accéder à tous les API SMS. Celle-ci est stockée dans la valeur associée à « access_token ». Ce token sera valide pendant le nombre de secondes retournées dans la clé « expires_in » (à noter que 7776000 secondes équivaut à 90 jours).

 

Maintenant, amusons-nous avec les API SMS !

Vous êtes maintenant paré à utiliser les APIs SMS. Commençons par l »API qui envoir les SMS, puis nous verrons comment utiliser les 3 API d »adminitration qui vous donneront accès à votre comte.

Ne pas oublier de renseigner l »en-tête HTTP « Authorization », avec comme valeur, la concaténation de « Bearer  » et tu token que vous avez obtenu.

 

Envoi de SMS

Afin d »envoyer des SMS depuis notre API, vous devez tout d »abord acheter un bundle de SMS. Afin de faciliter l »intégration de l »API, vous avez la possiblité d »acheter un bundle « starter ». Veuillez noter que ce bundle « starter » ne peut être acheté qu »une fois par compte Orange Partner et également qu »une fois par moyen de paiement. Depuis votre application, vous n »avez besoin que de quelques lignes de codes pour envoyer des SMS à vos clients. Pour ceci, veuillez utiliser le token que vous venez de générer dans l »en-tête « Autorization » et accédez au endpoint suivant /smsmessaging/v1/outbound/{senderAddress}/requests, comme ceci :

Quelques points importants si vous voulez envoyer avec succès des SMS :

La valeur du paramètre « SenderAddress » dans le endpoint {senderAddress} et dans le body JSON doit être identique

Ne pas oublier l »en-tête « Content-Type: application/json »

La valeur du {senderAddress} dans le endpoint doit être encodé : « tel:+22100000000 » doit être « tel:+22100000000″

Ne pas oubliez d »acheter un bundle de SMS depuis le bouton « Configure » depuis l »application dans le menu « Dashboard »

Veuillez également noter que, sur le téléphone de votre destinataire, sera affiché un expéditeur qui sera généré par notre API SMS. Cet expéditeur est lié à votre compte Orange Partner. Cette requête retourne des données en en-tête et dans le corps de la réponse au format JSON comme quoi le SMS a bien été expédié ; sinon vous obtiendrez un message d »erreur avec une description de l »erreur dans le JSON.

 

Afficher votre nombre de SMS restant

Depuis votre application, ou depuis votre propre zone d »administration, vous aurez certainement besoin de suivre combien de SMS vous pouvez encore envoyer à vos clients. Pour cette usage, veuillez également utiliser le token précédemment généré et veuillez accéder au endpoint suivant /sms/admin/v1/contracts, comme ceci :

Cette requête retourne l »objet JSON contenant les informations de votre (ou vos balances) et de la date d »expiration associée.  Veuillez noter que vous pouvez ajouter un paramètre optionnel sur le endpoint afin de filtrer sur un pays donné /sms/admin/v1/contracts?country=SN où la valeur SN représente le code international à 3 chiffres du Sénégal (accédez à tous les codes pays « ISO 3166 alpha-3″ depuis ce site http://fr.wikipedia.org/wiki/ISO_3166-1#Table_de_codage).

 

Afficher votre usage de SMS par application

Depuis votre application, ou depuis votre propre zone d »administration, vous aurez certainement besoin de suivre combien de SMS ont été envoyés par chacune de vos applications. En effet, dans votre compte Orange Partner, plusieurs applications différentes peuvent se partager l »envoi des SMS vous permettant ainsi de capitaliser lors de vos achats.

Pour cette usage, veuillez également utiliser le token précédemment généré et veuillez accéder au endpoint suivant /sms/admin/v1/statistics, comme ceci : 8

Cette requête retourne l »objet JSON contenant les informations du nombre de SMS envoyés par application (et par pays). A noter que vous pouvez utiliser 2 paramètres optionnels sur ce endpoint afin de filtrer par pays et/ou par application avec /sms/admin/v1/statistics?country=SN&appid=45153daa87e…4d738830f4e8e4ba où la valeur SN représente le code international à 3 chiffres du Sénégal et où l » »appid » est l » »Application Id » que vous trouverez dans le Dahsboard au sein de votre application.

Afficher votre historique d »achat

Pour finir, une dernière API de management vous permet de lister l »historique de vos achats. Pour cette usage, veuillez également utiliser le token précédemment généré et veuillez accéder au endpoint suivant /sms/admin/v1/purchaseorders, comme ceci :  Comme pour les autres API, vous pouvez filtrer par pays en utilisant un paramètre optionnel sur le endpoint comme /sms/admin/v1/purchaseorders?country=SN où la valeur SN représente le code international à 3 chiffres du Sénégal.

 

Exemples avec le plugin Firefox « RESTClient »

Si vous n »êtes pas à l »aise avec les requêtes CURL, et si vous désirez tester nos API, vous pouvez télécharger le plugin Firefox « RESTClient » (https://addons.mozilla.org/fr/firefox/addon/restclient/). Maintenant que « RESTClient » est installé, vous pouvez télécharger et dézipper une sauvegarde des requêtes SMS API (http://documentation.paddock.kermit.orange-labs.fr/smsapi-firefox_restclient.zip). Depuis votre plugin « RESTClient », depuis le menu  »Favorite Requests », merci d »importer le fichier .json que vous avez précédemment dézippé sur votre ordinateur.

Une fois le fichier importé avec succès, merci de rafraichir le plugin « RESTClient » (en appuyant sur la touche « F5″ ou en cliquant sur l »icone de Firefox), et retourner dans le menu  »Favorite Requests ». Toutes les requêtes aux API SMS seront présents.

Veuillez noter que toutes les informations liées à une application ont été effacé du fichier .json ; c »est à vous de les remplacer avec votre propres valeurs (soit en utilisant un éditeur de texte avant l »étape d »importation, ou directement depuis l »interface du « RESTClient »). Les valeurs des données liées à l »application sont :

enter_your_consumer_key_here : nécessaire pour la génération du token, vous devez saisir votre « consumer_key » (merci de vous référer à la documentation oAuth2 pour ceci).

enter_your_token_here : Chaque API SMS a besoin d »un token valide lié à votre application afin de vous authentifier. Merci de saisir ici le token de votre application.

+221xxxxxxxx : remplacer avec le numéro de téléphone de destination (seulement pour l »API d »envoi de SMS) où vous souhaitez envoyer votre message.

– Vous pouvez télécharger l »application démo ici (TELECHARGER)