Guide Solutions MKT
Le guide des solutions MKT
API Aboutement Direct / call tracking
Introduction
Ce document décrit les fonctionnalités de l’offre Aboutement Direct disponibles de façon automatisée, par l’intermédiaire d’une API HTTP.
Le serveur, login et password sont communiqués sur demande. Tous les appels de fonctions se font de la façon suivante :
https://webservices. axialys.net/get/direct/api.php?login=votre_login&pass=votre_password&fonction=nom_fonction¶m1=val1¶m2=val2 …
Le cas échéant, les paramètres doivent être convenablement url-encodés, d’origine UTF-8 (RFC 3986).
1 - liste_appels
Cette fonction renvoie le détail des appels du client entre deux dates données.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
ia |
Chaine |
Oui |
Début de période concernée, format AAAAMMJJHHMMSS
|
|
ib |
Chaine |
Oui |
Fin de la période concernée, format AAAAMMJJHHMMSS. Doit être supérieur à ia |
|
num |
Chaine |
Non |
Filtre les appels sur un (ou plusieurs) numéros. Cette variable peut être présente à plusieurs reprises, en
spécifiant num[X]. NB: PHP automatise la gestion de cette syntaxe en passant un tableau en paramètre.
|
|
code_client |
Chaine |
Non |
Filtre les appels sur un (ou plusieurs) codes clients. Cette variable peut être présente à plusieurs reprises,
en spécifiant code_client[X]. NB: PHP automatise la gestion de cette syntaxe en passant un tableau en paramètre.
|
Retour :
Un fichier .csv à télécharger, à consulter via un éditeur de texte ou un tableur.
Le fichier CSV contient sur sa première ligne les noms de colonnes. Les colonnes sont séparées par des points-virgule. Les éventuels points-virgules dans les données seront remplacés par des virgules au moment de l’export.
| Colonne | Type | Description |
|---|---|---|
|
Date |
Chaine |
Date du début d’appel, au format AAAAMMJJHHMMSS
|
|
Numero
|
Chaine |
Numéro E164 du service
|
|
Destination |
Chaine
|
Numéro E164 de destination
|
|
Code_client |
Chaine |
Code client, tel qu’il était lors de l’appel
|
|
Appelant |
Chaine |
Numéro E164 de l’appelant
|
|
Duree_Sonnerie
|
Numérique |
Durée sonnerie (en sec)
|
|
Duree_SVI
|
Numérique |
Durée de connexion au SVI (aboutement inclus, le cas échéant)
|
|
Aboutement
|
Numérique |
Durée communication (en sec)
|
|
Prix Achat
|
flottant |
Prix payé pour l’acheminement
|
|
Statut_Aboutement
|
enum |
Status de fin d’appel
|
|
Commentaire |
Chaine |
Commentaire géré par le client
|
2 - set_config_numero
Cette fonction permet de définir la configuration d’un numéro.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
num |
Chaine |
Oui |
Le numéro concerné (format E.164)
|
|
code_client |
Chaine |
Non |
Le code clent. Axialys n’utilise pas cette information, elle n’a de sens que dans le SI du client.
|
|
predecroch e |
Bool |
Non |
Si oui, alors Axialys effectue un pré-décroché systématique sur tous les appels. Ceci a pour conséquence de taxer l’appelant. Attention : suivant le palier tarifaire du numéro, le positionnement de ce paramètre influencera (dé)favorablement le montant de la collecte / du reversement.
Si une annonce appelant est spécifiée, que ce paramètre est à non, et que le réseau de collecte l’autorise, alors l’éventuelle « annonce appelant » sera produite en ring back tone.
|
|
annonce_a ppelant
|
Chaine |
Non |
Message à diffuser à l’appelant en début d’appel (tel qu’uploadé dans l’interface extranet) |
|
annonce_a ppele
|
Chaine |
Non |
Message à diffuser à l’appelé avant de lui passer l’appel (tel qu’uploadé dans l’intefarce extranet)
|
|
route1 |
Chaine |
Non |
Numéro appelé en priorité
|
|
route2 |
Chaine |
Non |
Numéro appelé en secondaire (en cas d’indispo du premier numéro)
|
|
delai_route 1
|
Numérique |
Non |
Délai, en secondes, de sonnerie sur route1 avant de passer à route2
|
|
delai_route 2
|
Numérique |
Non |
Délai, en secondes, de sonnerie sur route2 avant de passer sur le répondeur s’il est défini
|
|
route1_com ment
|
Chaine |
Non |
Commentaire sur le route1
|
|
route2_com ment
|
Chaine |
Non |
Commentaire sur le route2
|
|
route1_calle r_id_type
|
Enum |
Non |
- ORIGINAL : le caller id est transmis à
l'appelé sans modification
- CALLED_NUMBER : on positionne en caller id
le numéro de call tracking attribué
- FWD_NUMBER : on positionne en caller id le
numero de destination appelé
- SPECIFIC : on positionne en caller id une
valeur spécifique |
|
route2_calle r_id_type
|
Enum |
Non |
- ORIGINAL : le caller id est transmis à
l'appelé sans modification
- CALLED_NUMBER : on positionne en caller id
le numéro de call tracking attribué
- FWD_NUMBER : on positionne en caller id le
numero de destination appelé
- SPECIFIC : on positionne en caller id une
valeur spécifique |
|
route1_calle |
Chaine |
Non |
caller id à positionner si le champ précédent |
r_id
vaut "SPECIFIC".
| route2_calle r_id | Chaine | Non | caller id à positionner si le champ précédent vaut "SPECIFIC". |
|---|---|---|---|
|
annonce_bv
|
Chaine |
Non |
caller id à positionner si le champ précédent
vaut "SPECIFIC". |
|
annonce_bv |
Chaine
|
Non |
Annonce pour introduction de la boite vocale. Si non défini, pas de boite vocale.
|
|
email |
Chaine |
Non |
Adresse email pour envoi des mails concernant les messages vocaux ou les appels manqués. Il est possible de spécifier jusqu’à 3 adresses différentes, qui doivent être séparées par un point-virgule.
|
|
commentaire
|
Chaine |
Non |
Chaine gérée par le client. |
Nota : si route1 et route2 sont vides ou non définis, il n’y aura pas d’appel sortant.
Retour :
OK – message de confirmation KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
- − « authentification fail » si le client n’est pas identifié
- − « numero inconnu » si le numéro à modifier n’est pas identifié
- − « num wrong format » le numéro n’est pas au format e164
3 - get_config_numero
Cette fonction permet d’obtenir le détail de configuration des numéros
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
num |
Chaine |
Non |
Le numéro concerné (format E.164), ou un préfixe.
|
Retour :
Un fichier .csv à télécharger, à consulter via un éditeur de texte ou un tableur.
Le fichier CSV contient sur sa première ligne les noms de colonnes. Les colonnes sont séparées par des points-virgule. Les éventuels points-virgules dans les données seront remplacés par des virgules au moment de l’export.
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
num |
Chaine |
Non |
Le numéro concerné (format E.164), ou un préfixe.
|
| Colonne | Type | Description |
|---|---|---|
|
Numero
|
Chaine |
Numéro E164 du service
|
|
Code_client |
Chaine
|
Code client, tel qu’il était lors de l’appel
|
|
Predecroche |
Bool |
Si oui, alors Axialys effectue un pré- décroché
|
|
Annonce_appelant |
Chaine |
Annonce à l’appelant
|
|
Annonce_appele
|
Chaine |
Annonce à l’appelé
|
|
Route1
|
Chaine |
Première destination d’appel
|
|
Route2
|
Chaine |
Seconde destination d’appel
|
|
Route1_comment
|
Alphanumérique
|
Commentaire route1 géré par le client
|
|
Route2_comment |
Alphanumérique
|
Commentaire route2 géré par le client
|
|
Delai_route1 |
Numérique |
Durée de sonnerie sur route1, avant bascule
|
|
Delai_route2
|
Numérique |
Durée de sonnerie sur route2, avant bascule
|
|
Route1_caller_id_ty pe
|
Enum |
– ORIGINAL : le caller id est transmis à l’appelé sans modification
– CALLED_NUMBER : on positionne en caller id le numéro de call tracking attribué – FWD_NUMBER : on positionne en caller id le numero de destination appelé
– SPECIFIC : on positionne en caller id une valeur spécifique
|
|
Route2_caller_id_ty pe
|
Enum |
– ORIGINAL : le caller id est transmis à l’appelé sans modification |
– CALLED_NUMBER : on positionne en caller id le numéro de call tracking attribué – FWD_NUMBER : on positionne en caller id le numero de destination appelé
– SPECIFIC : on positionne en caller id une valeur spécifique
| Colonne | Type | Description |
|---|---|---|
|
Route1_caller_id
|
Chaine |
caller id utilisé si le champ caller_id_type vaut “SPECIFIC”.
|
|
Route2_caller_id |
Chaine
|
caller id utilisé si le champ caller_id_type vaut “SPECIFIC”.
|
|
Annonce_bv |
Chaine |
Message d’annonce de la boite vocale
|
|
Email |
Chaine |
Adresse(s) mail pour appels manqués et messages vocaux (séparateur « , »)
|
|
Collecte
|
flottant |
Montant de la collecte, en EUR HT/mn
|
|
Reversement
|
flottant |
Montant des reversements, en EUR HT/mn
|
|
Abonnement
|
flottant |
Montant de l’abonnement mensuel pour ce numéro, en EUR HT
|
4 - add_numero
Cette fonction permet d’acheter un numéro. paramètres
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
zone |
Chaine |
Oui |
Zone dont on souhaite obtenir un numéro. Ex : 331, 332, 333, 334, 335
.
|
Retour :
OK – message de confirmation, suivi du nouveau numéro attribué. Attention, il peut s’écouler une dizaine de minutes avant que le numéro soit réellement actif.
KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « authentification fail » si le client n’est pas identifié
− « zone unavailable » zone inconnue
− « number not find » aucun numéro trouvé pour la zone sélectionné (contacter axialys)
− « wrong fonction » vous n’avez pas les droits nécessaires pour acheter un numéro
5 - del_numero
Cette fonction permet d’acheter un numéro. paramètres
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
num |
Chaine |
Oui |
Numéro à résilier
.
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.
Retour :
OK – message de confirmation, suivi du nouveau numéro attribué. Attention, il peut s’écouler une dizaine de minutes avant que le numéro soit réellement actif.
KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « authentification fail » si le client n’est pas identifié
− « bad_number » numéro inexistant ou ne vous appartient pas
− « config unset failed» suppression configuration numéro échouée
6 - planning_plage_add
Cette fonction permet d’ajouter une plage horaire hebdomadaire, dans le cas où la plage n’existe pas, elle est créée. Il est tout a fait possible d’ajouter plusieurs plages en même temps.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
nom_plage |
Chaine |
Oui |
Nom de la plage
|
|
jours |
Liste |
Oui |
Lundi,mardi,mercredi,jeudi,vendredi, samedi,dimanche
|
|
heure_deb |
Liste |
Oui |
HH:MM heure de début
|
|
heure_fin |
Liste |
Oui |
HH:MM heure de fin
|
Retour :
OK – la plage horaire a bien été ajoutée
KO – message d’erreur
Liste (non exhaustive) des messages d’erreur : − « axialys error » recherche plage échouée
7 - planning_plage_del
Cette fonction permet de supprimer une plage horaire hebdomadaire.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
nom_plage |
Chaine |
Oui |
Nom de la plage
|
|
jours |
Liste |
Oui |
Lundi,mardi,mercredi,jeudi,vendredi, samedi,dimanche
|
|
heure_deb |
Liste |
Oui |
HH:MM heure de début
|
|
heure_fin |
Liste |
Oui |
HH:MM heure de fin
|
Retour :
OK – la ou les plages configurées ont bien été supprimées KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « axialys error » recherche plage échouée
8 - planning_exception_add
Cette fonction permet d’ajouter une plage horaire exceptionnelle.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
nom_plage |
Chaine |
Oui |
Nom de la plage
|
|
mois |
Entier |
Oui |
Numéro du mois « janvier »=1, « février »=2
|
|
date |
Entier |
Oui |
Date, 1 à 31
|
|
annee |
Entier |
Oui |
Annéé YYYY
|
|
heure_deb |
Chaine |
Oui |
HH:MM heure de début
|
|
heure_fin |
Chaine |
Oui |
HH:MM heure de fin
|
Retour :
OK – la plage horaire a bien été ajoutée
KO – message d’erreur
Liste (non exhaustive) des messages d’erreur : − « axialys error » recherche plage échouée
9 - planning_exception_del
Cette fonction permet de supprimer une plage horaire exceptinnelle.
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
nom_plage |
Chaine |
Oui |
Nom de la plage
|
|
mois |
Entier |
Oui |
Numéro du mois « janvier »=1, « février »=2
|
|
date |
Entier |
Oui |
Date, 1 à 31
|
|
annee |
Entier |
Oui |
Annéé YYYY
|
|
heure_deb |
Chaine |
Oui |
HH:MM heure de début
|
|
heure_fin |
Chaine |
Oui |
HH:MM heure de fin
|
Retour :
OK – la plage exceptionnelle a bien été supprimée KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « axialys error » recherche plage échouée
10 - planning_plages_listing
Retourne la liste des plages horaires configurées
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
Retour :
OK – Retourne la liste des plages horaires existantes, une ligne par plage KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « axialys error » recherche plage échouée
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
11 - planning_plage_details
Retourne le détail d’une plage horaire
Paramètres :
| Paramètre | Type | Oblig. | Description |
|---|---|---|---|
|
login |
Chaine |
Oui |
Login(email) du client pour accès à l’API
|
|
pass |
Chaine |
Oui |
Password associé au login
|
|
nom_plage |
Chaine |
Oui |
Nom de la plage
|
Retour :
OK – Retourne le détail de la plage horaire sélectionnée on peut avoir 2 types de lignes selon que l’on se trouve ddans le cas d’une plage exceptionnel ou hebdommadaire :
1. regulier;<jour>;<heure_deb>;<heure_fin>
2. exception;<DD>/<MM>/<YYYY><HH>:<MM> KO – message d’erreur
Liste (non exhaustive) des messages d’erreur :
− « axialys error » recherche plage échouée
- Table des matières
