DMC – Qu’est-ce que le PushCra ?
L’API DMC permet la réception des CRA (comptes rendus d’appels) par Push HTTP sur une URL externe fournie lors de l’activation du service.
Les CRA, y compris les réponses aux SMS sortants, sont envoyés vers l’URL externe en POST au format XML.
La réponse XML est composée de 5 types de balises.
| <?xml version= »1.0″ encoding= »UTF-8″ standalone= »no »?> <status_report> <sms(mms,mail,fax,call)> <status><vxml_info/><transfer/></status> </sms(mms,mail,fax,call)> </status_report> |
Les paramètres retournés dans la réponse au format XML sont les suivants :
Balise « status_report » (balise parent du document)
• Username : Identifiant du service
Balise « media » (balise contenant les données du dernier status) :
- Media : Nom de la balise (sms,mms,mail,fax,call)
- To : Numéro de téléphone du contact
- Status : Status du CRA
- Call_id : Identifiant unique de la plateforme permettant d’identifier la tentative d’appel/envoi
- Broadcast_id : Identifiant de la diffusion à l’origine de l’appel/envoi
- Contact_id : Identifiant du contact
- Ref_externe : Référence externe du contact (champ libre)
- Space_id : Identifiant de l’espace DMC
- Date : Date de réception du CRA
Balise « status » (balise contenant l’historique des status) :
- Date : Date de réception du CRA
- Type : Type de status
- Time : Durée de l’appel (VOCAL/FAX)
- Amd : Indique le type d’interlocuteur qui a répondu (unknown, fax, machine, human) (VOCAL)
- Size : Taille du message en octet (MMS/MAIL)
- Page : Nombre de pages envoyées (FAX)
- Code : Code d’erreur en cas de problème (tous médias)
- Info : Description en cas d’erreur (tous médias), le texte en cas de réponse du contact (SMS)
Balise « vxml_info » (pour le vocal uniquement) :
- Voicemail : Indique si l’appel est tombé sur un répondeur ou non
- Start : Date de début de l’appel (timestamp)
- End : Date de fin de l’appel (timestamp)
- Termination : Résultat de l’appel
- Result : Résultat de l’appel (dernier nœud atteint dans le scénario vocal)
- Route : Nœuds empruntés par le contact durant l’appel
Balise « transfer » (pour le vocal uniquement)
- To : Numéro de téléphone sur lequel le contact a été transféré
L’enchaînement des status est le suivant :
- CONVERTED : Le pdf a été converti en tiff pour envoi (FAX)
- SENT : Le message a été envoyé au contact (SMS/MMS/EMAIL/FAX)
- ESTABLISHED : L’appel vocal est en cours (VOCAL)
- TRANSFERED : Le contact a été transféré (VOCAL)
- ERROR/ABORTED : Le message a rencontré un problème à la soumission (Tous médias)
- RECEIVED : Le message a été reçu par le contact (SMS)
- ENDED : L’appel vocal est terminé (VOCAL)
- ANSWERED : Le contact a répondu au message (SMS)
Vous retrouverez des exemples de requêtes en téléchargeant la documentation sur l’API WorkShop.
Ces informations vous ont-elles aidé ?
Merci pour votre vote
