Cette documentation est mise à la disposition des développeurs qui désirent interagir avec l'api de la plateforme d'envoi de sms marketing en ligne : sms plateform .
\nNous avons tout mise en oeuvre pour qu'elle soit la plus simple possible...\n
L'API utilise l'authentification HTTP Basic pour l'authentification.
\nIl vous est demandé de fournir de manière préventive l'en-tête Authorization dans vos demandes et de ne pas attendre que le serveur ait fourni une réponse 401 Unauthorized.
\nVous vous authentifiez en utilisant un token d'API. Les jetons d'API peuvent être obtenus en vous connectant à votre compte et en visitant - Mon compte | Profile | Profile développeur.
\nImportant :
\nL'accès à n'importe quelle endpoint de l'API nécessite un jeton d'API.\nVous pouvez générer vous même votre Jeton d'Api en procédant comme suit.
\nPar exemple, si le nom d'utilisateur est user1 et le mot de passe passw1, la valeur non codée de l'en-tête est user1:passw1. \nVotre jeton d'API sera un encodage en base64 de la chaine : user1:passw1 .
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10721382","collectionId":"8d0bbde7-f14d-48ba-a7b2-f5ba28392173","publishedId":"T17F9nm9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5156A8"},"publishDate":"2020-07-02T07:41:21.000Z"},"item":[{"name":"Messaging","item":[{"name":"/send-sms","id":"6adc93f7-e2a4-4750-a530-890bd06038af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic base64-auth-key","type":"text","description":"Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profil.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"sender\": \"Test\",\r\n\t\"msisdn\": \"33000000000\",\r\n\t\"message\": \"hello world\",\r\n}"},"url":"https://smsplateform.com/gateway/send-sms","description":"Envoyer un nouveau message
\nLes différents statuts d'un message sont :
\n1- Message envoyé et transmis au bénéficiaire
2- Message en attente
0- Échec, le message n'a pas été envoyé au bénéficiaire
Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profil.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"message_id\": 7131\r\n}"},"url":"https://smsplateform.com/gateway/view-sms","description":"Récupérer le contenu d'un SMS
\n","urlObject":{"protocol":"https","path":["gateway","view-sms"],"host":["smsplateform","com"],"query":[],"variable":[]}},"response":[{"id":"59367646-cd3a-461f-ad6a-77430ecd3a66","name":"/view-sms","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDp0ZXN0","type":"text","description":"Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profile."},{"key":"Accept","value":"application/json","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"message_id\": 7131\r\n}"},"url":"https://smsplateform.com/gateway/view-sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jul 2020 06:57:31 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/7.2.31"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, PUT"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Vary","value":"User-Agent"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7131\",\n \"sender\": \"ALERT\",\n \"receiver\": \"33700555798\",\n \"message\": \"quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo\",\n \"cost\": \"4\",\n \"status\": \"0\",\n \"created_at\": \"2020-07-02 02:38:44\"\n}"}],"_postman_id":"ce0a1ed5-c376-40eb-b481-6214ca4717f1"},{"name":"/sms-list","id":"7e3b7358-b8b1-4391-833e-1497af2d2596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic base64-auth-key","type":"text","description":"Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profil.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"limit\": 2\r\n}"},"url":"https://smsplateform.com/gateway/sms-list","description":"Récupérer la liste des messages envoyés.
\nLes différents statuts d'un message sont :
\n1- Message envoyé et transmis au bénéficiaire
2- Message en attente
0- Échec, le message n'a pas été envoyé au bénéficiaire
Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profil.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://smsplateform.com/gateway/profile","description":"Récupérer les données du compte client
\n","urlObject":{"protocol":"https","path":["gateway","profile"],"host":["smsplateform","com"],"query":[],"variable":[]}},"response":[{"id":"c9fc3fe6-5332-4f7a-ad21-d1ca147554e0","name":"/profile","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic dGVzdDp0ZXN0","type":"text","description":"Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profile."},{"key":"Accept","value":"application/json","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://smsplateform.com/gateway/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jul 2020 06:42:30 GMT"},{"key":"Server","value":"Apache"},{"key":"X-Powered-By","value":"PHP/7.2.31"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, PUT"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"},{"key":"Vary","value":"User-Agent"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"test\",\n \"email\": \"test@smsplateform.com\",\n \"phone\": \"+33000000000\",\n \"role\": \"reseller\",\n \"vip\": \"0\",\n \"balance\": \"10\",\n \"referer\": \"torskint\",\n \"created_at\": \"2019-07-22 09:47:06\"\n}"}],"_postman_id":"abffe611-7331-41d1-b507-26c5108ac096"}],"id":"7ca3151c-0676-488d-ae50-0db6e18c5e3c","description":"Base Url : https://smsplateform.com/gateway/
\n","event":[{"listen":"prerequest","script":{"id":"58e10509-afe0-4a41-a330-ef69f8c981ad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7c6d7e9-dbc5-4f86-85eb-af0675f66fb4","type":"text/javascript","exec":[""]}}],"_postman_id":"7ca3151c-0676-488d-ae50-0db6e18c5e3c"},{"name":"Telegram Delivery","item":[],"id":"43962daa-69e9-43a6-a5c7-7698b60c99dc","description":"Cette clé se trouve dans votre espace client suivant le chemin https://smsplateform.com/user/profil.
\n","key":"Authorization","type":"text","value":"Basic base64-auth-key"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"sender\": \"Test\",\r\n\t\"msisdn\": \"33000000000\",\r\n\t\"message\": \"hello world\",\r\n \"webhook_url\": \"https://your-site.com/script.php\"\r\n}"},"url":"https://smsplateform.com/gateway/send-sms","description":"Les webhooks permettent à vos applications de capturer des données en temps réel sur les statuts de votre sms. Il vous suffit de nous fournir une url où vous souhaitez que les données soient envoyées. À partir de là, chaque fois qu'un sms change de statut d'envoi, nous enverrons les détails à votre application.
\nCela fait, lorsque vous recevrez une reponse sur votre url de retour ( webhook_url ), elle sera sous forme json :
\n\n\n{\n\"msg_id\": \"224\",\n\"msg_status\": \"1\",\n\"msg_cost\": \"1\",\n\"msg_statusText\": \"DELIVRED\"\n}
\n
\n\n{\n \"msg_id\": \"220\",\n \"msg_status\": \"0\",\n \"msg_cost\": \"1\",\n \"msg_statusText\": \"FAILED\"\n}
\n
\n\n","urlObject":{"protocol":"https","path":["gateway","send-sms"],"host":["smsplateform","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e916ff2-7073-40b5-b740-8c07eeb2a96a"}],"id":"a1f1dc04-260b-4bbd-96b0-8e341cbcb877","description":"{\n \"msg_id\": \"225\",\n \"msg_status\": \"2\",\n \"msg_cost\": \"1\",\n \"msg_statusText\": \"PENDING\"\n}```
\n
Lorsque vous envoyez un message texte via Smsplateform.com, vous voudrez peut-être déterminer si ce message a été transmis avec succès ou pas. Il existe deux façons différentes de le faire : La première consiste à demander à Smsplateform.com le statut de livraison d'un message particulier, en utilisant son identifiant unique. La deuxième façon consiste à fournir une URL de rappel de statut (webhook_url) lorsque vous envoyez le message via notre api.
\nVoici un exemple de code qui montre comment définir une URL de webhook pour les rappels de statut sur les messages sortants :
\nLa mise en place de votre webhook se passe lorsque vous envoyer un sms :
\nAinsi la requete d'envoi de sms avec demande de statut peut être écrite sous cette forme :
\n","event":[{"listen":"prerequest","script":{"id":"f51c729e-d3e5-411e-b912-7b80e635bfa7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa6d078e-48f9-4a02-b0a7-2b734317eafe","type":"text/javascript","exec":[""]}}],"_postman_id":"a1f1dc04-260b-4bbd-96b0-8e341cbcb877"}],"event":[{"listen":"prerequest","script":{"id":"f038ccff-c96d-4774-a2de-59670915ff69","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e85c2ab-92c9-42cf-9941-fde5ef434d40","type":"text/javascript","exec":[""]}}]}