Guide voice management
LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER
API Détails de communication
1 - Généralités
L’API de consultation des détails de communication permet de récupérer des données d’appels ayant été attribués à un opérateur
Cette API est donc toute indiquée pour les calculs d’indicateurs de performances des opérateurs et/ou des groupes ( TMC – DMT – taux de transferts … )
Cas particuliers de transfert d'opérateur à un autre
Un même appel transféré entre deux opérateurs apparaitra donc deux fois, une première avec les données spécifiques de l'échange entre le premier opérateur et le client final et une deuxième fois avec les données spécifiques de l'échange entre le 2nd opérateur et le client final.
Données d'appels non attribués
Les appels n'ayant jamais été attribués à un opérateur ne sont donc pas visibles sur cet API
2 - Formalisme & swagger
Cette API s’inspire du formalisme REST. Les données sont servies au format JSON.
Vous devez obtenir auprès de votre interlocuteur Axialys vos données d’authentification.
Cliquer ici pour retrouvez les informations de ce WS sur notre swagger
3 - Infos générales
3.1 - Récupération des données des détails de communication
| URL | /voice-management/operator_communications |
|---|---|
|
Méthode(s) |
GET |
Les paramètres suivants sont possibles :
| Paramètre | Exemple | Format | Description |
|---|---|---|---|
|
limit |
200 |
Nombre entier |
Pagination : Limite du nombre de résultats par page désirés ( si 0 alors pas de pagination) |
|
page |
1 |
Nombre entier |
Pagination : Numéro de page consultée désirée |
|
date_start |
2023-01-26
|
Date (yyyy-mm-dd) |
Date de début (incluse) de la plage désirée au format Date (yyyy-mm-dd) |
|
date_end |
2023-02-18 |
Date (yyyy-mm-dd) |
Date de fin (incluse) de la plage désirée format Date (yyyy-mm-dd) |
|
group_id |
2143 |
Nombre entier |
Filtre les résultats pour ne retourner que les données d'appels de ce groupe |
|
operator_id |
5395 |
Nombre entier |
Filtre les résultats pour ne retourner que les données d'appels de cet opérateur |
|
order_by |
date.desc |
chaine de charactères |
Tri des résultats possibles : date_asc, date_desc |
|
status |
ANSWER |
texte |
Paramètre pour ne retourner que les appels répondus. Seul le paramètre "ANSWER" est fonctionnel, ou ne pas mettre ce paramètre pour avoir toutes les communications, même celles non répondues.
|
Attention
Afin d'assurer les meilleures performances possibles, utilisez obligatoirement les paramètres pour définir un périmètre de données précis en fournissant notamment "date_start" et "date-end"
Périmètre de données demandées
Afin d'assurer les meilleures performances possibles, il est fortement conseillé de ne pas demander plus de 40 jours de données glissantes
Données retournées
Dans les données retournées, vous trouverez dans le bloc « data » l’ensemble des données désirées , avec notamment les informations de pagination :
| Nom de la propriété | Exemple | Format | Description |
| limit: | 1000 | Nombre entier | Limite du nombre maximum de transferts retournés par page ( par défaut : 100 ) |
| page: | 1 | Nombre entier | Pagination : numéro de la page de données en cours |
| pages: | 11 | Nombre entier | Pagination : nombre de pages totales de données |
| elements: | 10372 | Nombre entier | Nombre total de détails de communications correspondants aux filtres sélectionnés |
Ainsi qu’un tableau d’objets « communications_details_operator » qui correspondent aux données de communications demandées avec les propriétées :
| Nom de la propriété | Exemple | Format | Description |
| id | 4415905 | chaine de charactères | identifiant technique de la communication |
| id_appel | 423426662 | chaine de charactères | identifiant de l’appel |
| date | « 2022-08-01T08:35:28 », | Date /heure (yyyy-MM-dd’T’HH:mm:ss) | Date heure Minutes secondes de l’arrivée de la communication chez l’opérateur |
| service_num | 33934146932 | chaine de charactères | Numéro de service |
| operator.id | 254987 | Nombre entier | Identifiant de l’operateur |
| operator.name | « Durant » | chaine de charactères | Nom de l’opérateur |
| operator.email | « [email protected] » | chaine de charactères | Mail de l’opérateur |
| group.id | 98456 | Nombre entier | identifiant du groupe |
| group.name | « SAV Axialys » | chaine de charactères | Nom du groupe |
| waiting_duration | 24 | Nombre entier | Temps en seconde d’attente dans la file d’attente |
| communication_duration | 587 | Nombre entier | Temps en seconde de conversation entre l’opérateur et le client ( comprend aussi la mise en attente si existante) |
| on_hold_duration | 18 | Nombre entier | Temps en seconde de mise en attente par un opérateur pendant la conversation |
| ringing_duration | 2 | Nombre entier | Temps en seconde de sonnerie |
| catchup_duration | 15 | Nombre entier | Temps en seconde de catchup |
| post_call_duration | 71 | Nombre entier | Temps en seconde de pause post appel |
| transfer_id | 4564 | chaine de charactères | id du transfert si appel transféré |
Calcul de la DMT
La durée de traitement est calculée en additionnant les temps de communication, de catchup et de post appel :
Durée de traitement = communication_duration + post_call_duration + catchup_duration
- Table des matières
