Guide voice management

LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER

Retour au guide

API Voice Management

1 - Généralités

L’API du Voice Management permet de configurer et de superviser le traitement des appels.

2 - Formalisme

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.

2.1 - Format des requêtes

Les requêtes seront de la forme

https://SERVER/vm...?user=<username>&password=<password>

A noter concernant le format des paramètres :

  • les numéros de téléphone sont attendus au format E164 (c’est-à-dire code pays suivi du numéro national, par exemple 33145420000 pour un numéro parisien).
  • les dates sont attendues au format IS0 8601. Cependant, notre système acceptera les variations les plus communes, et notamment le format AAAA-MM-DD HH:MM.

2.2 - Format des réponses

Les réponses sont fournies au format JSON par défaut sauf si la requête est passée depuis un navigateur, auquel cas les données sont présentées au format HTML. Pour forcer une réponse JSON, ajouter le paramètre

accept=application/json

.

Attention, la réponse JSON est susceptible de contenir des données supplémentaires, en cas d’évolution de l’API. Ne pas en tenir compte.

3 - Infos générales

3.1 - Récupération des opérateurs

Cette API fournit le listing des opérateurs.

URL /vm/operators/
Méthode(s)
GET

Il est possible de récupérer un opérateur particulier via :

URL /vm/operators/‹ id_operateur›
Méthode(s)
GET

Il est également possible d’utiliser la méthode POST afin de filtrer sur les données suivantes :

Nom Type Oblig. Description
email
Email
N
Adresse email
login
Alpha-numérique
N
Login de connexion

Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

3.2 - Récupération de l’état courant des opérateurs

Attention à ne pas faire plus d’une requête toute les 30s, à terme un contrôle sera activé.

Cette API fournit le listing des opérateurs.

URL /vm/operators_init
Méthode(s)
GET

Il est possible de récupérer un opérateur particulier via :

URL /vm/operators_init/
Méthode(s)
GET

Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Oblig. Description
id
Y
id de l operateur
etat
vailable,ringing,calling,connected,unavailable
N
état de l’opérateur
ui_login
Date
N
date du dernier login
ui_logout
Date
N
date du dernier logout
pause
Date
N
pause courante de l’opérateur
ui_pause
Date
N
date de la dernière pause
ui_unpause
Date
N
date de la dernière unpause
groups
Liste d’IDs
N
Liste des ID des groupes dont l’opérateur est membre

3.3 - Récupération des groupes

Cette API fournit le listing des groupes.

URL /vm/groups
Méthode(s)
GET

Il est possible de récupérer un groupe particulier via :

URL /vm/groups/‹id_groupe›
Méthode(s)
GET

Il est également possible d’utiliser la méthode POST afin de filtrer sur les données suivantes :

Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Oblig. Description
name
Alpha-numérique
N
Nom du groupe recherché
Nom Type Description
id
Adresse email
name
Alpha-numérique
Nom du groupe recherché

3.4 - Récupération de l’historique du statut des opérateurs

Cette API fournit le listing du statut des opérateurs. Attention le statut ne fournit pas le statut actuel, mais uniquement l’historique (ils sont insérés une fois que l’opérateur change d’état. Les informations d’appels peuvent également être ajoutées un peu plus tard.)

URL /vm/calls/status
Méthode(s)
POST

Les requêtes devront se faire sous la forme

				
					curl -u <username>:<password> "https://api.axialys.com/vm/calls/status" -X POST -d '{"date":"2019-04-20","date_end":"2019-05-01"}'

Paramètres

Nom Type Oblig. Description
date
Date
Y
Date/heure de début de la période.
date_end
Date
Y
Date/heure de fin de la période.
id_op
Numérique
N
ID de l’opérateur.

Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Description
id_op
ID d’opérateur
duration
Entier
Durée en secondes
date
Date/Heure
Date de début de l’événement
id_call
Entier
ID de l’appel
infos
Chaîne de caractères
Infos supplémentaires
type
Chaîne de caractères
Type de l’événement (call_in, call_out, break, login, catchup)

3.5 - Récupération du statut détaillé de l’opérateur

Ceci permet d’obtenir les données détaillées sur un opérateur, id_appel en cours, différentes variables associées au service…

URL /vm/op_details/‹id_op›
Méthode(s)
GET

Les requêtes devront se faire sous la forme

				
					

curl -u <username>:<password> "https://api.axialys.com/vm/op_details/<id_op>

Données retournées

Les données retournées sont les suivantes :

Nom Type Description
nom_compte_facturation
Alpha-numérique
Compte de facturation auquel l'opérateur est rattaché
id
Numérique
ID de l’opérateur
state
Alpha-numérique
Etat de l’opérateur
pause
Alpha-numérique
Pause en cours
vars
Numérique
Tableau associatif avec les différentes variables du service
service_number
Numérique
Numéro du service
caller_number
Numérique
Numéro de l’appelant
ui_login
Date
Date de connexion
ui_logout
Date
Date de déconnexion
ui_pause
Date
Date de début de pause
ui_unpause
Date
Date de sortie de pause
dt_answer
Date
Date de début de l’appel en cours
id_appel
Numérique
ID de l’appel en cours
groups
Alpha-numérique
Listing des groupes auquel appartient le client
id_group
Numérique
ID du groupe de l’appel cours

4 - Statistiques

4.1 - Appels reçus (numéros)

Cette API fournit des statistiques globales sur le nombre d’appels reçus au niveau télécom pour une période donnée (par défaut, la journée en cours).

URL : /vm/stats/number_calls Méthode acceptée : GET

Paramètres
Nom Type Oblig. Description
from_date
Date/Heure
N
Date/heure de début de la période. Par défaut, aujourd’hui à 00:00
to_date
Date/Heure
N
Date/heure de fin de la période. Par défaut, maintenant.
dest_number
Alphanum
N
Numéro pour lequel on veut spécifiquement des données. Ce paramètre peut-être indiqué plusieurs fois; dans ce cas les données de tous les numéros indiqués sont cumulées.
include_realtime
N
Lorsque ce paramètre est positionné, des données d’état “temps réel” sur les appels en cours sont incluses.
Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Oblig. Description
total_duration
Entier
Y
Durée totale des appels reçus en secondes.
calls_count
Entier
Y
Nombre total d’appels reçus.
agent_connected_calls_count
Entier
Y
Nombre d’appels ayant donné lieu à une connexion effective vers un agent.
active_calls
Entier
N
Nombre d’appels en cours sur le ou les numéros concernés par la requête (si include_realtime).
in_conversation_calls
Entier
N
Nombre d’appels en conversation sur le ou les numéros concernés par la requête (si include_realtime).
oldest_call_since
Date/Time
N
Horodatage du début de l’appel le plus ancien en cours (si include_realtime).
oldest_in_conversation_call_since
Date/Time
N
Horodatage du début de l’appel en conversation le plus ancien en cours (si include_realtime).

Il n’est pas possible de requêter une période plus longue qu’un mois.

4.2 - Appels reçus (groupes agents)

Cette API fournit des statistiques sur le nombre d’appels reçus présentés aux groupes d’agents pour une période donnée (par défaut, la journée en cours).

URL : /vm/stats/group_calls Méthode acceptée : GET

Paramètres
Nom Type Oblig. Description
from_date
Date/Heure
N
Date/heure de début de la période. Par défaut, aujourd’hui à 00:00
to_date
Date/Heure
N
Date/heure de fin de la période. Par défaut, maintenant.
group_id
Numérique
N
ID du groupe pour lequel on veut spécifiquement des données. Ce paramètre peut-être indiqué plusieurs fois; dans ce cas les données de tous les groupes indiqués sont cumulées.
include_realtime
N
Lorsque ce paramètre est positionné, des données d’état “temps réel” sur les appels en cours sont incluses.
Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Oblig. Description
total_duration
Entier
Y
Durée totale des appels reçus par les agents en secondes.
calls_count
Entier
Y
Nombre total d’appels reçus par les agents.
agent_connected_calls_count
Entier
Y
Nombre d’appels décrochés par un agent.
active_calls
Entier
N
Nombre d’appels en cours sur le ou les groupes concernés par la requête (si include_realtime).
oldest_call_connected_since
Date/Time
N
Horodatage du début de la plus ancienne conversation avec un agent en cours (si include_realtime).
oldest_call_waiting_since
Date/Time
N
Horodatage du début de l’attente de l’appel le plus ancien en cours (si include_realtime).

Il n’est pas possible de requêter une période plus longue qu’un mois.

4.3 - Supervision (groupes agents)

Cette API fournit des statistiques actuelles de la supervision liées à un groupe d’agents.

URL : /vm/stats/group_stats Méthode acceptée : GET

Format des requêtes

Les requêtes devront se faire sous la forme

				
					curl -u <username>:<password> “https://api.axialys.com/vm/group_stats/<id_group>” -X GET

Ou

				
					wget -qO- “https://<username>:<password>@api.axialys.com/vm/group_stats/<id_group>”
Paramètres
Nom Type Oblig. Description
group_id
Entier
N
ID du groupe pour lequel on veut spécifiquement des données.
Données retournées

Les données retournées incluent le paramètre passé en entrée, ainsi que les données suivantes :

Nom Type Description
group_name
Alpha-numérique
Nom du groupe
nbr_global
Entier
Nombre d’appels Global
nbr_global_reel
Entier
Nombre d’appels uniques Global, dans le cas d’appels en débordement
nbr_escalades
Entier
Nombre d’appels Escaladés
pourc_decroche
Entier
Pourcentage d’appels Décrochés
nbr_comm
Entier
Nombre d’appels En communication
nbr_attente
Entier
Nombre d’appels En attente
nbr_perdus
Entier
Nombre d’appels Perdus
nbr_perdus_reel
Entier
Nombre d’appels uniques Perdus, dans le cas d’appels en débordement
tps_max_attente
Heure
Temps max d’attente
tps_moyen_attente
Heure
Temps moyen d’attente
tps_moyen_comm
Heure
Temps moyen de communication
tps_moyen_abandon
Heure
Temps moyen d’abandon
nbr_appels_attente_moins1m
Entier
Nombre de personnes en attente de moins de 1 minute
nbr_appels_attente_1a3m
Entier
Nombre de personnes en attente entre 1 et 3 minutes
nbr_appels_attente_3mplus
Entier
Nombre de personnes en attente de plus de 3 minutes
nbr_abandonne
Entier
Nombre d’appels abandonnés en moins de X secondes (X secondes d’attente sur le groupe). Par défaut, en moins de 5 secondes.
nbr_repondu
Entier
Nombre d’appels répondus en moins de Y secondes (Y secondes après arrivé sur le groupe). Par défaut, en moins de 45 secondes.
tps_moyen_catchup
Heure
Temps moyen de de Catchup

Si vous souhaitez configurer le nombre de secondes pour nbr_abandonne et pour nbr_repondu, il faut par exemple faire une requête sous la forme :

				
					curl -u <username>:<password> “https://api.axialys.com/vm/group_stats/<id_group>” -X GET -d ‘{“nbr_abandonne”:<nbr de secondes>,”nbr_repondu”:<nbr de secondes>}’
  • Table des matières