API vers Listener QM - poster une liste d'interactions

Afin de vous permettre de poster les métadonnées des enregistrements audio ou texte à évaluer, CROSS-CRM fournit une API de type JSON basée sur REST qui utilise OAuth et JWT détaillé dans ce document.

- Une description des métadonnées qui seront envoyés à la plateforme CROSS-CRM pour le module Listener QM

- La définition du web service ‘Interactions’ (signature, sécurité...)

Authentification

Pour utiliser l'API, vous devez d'abord récupérer un jeton Web Json à partir de l'API.
Cela peut être fait en utilisant le point de terminaison {ACCOUNT_NAME} / oauth2 / token en
transmettant votre nom d'utilisateur et votre mot de passe.
Un exemple de demande se trouve ci-dessous.
Une fois la demande vérifiée, vous recevrez un jeton d'authentification que vous passerez dans l'en-tête
d'authentification dans les demandes suivantes.
Ce jeton expirera s'il n'est pas utilisé (selon la valeur définie dans ‘timeout’) et vous devrez peut-être en
demander un nouveau.

Exemple de code en PHP-cURL

Api-example-1

Header
Content-Type application / x-www-form-urlencoded
BODY urlencoded
Username {{ Username }}
mot de passe {{ Password }}
grant_type password

Données à transmettre

L’appel d’api se passe par une autorisation de type Bearer avec le token généré à l’étape précédente.

L’api peut recevoir une ou plusieurs interactions dans un seul appel d’API
La structure de ces interactions sera au format JSON :

Api-examples-2

Les données décrivant une interaction sont les suivantes :

- url :Représente le chemin de la ressource audio.
- start :Au format DateTime, l’horodatage du début de l’interaction.
- end :Au format DateTime, l’horodatage de fin de l’interaction.
- caller :Le numéro de téléphone de l'appelant.
- called :Le login du téléconseiller qui s’est chargé de l’interaction.
- SystemID : L’identifiant qui permet à la solution tierce de différencier les
interactions entre elles.
- callType :(Incoming / Outgoing) le sens de la communication, le
téléconseiller appelle (Outgoing), reçoit un appel (Incoming).
- registrationNumber / firstName / lastName / email / site / country / city / login /
project / team /siteId/ projectId/ teamId :les informations du téléconseiller qui
s’est chargé de l’interaction.

Exemple d’appel de l’API Listener QM

Méthode : POST d’une liste d’interactions
URL : VOTRE URL/insertInteraction

api-example-3

Header
AUTORISATION Bearer Token = Jeton porteur -> voir le paragraphe d’authentification
PARAMETRE
‘calls’ = liste des appels au format json -> voir paragraphe données à transmettre

Codes erreur et confirmation

Voir la documentation relative aux codes d’erreur et confirmations fournies par votre administrateur CROSS-CRM.
Cet article a-t-il répondu à vos questions ?
Annuler
Merci !