Guide voice management

LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER

Retour au guide

API gestion des appels sortants et campagnes

Cette API permet de gérer les appels à effectuer, soit en appels sortants unitaires, soit sous forme de campagne d’appels sortants.

L’API permet ainsi de :

  1. Demander un nouvel appel sortant
  2. Consulter l’état d’un appel sortant
  3. Consulter l’état d’un appel sortant

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 suivants (en plus des paramètres spécifiques) :

Nom Type Oblig. Description
auth_id
Alphanum 32
Y
Identifiant utilisateur API
auth_password
Alphanum 32
Y
Mot de passe
1.2 Retour

En cas de succès, l’API répond 200 OK ainsi que les champs spécifiques à la fonction appelée.

En cas d’erreur, un code retour HTTP approprié est utilisé et le message JSON contiendra les champs suivants :

Nom Type Description
status
Num
Code de retour HTTP
err_code
Alphanum 16
OK en cas de succès, ou un code d’erreur spécifique, par exemple INVALID_AUTH
err_msg
Alphanum
Message d’erreur (lisible par un humain)

2 - Gestion des campagnes

L’usage des campagnes est optionnel : il permet d’avoir un suivi et une visualisation d’un ensemble d’appels à effectuer.

L’API propose les fonctions suivantes :

  1. Créer une nouvelle campagne
  2. Modifier une campagne
  3. Consulter l’état d’une campagne (statistiques)
2.1 Créer une nouvelle campagne
URL /vm/campaign
Méthode(s)
POST
Paramètres
Nom Type Défaut Oblig. Description
name
Alphanum 32
Y
Nom de la campagne à créer sans espace ni caractères spéciaux (tiret, underscore, pourcentage, etc.)
record
Bool
0
N
Activation de l’enregistrement de tous les appels pour cette campagne. NB: même si cette valeur est à 0, l’enregistrement peut être actif pour d’autres raisons (par exemple, configuré sur un agent)
Retour
Nom Type Description
id_campaign
Num
Identifiant de la nouvelle campagne, à utiliser pour d’autres appels d’API
2.2 Modifier une campagne
URL /vm/campaign/‹id_campaign›
Méthode(s)
POST
Paramètres
Nom Type Défaut Oblig. Description
name
Alphanum 32
N
Nouveau nom de la campagne
record
Bool
0
N
Activation de l’enregistrement de tous les appels pour cette campagne. NB: même si cette valeur est à 0, l’enregistrement peut être actif pour d’autres raisons (par exemple, configuré sur un agent)
pause
Bool
N
Dés/activation de la mise en pause de la campagne (inchangé si paramètre absent)
Retour
Nom Type Description
id_campaign
Num
Identifiant de la campagne
name
Alphanum 32
Nom de la campagne
pause
Bool
Indication de pause de la campagne
record
Bool
Indication de l’enregistrement activé
2.3 Annuler une campagne
URL /vm/campaign/‹id_campaign›/cancel
Méthode(s)
POST
Paramètres

Aucun

Nom Type Description
id_campaign
Num
Identifiant de la campagne
name
Alphanum 32
Nom de la campagne
pause
Bool
Indication de pause de la campagne
record
Bool
Indication de l’enregistrement activé
2.4 Consulter l’état d’une campagne
URL /vm/campaign/‹id_campaign›
Méthode(s)
GET
Paramètres

Aucun

Nom Type Description
id_campaign
Num
Identifiant de la campagne
name
Alphanum 32
Nom de la campagne
pause
Bool
Indication de pause de la campagne
record
Bool
Indication de l’enregistrement activé
total_calls_count
Num 8
Nombre total d’appels à passer
ok_status_count
Num 8
Nombre d’appels réussis
ko_status_count
Num 8
Nombre d’appels en échec
pending_status_count
Num 8
Nombre d’appels encore à effectuer

3 - Gestion des appels sortants

3.1 Demander un nouvel appel sortant
URL /vm/outbound_call
Méthode(s)
POST
Format des requêtes

Les requêtes devront se faire sous la forme

				
					curl -u <username>:<password> "https://api.axialys.com/vm/outbound_call" -X POST -d '{"dest_number":<numéro>,"id_agent":<id_agent>}'
Paramètres
Nom Type Défaut Oblig. Description
id_campaign
Num
N
Identifiant de la campagne de laquelle l’appel fait partie
type
AUTO/MANUAL
MANUAL
N
Type pour passer l’appel sortant. AUTO : l’appel est automatiquement lancé dès qu’un agent est libre, MANUAL l’agent doit valider le lancement de l’appel
id_agent
Num 10
O/N
L’agent qui va devoir faire l’appel (obligatoire si un groupe n’est pas choisi)
id_group
Num 10
O/N
Le groupe d’agents qui va devoir faire l’appel (obligatoire si un opérateur n’est pas choisi)
dest_number
Alphanum 1024
O
Un ou plusieurs numéros de destinataires en fonction de s’il s’agit d’une campagne ou d’un appel sortant unitaire (sous le format E.164 sans +, séparés par des virgules). Ex: 33170200200,33634123452
priority
Num 3
100
N
Priorité d’appel; par défaut 100; si la valeur est inférieure, alors cet appel sera prioritaire; si elle est supérieure, il sera non prioritaire
variables
Alphanum 255
N
Variables spécifiques à l’appel, présentées dans la popup et utulisables pour le suivi statistiques. Format de type structure JSON. Ex: {“nom_valeur1”:“valeur1”,“nom_valeur2”:“valeur2”}
ring_timeout
Num 4
30
N
Temps max de sonnerie, en seconde
retries
Num 4
3
N
Nombre maximum de tentative de rappel en cas d’échec
retry_timeout
Num 4
300
N
Temps (minimal) entre chaque nouvelle tentative, en secondes
auto_timeout
Num 4
0
N
Temps (minimal) avant le déclenchement automatique de l’appel, en secondes
unassign_timeout
Num 4
60
N
Temps maximum qu’a l’opérateur pour passer l’appel avant attribution à un autre opérateur, en secondes
start_from_date
Date/Heure
Maintenant
N
Date de début pour passer un ou plusieurs appels, sous forme ISO8601. Ex: 2016-11-05T09:00
end_before_date
Date/Heure
Aucun
N
Date de fin pour passer un ou plusieurs appels, sous forme ISO8601
start_from_hour
Heure
N
Heure (quotidienne) de début pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
end_before_hour
Heure
N
Heure (quotidienne) de fin pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
Id_msg_op
Num
N
Identifiant du message sonore à jouer à l’opérateur
Il est possible d’assigner des appels sortants à un agent d’un groupe si “id_agent” et “id_group” sont renseignés dans la même requête.
Retour
Nom Type Description
id_out_call
Num
Un à plusieurs identifiants de numéros de destinataires en fonction de s’il s’agit d’une campagne ou d’un appel sortant unitaire, séparés par des virgules
3.2 Consulter l’état d’un appel sortant
URL /vm/outbound_call/‹id_out_call›
Méthode(s)
GET
Paramètres

Aucun

Retour

Les champs identiques à ceux passés lors de la création de l’appel sont retournés, avec en plus :

Nom Type Description
date_submitted
Date/Heure
Date de création, sous forme ISO8601
alloc_to_id_agent
Num
Identifiant de l’agent ayant passé l’appel
status
PENDING/ASSIGNED/DIALING/CONNECTED/SUCCESS/FAILURE
Statut de l’appel
call_date
Date/Heure
Date de l’appel passé (ou de la dernière tentative), sous forme ISO8601
answered_duration
Num
Durée de l’appel (en secondes)
failure_reason
Alphanum 16
Raison de l’échec
record
URL
URL de la ressource sonore si disponible et droit activé
3.3 Supprimer un ou des appels sortants
URL /vm/outbound_call
Méthode(s)
DELETE
Seul les demandes dans l’état PENDING sont impactées par cette méthode
Format des requêtes

Les requêtes devront se faire sous la forme

				
					

curl -u <username>:<password> "https://api.axialys.com/vm/outbound_call" -X DELETE -d '{"dest_number":<numéro>,"id_agent":<id_agent>}'
Paramètres
Nom Type Défaut Oblig. Description
id_campaign
Num
N
Identifiant de la campagne de laquelle l’appel fait partie
type
AUTO/MANUAL
MANUAL
N
Type pour passer l’appel sortant. AUTO : l’appel est automatiquement lancé dès qu’un agent est libre, MANUAL l’agent doit valider le lancement de l’appel
dest_number
Alphanum 1024
O
Un ou plusieurs numéros de destinataires en fonction de s’il s’agit d’une campagne ou d’un appel sortant unitaire (sous le format E.164 sans +, séparés par des virgules). Ex: 33170200200,33634123452
priority
Num 3
100
N
Priorité d’appel; par défaut 100; si la valeur est inférieure, alors cet appel sera prioritaire; si elle est supérieure, il sera non prioritaire
variables
Alphanum 255
N
Variables spécifiques à l’appel, présentées dans la popup et utulisables pour le suivi statistiques. Format de type structure JSON. Ex: {“nom_valeur1”:“valeur1”,“nom_valeur2”:“valeur2”}
ring_timeout
Num 4
30
N
Temps max de sonnerie, en seconde
retries
Num 4
3
N
Nombre maximum de tentative de rappel en cas d’échec
retry_timeout
Num 4
300
N
Temps (minimal) entre chaque nouvelle tentative, en secondes
auto_timeout
Num 4
0
N
Temps (minimal) avant le déclenchement automatique de l’appel, en secondes
unassign_timeout
Num 4
60
N
Temps maximum qu’a l’opérateur pour passer l’appel avant attribution à un autre opérateur, en secondes
start_from_date
Date/Heure
Maintenant
N
Date de début pour passer un ou plusieurs appels, sous forme ISO8601. Ex: 2016-11-05T09:00
end_before_date
Date/Heure
Aucun
N
Date de fin pour passer un ou plusieurs appels, sous forme ISO8601
start_from_hour
Heure
N
Heure (quotidienne) de début pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
end_before_hour
Heure
N
Heure (quotidienne) de fin pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
id_agent
Num 10
N
L’agent qui va devoir faire l’appel (obligatoire si un groupe n’est pas choisi)
id_group
Num 10
N
Le groupe d’agents qui va devoir faire l’appel (obligatoire si un opérateur n’est pas choisi)
Retour

Nombre d’appels impactés.

3.4 Modifier un ou des appels sortants
URL /vm/outbound_call
Méthode(s)
PUT
Format des requêtes

Les requêtes devront se faire sous la forme

				
					curl -u <username>:<password> "https://api.axialys.com/vm/outbound_call" -X PUT -d '{"dest_number":<numéro>,"id_agent":<id_agent>}'
Paramètres
Nom Type Défaut Oblig. Description
id_campaign
Num
N
Identifiant de la campagne de laquelle l’appel fait partie
type
AUTO/MANUAL
MANUAL
N
Type pour passer l’appel sortant. AUTO : l’appel est automatiquement lancé dès qu’un agent est libre, MANUAL l’agent doit valider le lancement de l’appel
id_agent
Num 10
O/N
L’agent qui va devoir faire l’appel (obligatoire si un groupe n’est pas choisi)
id_group
Num 10
O/N
Le groupe d’agents qui va devoir faire l’appel (obligatoire si un opérateur n’est pas choisi)
dest_number
Alphanum 1024
O
Un ou plusieurs numéros de destinataires en fonction de s’il s’agit d’une campagne ou d’un appel sortant unitaire (sous le format E.164 sans +, séparés par des virgules). Ex: 33170200200,33634123452
priority
Num 3
100
N
Priorité d’appel; par défaut 100; si la valeur est inférieure, alors cet appel sera prioritaire; si elle est supérieure, il sera non prioritaire
variables
Alphanum 255
N
Variables spécifiques à l’appel, présentées dans la popup et utulisables pour le suivi statistiques. Format de type structure JSON. Ex: {“nom_valeur1”:“valeur1”,“nom_valeur2”:“valeur2”}
ring_timeout
Num 4
30
N
Temps max de sonnerie, en seconde
retriesv
Num 4
3
N
Nombre maximum de tentative de rappel en cas d’échec
retry_timeout
Num 4
300
N
Temps (minimal) entre chaque nouvelle tentative, en secondes
auto_timeout
Num 4
60
N
Temps (minimal) avant le déclenchement automatique de l’appel, en secondes
unassign_timeout
Num 4
60
N
Temps maximum qu’a l’opérateur pour passer l’appel avant attribution à un autre opérateur, en secondes
start_from_date
Date/Heure
Maintenant
N
Date de début pour passer un ou plusieurs appels, sous forme ISO8601. Ex: 2016-11-05T09:00
end_before_date
Date/Heure
Aucun
N
Date de fin pour passer un ou plusieurs appels, sous forme ISO8601
start_from_hour
Heure
N
Heure (quotidienne) de début pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
end_before_hour
Heure
N
Heure (quotidienne) de fin pour passer un ou plusieurs appels, sous forme ISO8601 ou HH:MM:SS
Id_msg_op
Num
N
Identifiant du message sonore à jouer à l’opérateur
Retour

Nombre d’appels impactés.

  • Table des matières