Api : utilisation de bufferws json
DMC L’API « DMcBufferWS » JSON de DMC permet l’envoi de messages unitaires à grande échelle. Ce Web Service a été conçu pour accepter un très grand nombre de connexions simultanées (plus de 100). Il accepte un nombre de connexions parallèles supérieur aux Web Service JSON standards.
Dans cette article nous allons présenter les méthodes sans faire appel à un développement dans un langage de programmation.
Ce Web Service est composé de deux méthodes :
- addSingleCall
- getSingleCallCra
La Méthode addSingleCall.
Déclenchement d’un appel vocal ou d’un SMS unitaire
Paramêtres:
| serviceId * | L’identifiant de votre service |
| servicePassword * | Le mot de passe « API WS » du service |
| spaceId * | L’identifiant de l’espace |
| from | Emetteur du message (un numéro pour le vocal, un OADC pour le SMS si l’option a été soumise) |
| msgContent * | Contenu du message à envoyer Taille maximal de 1224 caractères |
| address * | Coordonnée du contact |
| media * | Media à utiliser (‘SMS’ ou ‘VOCAL’) |
| unicode | Encodage UTF8 pour le SMS (true ou false) |
* Champ obligatoire.
Retour de la méthode :
| Retour | ==> OK en cas de succès ==> KO en cas d’échec ! Les valeurs passées en paramètre doivent être valides. ! Un résultat « OK » garanti que la demande a été prise en compte. ! Si une valeur (à l’exception de « serviceId » et « servicePassword ») erronée est passée en paramètre, une réponse « OK » sera retournée mais le message ne sera pas envoyé. |
Url d’exemple :
Envoi d’un SMS avec comme message « Message de test Stop au <#shortcode#> »
https://www.dmc.sfr-sh.fr/DmcBufferWS/BufferMsg/addSingleCall?serviceId=91xxxxxx&servicePassword=mdp&spaceId=12345&messageUnitaire={msgContent:%22Message%20de%20test%20Stop%20au%20%3C%23shortcode%23%3E%22,from:%22votreOADC%22,address:%220640000000%22,media:%22SMS%22}
- Remplacer les textes en rouge ci-dessus par vos identifiants.
- Remplacer le numéro de téléphone (en bleu ci-dessus) par celui qui doit recevoir le SMS.
- La partie en jaune doit être en supprimée si vous n’avez pas de champ AODC, sinon mettre votre OADC à la place de « votreOADC ».
Retour de l’url ci-dessus
OK<5be05d04a7d3c611bc6eb916>
SMS réceptionné :
Message de test Stop au 38606
La méthode getSingleCallCra.
Récupération des comptes rendus des messages unitaire (CSV)
Paramêtres :
| serviceId * | L’identifiant de votre service |
| servicePassword * | Le mot de passe « API WS » du service |
| spaceId * | L’identifiant de l’espace |
| idSince | Id du premier message à récupérer |
| dSince | Date du premier message à récupérer (timestamp en millisecondes) |
* Champ obligatoire.
Vous pouvez obtenir le timestamp d’une date sur le site : https://timestamp-tool.fr/
! Ne pas oublier de rajouter 00 à la fin du nombre renvoyé; l’unité de temps du site est en millisecondes.
Retour de la méthode :
| Retour (CSV) | La liste des 50 derniers comptes rendus ou des 50 derniers en fonction des valeurs indiquées dans « startId » et « dSince » ID : Identifiant du message MEDIA : Media utilisé CALLDATE : Date et heure de l’appel/envoi CALLADRESS : Téléphone utilisé pour envoyer le message STATUS : Statut du message (‘RUNNING’,’DONE,’FAILED’) CALLRESULT : Résultat de l’appel/envoi CALLRESPONSE : Résultat reçu si le contact a répondu LASTCHANGE : Date de dernier changement de l’état du contact |
Url d’exemple :
https://www.dmc.sfr-sh.fr/DmcBufferWS/BufferMsg/getSingleCallCra?serviceId=91xxxxxx&servicePassword=mdp&spaceId=12345&idSince=5be02275a7d3c611bc6e67b5&dSince=154141500000
! Remplacer les textes en rouge ci-dessus par vos identifiants.
Le timestamp 154141500000, dans l’url ci-dessus, correspond au 5/11/2018 à 11:50:00
Retour de l’url ci-dessus
ID;MEDIA;CALLDATE;CALLADRESS;STATUS;CALLRESULT;CALLRESPONSE;CALLDETAIL;LASTCHANGE
5be02214a7d3c611bc6e6765;SMS;05/11/2018 11:57:34;0646090992;DONE;Reçu;;CRA_PART{1};05/11/2018 11:57:35;
5be02275a7d3c611bc6e67b5;SMS;05/11/2018 11:59:07;0646090992;DONE;Reçu;;CRA_PART{1};05/11/2018 11:59:09;
5be055a9a7d3c611bc6eaeb5;SMS;05/11/2018 15:37:36;0646090992;DONE;Reçu;;CRA_PART{1};05/11/2018 15:37:37;
5be05d04a7d3c611bc6eb916;SMS;05/11/2018 16:09:01;0646090992;DONE;Reçu;;CRA_PART{1};05/11/2018 16:09:02;
5be05d30a7d3c611bc6eb94f;SMS;05/11/2018 16:09:42;0646090992;DONE;Reçu;;CRA_PART{1};05/11/2018 16:09:43;
Le principe d’utilisation du Web Service « DmcBufferWS » est le suivant :
- Appeler la méthode « addSingleCall » pour chaque message à envoyer (Vocal ou SMS)
- Appeler la méthode « getSingleCallCra » une première fois avec la date du premier envoi dans le paramètre « dSince »
o La méthode retourne les messages dont l’état a été modifié depuis la date demandée - Traiter les CRA retournés au format CSV
- Récupérer l’« ID » et le « LASTCHANGE » de la dernière ligne du CSV obtenu en réponse
- Rappeler la méthode « getSingleCallCra » en boucle avec l’identifiant et la date obtenus précédement
o Si la réponse est vide, aucun message n’a été modifié depuis la dernière demande
o Si la réponse n’est pas vide, traiter les CRA et recommencer l’opération 5
