Guide voice management

LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER

API historique des appels

Spécifique aux appels entrants :

Format de la requête

La requête devra se faire sous la forme :

Cette API permet de récupérer l’historique des appels entrants et sortants, en deux méthodes.

1 - Considérations générales

L’API fonctionne suivante un paradigme de type REST, en acceptant des données sous forme de paramètres passés en GET ou en POST, et retourne des données au format JSON.

1.1 Paramètres

Toutes les fonctions d’API nécessitent l’usage des paramètres de connexion suivants :

Nom Type Défaut Oblig. Description
login
Alphanum 32
Y
Identifiant utilisateur API
password
Alphanum 32
Y
Mot de passe

Et des paramètres servant de filtre pour l’extraction des données :

Nom Type Défaut Oblig. Description
date
YYYY-MM-DD
N
Date de début ou date du jour demandé
date_end
YYYY-MM-DD
N
Date de fin, max 1 mois par rapport à la date de début
service_number
Numérique
N
Numéro de service, au format e164
caller_number
Numérique
N
Numéro de l’appelant, au format e164
id_appel
Numérique
N
Identifiant de l'appel
1.2 Historique des appels entrants
URL /vm/calls/in
Méthode(s)
POST
Format de la requête

La requête devra se faire sous la forme :

				
					curl “https://api.axialys.com/vm/calls/in” -u <login>:<password> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “service_number”:”<e164>”, “caller_number”:”<e164>”}’ -X POST
				
			
Retour
Nom Type Description
id_appel
Numérique
identifiant de l’appel
date
Date
Date, au format ISO 8601
service_number
Numérique
Numéro du service, au format e164
caller_number
Numérique
Numéro de l’appelant, au format e164
cp
Numérique
Code postal de l’appelant
post_appel
Numérique
Durée pause, en seconde
duration_ring
Numérique
Durée de sonnerie, en seconde
duration
Numérique
Durée de l’appel, en seconde
duration_svi
Numérique
Durée passée sur le SVI avant d’entrer dans une file d’attente d’un groupe
duration_hold
Numérique
Durée pendant laquelle un appel a été mis en attente par l’opérateur pendant l’appel
duration_comm
Numérique
Durée de communication entre l’appelant et l’opérateur
duration_wait
Numérique
Durée d’attente de l’appelant avant le décroché de l’appel
status
Alphanum
Statut de l’appel entrant
group_name
Alphanum
Nom du groupe ayant reçu l’appel
op_name
Alphanum
Nom de l’opérateur ayant reçu l’appel
rub_name
Alphanum
Nom de la rubrique ayant reçu l’appel
id_op
Numérique
Identifiant de l’opérateur ayant reçu l’appel
id_tags
Alphanum
Liste des id de tag
first_group_name
Alphanum
1er groupe auquel a été attribué l’appel

NB : “op_name”, et “rub_name” sont mises à jour 2h après, il faut appeler la méthode au moins 2 heures après l’heure de fermeture du service.

Attention : Si vous précisez une date de début et une date de fin, la recherche est limitée à un mois.

Format de la requête

La requête devra se faire sous la forme :

				
					curl “https://api.axialys.com/vm/calls/out” -u <login>:<pass> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “called_number”:”<e164>” }’ -X POST
				
			
Retour
Nom Type Description
id_appel
Numérique
identifiant de l’appel
date
Date
Date, au format ISO 8601
service_number
Numérique
Numéro du service, au format e164
called_number
Numérique
Numéro de l’appelé au format e164
duration_ring
Numérique
Durée de sonnerie, en seconde
duration
Numérique
Durée de l’appel, en seconde
status
Alphanum
Statut de l’appel sortant
group_name
Alphanum
Nom du groupe ayant reçu l’appel
op_name
Alphanum
Nom de l’opérateur ayant reçu l’appel
rub_name
Alphanum
Nom de la rubrique ayant reçu l’appel
id_op
Numérique
Identifiant de l’opérateur ayant reçu l’appel
id_tags
Alphanum
Liste des id de tag
Record
URL
URL de la ressource sonore si disponible et droit activé
L’id_appel d’un appel sortant est précédé d’un “-”.
 
Attention : Si vous précisez une date de début et une date de fin, la recherche est limitée à un mois.
1.4 Récupération des tags

Cette API fournit le listing des tags.

URL /vm/tags
Méthode(s)
GET
Format des requêtes

Les requêtes devront se faire sous la forme

en GET :

				
					curl -u <username>:<password> "https://api.axialys.com/vm/tags" -X GET

				
			
Données retournées
Nom Type Description
id
Numérique
Id du tag
type
APPEL
Type de l’appel. Pour l’instant, il n’existe que le type “APPEL”.
name
Alpha-numérique
Nom du tag
description
Alpha-numérique
Description du tag
color
Hex/RGBA
Couleur du tag en hexadécimal ou en RGBA
active
Booléen
Activation du tag (0 non actif, 1 actif)
created_at
Date/Heure
Date de création, au format YYYY-MM-DD HH:MM:SS
updated_at
Date/Heure
Date de mise à jour, au format YYYY-MM-DD HH:MM:SS
deleted_at
Date/Heure
Date de suppression, au format YYYY-MM-DD HH:MM:SS
1.5 Récupération des messages vocaux

Cette API fournit le listing des messages vocaux et permet de récupérer les fichiers audio.

URL /vm/voicemail
Méthode(s)
GET
1.5.1 Listing des messages vocaux

Permet de récupérer la liste des messages vocaux.

Format des requêtes

Les requêtes devront se faire sous la forme

en GET :

				
					curl -u <username>:<password> "https://api.axialys.com/vm/voicemail?id_appel=<num>"
				
			

ou

				
					curl -u <username>:<password> "https://api.axialys.com/vm/voicemail?date=<date>"
				
			

ou

				
					curl -u <username>:<password> "https://api.axialys.com/vm/voicemail?date=<date>&date_end=<date>"
				
			
Paramètres
Nom Type Oblig. Description
id_appel
Numérique
O/N
Identifiant de l’appel
date
Date
O/N
La date du jour ou la date de début de période, au format YYYY-MM-DD
date_end
Date
O/N
La date de fin de période, au format YYYY-MM-DD
Données retournées
Nom Type Description
id
Numérique
Identifiant du message
date
Date/Heure
Date d’enregistrement du message
duration
Numérique
Durée du message
caller_num
Numérique
Numéro de téléphone de l’appelant
id_appel
Identifiant de l’appel
1.5.2 Récupération des fichiers

Permet de récupérer le fichier audio au format mp3, en fonction de l’identifiant du message.

Format des requêtes

Les requêtes devront se faire sous la forme

en GET :

				
					curl -u <username>:<password> "https://api.axialys.com/vm/voicemail/<id>/file" -o <nom>.mp3
				
			
Paramètres
Nom Type Oblig. Description
id
Numérique
O
Identifiant du message
nom
Alpha-numérique
O
Nom à donner au fichier audio
1.6 Inventaires des statuts des appels

Commun aux deux types :

Nom Description
ANSWER
répondu
BUSY
occupé
NOANSWER
non répondu
UNKNOWN
inconnu
CANCEL
annulé
CONGESTION
congestion
CHANUNAVAIL
channel indisponible

Spécifique aux appels entrants :

Nom Description
NO
pas d’aboutement
CALLBACK
callback
VOICEMAIL
boite vocale
1.7 Historique des appels dans les groupes
URL /vm/calls/groups
Méthode(s)
POST
				
					curl “https://api.axialys.com/vm/calls/groups” -u <login>:<password> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “service_number”:”<e164>”, “caller_number”:”<e164>”}’ -X POST
				
			
Retour
Nom Type Description
id_appel
Numérique
identifiant de l’appel
date
Date
Date, au format ISO 8601
service_number
Numérique
Numéro du service, au format e164
caller_number
Numérique
Numéro de l’appelant, au format e164
date_in
Date
Date d’entrée dans le groupe, au format ISO 8601
date_out
Date
Date de sortie du groupe, au format ISO 8601
date_answer
Date
Date appel répondu, au format ISO 8601
duration
Numérique
Durée de l’appel, en seconde
group_name
Alphanum
Nom du groupe ayant reçu l’appel
op_name
Alphanum
Nom de l’opérateur ayant reçu l’appel
1.8 Historique des appels dans les rubriques
URL /vm/calls/rubriques
Méthode(s)
POST
Format de la requête

La requête devra se faire sous la forme :

				
					curl “https://api.axialys.com/vm/calls/rubriques” -u <login>:<password> -H “Content-Type: application/json” -d ‘{“date”:”<YYYY-MM-DD>”, “date_end”:”<YYYY-MM-DD>”, “service_number”:”<e164>”, “caller_number”:”<e164>”}’ -X POST
				
			
Retour
Nom Type Description
id_appel
Numérique
identifiant de l’appel
date
Date
Date, au format ISO 8601
service_number
Numérique
Numéro du service, au format e164
caller_number
Numérique
Numéro de l’appelant, au format e164
date_in
Date
Date d’entrée dans le groupe, au format ISO 8601
duration
Numérique
Durée de l’appel, en seconde
rub_name
Alphanum
Nom de la rubrique ayant reçu l’appel
1.9 Configuration Voxpay
URL /vm/voxpay
Méthode(s)
GET
Format de la requête

La requête devra se faire sous la forme :

				
					curl "https://api.axialys.com/vm/voxpay" -u <login>:<password> -H "Content-Type: application/json" -X GET
				
			
Retour
Nom Type Description
id_appel
Numérique
Groupe
ope
Opération à effectuer
sub_amount
Numérique
Montant souscription
currency
AlphaNumérique
Devise
amount
Numérique
Montant
sub_count
Numérique
Nombre occurrences abonnement
sub_type
day,week,month,year
Unité occurrence
mode
sms,svi,online,choice
Méthode de paiement
can_change
Alphanum
Peut-être modifié