API historique des appels

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 :

NomTypeDéfautOblig.Description
loginAlphanum 32OIdentifiant utilisateur API
passwordAlphanum 32OMot de passe

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

NomTypeDéfautOblig.Description
dateYYYY-MM-DDODate de début ou date du jour demandé
date_endYYYY-MM-DDNDate de fin, max 1 mois par rapport à la date de début
service_numberNumériqueNNuméro de service, au format e164
caller_numberNumériqueNNuméro de l'appelant, au format e164

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

NomTypeDescription
id_appelNumériqueidentifiant de l'appel
dateDateDate, au format ISO 8601
service_numberNumériqueNuméro du service, au format e164
caller_numberNumériqueNuméro de l'appelant, au format e164
cpNumériqueCode postal de l'appelant
post_appelNumériqueDurée pause, en seconde
duration_ringNumériqueDurée de sonnerie, en seconde
durationNumériqueDurée de l'appel, en seconde
statusAlphanumStatut de l'appel sortant
group_nameAlphanumNom du groupe ayant reçu l'appel
op_nameAlphanumNom de l'opérateur ayant reçu l'appel
rub_nameAlphanumNom de la rubrique ayant reçu 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.

1.3 Historique des appels sortants

URL/vm/calls/out
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/out" -u <login>:<pass> -H "Content-Type: application/json" -d '{"date":"<YYYY-MM-DD>, " date_end ":"<YYYY-MM-DD>", "service_number":"<e164>", "called_number":"<e164>" }' -X POST

Retour

NomTypeDescription
id_appelNumériqueidentifiant de l'appel
dateDateDate, au format ISO 8601
service_numberNumériqueNuméro du service, au format e164
caller_numberNumériqueNuméro de l'appelant, au format e164
cpNumériqueCode postal de l'appelant
post_appelNumériqueDurée pause, en seconde
duration_ringNumériqueDurée de sonnerie, en seconde
durationNumériqueDurée de l'appel, en seconde
statusAlphanumStatut de l'appel sortant
group_nameAlphanumNom du groupe ayant reçu l'appel
op_nameAlphanumNom de l'opérateur ayant reçu l'appel
rub_nameAlphanumNom de la rubrique ayant reçu l'appel
L'id_appel d'un appel sortant est précédé d'un “-”.

1.4 Inventaires des statuts des appels

Commun aux deux types :

NomDescription
ANSWERrépondu
BUSYoccupé
NOANSWERnon répondu
UNKNOWNinconnu
CANCELannulé
CONGESTIONcongestion
CHANUNAVAILchannel indisponible

Spécifique aux appels entrants :

NomDescription
NOpas d'aboutement
CALLBACKcallback
VOICEMAILboite vocale