API Webappel

Pour commencer...

Ce document décrit les différentes fonctionnalités de notre API WebAppel ainsi que le procédé de mise en œuvre en vue d’une intégration à votre système d’information.

Vous pourrez ainsi :

  • Gérer vos pop-ups
  • Gérer votre service vocal (message d’annonce, répondeur, voix, langue…)
  • Récupérer/visualiser le détail des appels

Haut de page

Introduction

Axialys a conçu une plateforme qui permet de faire du callback, en vous mettant en relation directe avec les internautes qui souhaitent vous contacter. Afin que vous puissiez intégrer notre plateforme à votre système d’informations, nous avons conçu cette API.

Cette documentation va vous permettre de comprendre comment utiliser cette API afin de gérer/visualiser :

  • Vos pop-ups
  • Votre service vocal (message d’annonce, répondeur, voix, langue…)
  • Le détail des appels

Ce document spécifie le protocole de communication HTTP utilisé pour la mise en place de WebAppel afin d’interconnecter votre système à la plateforme d’Axialys, afin que vous puissiez piloter votre service.

Avant de passer à la suite du document, assurez-vous de bien avoir lu la documentation concernant la configuration du service via extranet et munissez-vous des paramètres de connexion utilisés pour vous connecter via notre extranet. Si jamais vos paramètres de connexion ne fonctionnaient pas, assurez-vous auprès de votre commercial que l’API a été activée pour votre compte. Toutes les méthodes qui vont suivre retournent ‘OK’. Dans le cas contraire le format des données retournées sera spécifié.

Dans la suite du document, nous commencerons par une présentation des différentes variables utilisées par l’API, suivie de la présentation des différentes méthodes disponibles. Chaque méthode sera suivie d’un exemple d’utilisation avec éventuellement le format des valeurs retournées.

Nous avons utilisé pour cela les cadres suivants :

Exemple Valeur retournée

Remarque : à l’heure actuelle, il n’est pas possible de gérer les plages horaires via l’API, il faudra donc les créer via l’extranet. Vous pourrez ensuite attribuer via l’API vos plages horaires aux pop-ups 

Haut de page

Les différentes variables utilisées par notre API

VariableObligatoireValeurDescriptionExemple
emailoui Votre identifiant sur notre extranet[email protected]
passoui Votre mot de passe sur notre extranetaxialys
methodeoui Nom de l’action a effectueroperateur_ajout_e164
e164oui[0-9]+Numéro au format e16433820620620
code_paysnon[A-Z][A-Z]Code pays pour formatage du numéro 
nom_liste_opoui[a-zA-Z0-9]+Nom d’une liste d’opérateurs. Ce nom doit être uniquelist_op1
prioritenon10 –> 1000Position d’un numéro dans une liste d’opérateurs1
ordonnancementouiFIXE / RANDOM / TOURNANTEOrdre selon lequel les différents opérateurs d’une liste de numéros sont appellés : respect position, aléatoire, respect position en tenant compte des appels des autres internautes (FIXE par défaut)FIXE
duree_sonnerie_opnon10 –> 1000Durée de la sonnerie de l’opérateur60
ipouixxx.xxx.x.xAdresse IP192.168.0.1
nom_plageoui[a-zA-Z0-9]+Nom permettant de regrouper un ensemble d’heures ouvrées et jours exceptionnellement fermésplage1
jourouilundi, mardi, mercredi, jeudi, vendredi, samedi, dimancheJours de la semainelundi
h_debutoui00:00 –> 23:59Heure de début d’une plage ouvrée10:00
h_finoui00:00 –> 23:59Heure de fin d’une plage ouvrée18:00
répondeurnon[email protected]Adresse email sur laquelle envoyer les messages laissés par les internautes lors des indisponibilités ou heures fermées, si aucune adresse n’est définie alors le répondeur est désactivé 
date_debutouiYYYY-MM-DDDate de début des statistiques2016-01-01
date_finouiYYY-MM-DDDate de fin des statistiques2016-06-30
delaisnon10 –> 1000Permet d’effectuer le rappel avec un délai (la valeur est en secondes)30
nomnon*Nom de l’internauteJade
usr1, usr2, usr3non*Variables personnalisables (32 caractères)RXF46GSDG
date_timeouiYYYY-MM-DD HH:ii:ss 2016-08-06 15:05:26
dureeoui[10, 10000]Durée de l’appel10
directionnonOPERATEUR DE L’INTERNAUTEDirection du premier appelINTERNAUTE
nom_popupoui[a-zA-Z0-9]+Nom de la pop-upPopup1
destination Nom destinationFrance mobile
id_destinationoui Identifiant destination1004
id_popupoui5 –> 1000Identifiant popup197
op_delais_attentenon5 –> 1000Durée durant laquelle on réessaiera de passer un appel vers le conseiller10
internaute_delais_attentenon5 –> 1000Durée de sonnerie de l’internaute20
id_trackingnon Identifiant de la demande de l’inetrnaute qui permet de récupérer les informations concernant son appel 
usr1_nom, usr2_nom, usr3_nomnon[a-zA-Z0-9]+Valeur des champs personnalisables. Si ces valeurs ne sont pas renseignées, les champs n’appaîtront pas sur la pop-upJean
afficher_nomnon1/0Affichage du champs nom0
immediatnon1/0Désactive la sélection pour les appels différés1
op_presentationnon[0-9]+Numéro présenté à l’opérateur0820620620
internaute_presentationnon[0-9]+Numéro présenté à l’internaute0820620620
localenonfr/enLangue utilisée par le service, aussi bien dans la pop-up que dans les messages systèmes du service vocalfr
voixnonm/fVoix masculine ou fémininef
nom_plagenon[a-zA-Z0-9]+Nom de la plage horaire 
ouvert_destnon[a-zA-Z0-9]+Groupe d’opérateurs à appeler durant les heures d’ouverture 
ouvert_messagenon*Message de la popup durant les heures ouvréesPour+être+mis+en+relation+entrez+votre+numéro
ferm_destnon[a-zA-Z0-9]+Groupe d’opérateurs à appeler durant les heures fermées 
ferm_messagenon[a-zA-Z0-9]+Message de la popup durant les heures ferméesnotre+entreprise+est+fermée
typeouison_internaute; son_operateurType de fichier à traiter lors de la suppression, upload ou récupération de fichiers. Un seul fichier peut être traité à la fois 
son_internauteoui[a-zA-Z0-9]+Son joué à l’internaute avant la mise en relationaccueil.wav
son_operateuroui[a-zA-Z0-9]+Son joué à l’opérateur avant la mise en relationpres.wav
son_repondeuroui[a-zA-Z0-9]+Son utilisé pour paramétrer le répondeurrepondeur.wav
entete_popupoui[a-zA-Z0-9]+Image affichée dans l’en-tête de la popuplogo.jpg
css_popupoui[a-zA-Z0-9]+Feuille de style utilisée par la popupstyle.css
nbressaisnon[0-9]Nombre de tentatives de rappel 
recoui[a-zA-Z0-9]+\jpgEnregistrement 
client_ipoui[a-zA-Z0-9]+\jpgAdresse IP du client transmis, utilisée our vérifier si le client est blacklisté dans le cas où l’option api_DoS_proectect est activée 
dureemaxinon[0-9]Durée maximale de l’appel 
liste_destinationoui[A-Z] {2,2,}_(Fixe/Mobile)Permet de spécifier les destinations en fournissant le code paus et le type de destination associée (Fixe ou Mobile)FR_Fixe

L’ensemble des variables suivantes seront envoyées via la méthode GET de HTTP, hormis les fichiers qui seront envoyés via la méthode POST (‘son_internaute’, ‘son_operateur’, ‘son_repondeur’, ‘entete_popup’,‘css_popup’). L’URL à utiliser sera : https://webservices.axialys.net/get/webappel/api.php?

Notre serveur répondra immédiatement, en retournant le message ‘OK’. Dans le cas où l’on attend une valeur de retour particulière, le format de la valeur de retour sera spécifié.

Haut de page

Gestion des groupes d’opérateurs

Les fonctions suivantes vous permettront de gérer et de définir l’ordonnancement d’ensemble de numéros à utiliser lors des rappels. Nous avons pour cela à notre disposition 7 méthodes :

  • operateurs_liste_groupes : listing des groupes d’opérateurs créés
  • operateur_ajout : ajout d’un numéro à une liste d’opérateurs
  • operateur_supp : suppression d’un numéro d’une liste d’opérateurs
  • operateurs_listing : listing des numéros d’un groupe
  • operateur_mode : ordonnancement des numéros d’un groupe
  • blacklistage_numero : blocage des appels vers un numéro de téléphone donné
  • blacklistage_IP : blocage des appels provenant d’une IP donnée

Récupération du listing de l’ensemble des groupes d’opérateurs créés.

  • Méthode : operateurs_liste_groupes
  • Obligatoires : email, pass

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=operateurs_liste_groupes&[email protected]&pass=a

Le fichier retourné a la forme suivante : nom_liste_op;ordonnancement

Ajout d’un opérateur à une liste d’opérateurs. Si la liste n’existe pas, elle est créée.

  • Méthode : operateur_ajout
  • Obligatoires : email, pass, nom_liste_op, e164, duree_sonnerie_op
  • Facultatif : position

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=operateur_ajout&[email protected].

Suppression d’un opérateur d’une liste donnée.

  • Méthode : operateur_supp
  • Obligatoires : email, pass, nom_liste_op, e164

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=operateur_supp&[email protected]&pass=a&nom_liste_op=maliste&e164=33820620620

Listing des opérateurs appartenant à une liste donnée.

  • Méthode : operateurs_listing
  • Obligatoires : email, pass, nom_liste_op

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=operateurs_listing&[email protected]&pass=a&nom_liste_op=maliste

Le fichier retourné à la forme suivante : E164;duree_sonnerie_op;ordre;position

Configuration de l’ordonnancement selon lequel les différents numéros d’une liste seront appelés.

  • Méthode : operateur_mode
  • Obligatoires : email, pass, nom_liste_op, ordonnancement

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=operateur_mode&[email protected]&pass=a&nom_liste_op=maliste&ordonnancement=FIXE

Black listing d’un numéro ou d’une adresse IP (= plus aucun appel ne sera émis vers cette IP).

  • Méthode : blacklistage_numero
  • Obligatoires : email, pass, e164

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=blacklistage_numero&[email protected]&pass=a&e164=33820620620

Black listing d’un numéro ou d’une adresse IP (= plus aucun appel ne sera émis vers cette IP).

  • Méthode : blacklistage_IP
  • Obligatoires : email, pass, ip

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=blacklistage_IP&[email protected]&pass=a&ip=127.0.0.1

Haut de page

Gestion planning

Les fonctions suivantes permettent de paramétrer des plages horaires : horaires d’ouvertures, jours exceptionnellement fermés… Nous disposons pour cela de 6 méthodes :

  • planning_plage_add : ajout d’une plage horaire d’ouverture hebdomadaire
  • planning_plage_del : suppression d’une plage horaire d’ouverture hebdomadaire
  • planning_exception_add : ajout d’un jour de fermeture exceptionnelle
  • planning_exception_del : suppression d’un jour de fermeture exceptionnelle
  • planning_plages_listing : listing des horaires d’ouverture hebdomadaire
  • planning_plage_details : listing des horaires de fermetures exceptionnelles

Permet d’ajouter une plage ouvrée dans les jours normaux d’ouverture, si la liste de plages n’existe pas, elle est créée automatiquement. Attention, les variables « jour », « h_debut », « h_fin » doivent être sous la forme de tableau et il est également permis de rentrer, en une seule fois, l’ensemble du planning d’une semaine.

  • Méthode : planning_plage_add
  • Obligatoires : email, pass, nom_plage,jour,h_debut,h_fin

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=planning_plage_add&[email protected]&pass=a&nom_plage=maplage&jour[]=lundi&h_debut[]=9:00&h_fin[]=12:00

Permet de supprimer une plage ouvrée.

  • Méthode : planning_plage_del
  • Obligatoires : email, pass, nom_plage,jour,h_debut,h_fin

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=planning_plage_del&[email protected]&pass=a&nom_plage=maplage&jour[]=lundi&h_debut[]=9:00&h_fin[]=12:00

Permet d’ajouter un jour de fermeture exceptionnelle. Si la liste de plages n’existe pas, elle est créée automatiquement.

  • Méthode : planning_exception_add
  • Obligatoires : email, pass, nom_plage, date, mois, annee

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=planning_ajout_exception&[email protected]&pass=a&nom_plage=maplage&date=10&mois=3&annee=2008

Permet de supprimer un jour de fermeture exceptionnelle.

  • Méthode : planning_exception_del
  • Obligatoires : email, pass, nom_plage,date

Exemple : https://webservices.axialys.net/get/w ebappel/api.php?methode=planning_ajout_exception&[email protected]&pass=a&nom_plage=maplage&date=10&mois=3&annee=2008

Fourni le listing des horaires d’ouverture.

  • Méthode : planning_plages_details
  • Obligatoires : email, pass, nom_plage

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=planning_plage_details&[email protected]&pass=a&nom_plage=maplage

Cette méthode retourne aussi bien les horaires hebdomadaires que les jours exceptionnellement fermés, les données ont la forme suivante : regulier;<jour> ;<h_debut>;<h_fin> exception ;<DATE>

Fournit le listing des plages configurées disponibles.

  • Méthode : planning_plages_listing
  • Obligatoires : email, pass, nom_plage

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=planning_plages_listing&[email protected]. com&pass=a

Cette méthode retourne la liste des plages disponibles sous la forme d’un nom par ligne.

Haut de page

Gestion pop-up et vocal

Les fonctions suivantes permettent de paramétrer les pop-ups ainsi que le service vocal. C’est également ici que l’on définit les groupes d’opérateurs et les plages horaires à utiliser. Pour configurer la pop-up et le service vocal, nous disposons de 6 méthodes :

  • popups_listing : listing des popups créées
  • popup_ajout : ajout d’une popup
  • popup_maj : mise à jour d’une popup existante
  • popup_destinations : listing des destinations autorisées
  • popup_destination_ajout : ajout d’une destination autorisée
  • Suppression destination : interdiction d’une destination

Récupération du listing de l’ensemble des pop-ups créées, avec le détail de leur configuration.

  • Méthode : popups_listing
  • Obligatoires : email, pass

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popups_listing&[email protected]&pass=a

Cette méthode retourne les destinations sur le format suivant : id_popup;nom_popup;immediat;direction;locale;voix;premier_about; num_pres_operateur;timeout_operateur;num_pres_client;timeout_client; message_popup;id_dest_about_ouvert;message_ferme; id_dest_about_ferme;repondeur;show_name;usr1_name;usr2_name;usr3_name;son_operateur;son_ internaute;son_repondeur;entete_popup;css_popup

Crée une nouvelle popup.

  • Méthode : popup_ajout
  • Obligatoires : email, pass, nom_popup
  • Facultatifs : direction, nom_plage, internaute_delais_attente, op_delais_attente, locale, voix, numero_op, numero_internaute, ouvert_dest, ferme_dest, email, ouvert_message, ferme_message, immediat, nom_ plage, internaute_presentation, op_presentation, locale, voix, repondeur, usr1_nom, usr2_nom, usr3_nom, afficher_nom

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popup_ajout&[email protected]&pass=a&nom_popup=mapopup

Retourne l’identifiant de la pop-up ‘id_popup’ créée à utiliser pour créer l’URL ou qui devra être utilisée lors des modifications futures.

Modification d’une pop-up existante

  • Méthode : popup_maj
  • Obligatoires : email, pass, id_popup
  • Facultatifs : nom_popup, direction, nom_plage, internaute_delais_attente, op_delais_attente, locale, voix, numero_op, numero_internaute, ouvert_dest, ferme_dest, email, ouvert_message, ferme_message, immediat, nom_plage, internaute_presentation, op_presentation, locale, voix, repondeur, usr1_nom, usr2_ nom, usr3_nom, afficher_nom

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popup_maj&[email protected]&pass=a&nom_popup=nouveaunom&id_popup=1

Cette méthode retourne les destinations sur le format suivant : id_destination;destination;price;AUTORISE|INTERDIT

Récupération du listing des id_destination/nom destination/prix ainsi que leur état d’autorisation actuel.

  • Méthode : popup_destinations
  • Obligatoire : email, pass, id_popup

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popup_destinations&[email protected]&pass=a&id_popup=1

Cette méthode retourne les destinations sur le format suivant : id_destination;destination;prix;AUTORISE|INTERDIT

Afin de faciliter l’ajout des destinations, il est également possible de fournir les destinations à ouvrir sous la forme du code pays ainsi que le type souhaité (Fixe, Mobile).

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popup_destination_ajout&[email protected]&pass=a&id_popup=77&liste_destination[]=FR_Fixe&liste_destination[]=FR_Mobile&liste_destination[]=BE_Fixe

Afin de faciliter la suppression des destinations, il est également possible de fournir les destinations à ouvrir sous la forme du code pays ainsi que le type souhaité (Fixe, Mobile).

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=popup_destination_supp&[email protected]&pass=a&id_popup=77&liste_destination[]=FR_Fixe&liste_destination[]=FR_Mobile&liste_destination[]=BE_Fixe

Suppression d’une pop-up, il n’est alors plus possible d’émettre d’appels à partir de celle-ci.

  • Méthode : popup_del
  • Obligatoires : email, pass, id_popup

Haut de page

Récupération de fichiers

Les fonctions suivantes permettent de gérer les fichiers de configuration servant à personnaliser le système :

  • son de mise en relation de l’internaute (service vocal)
  • son de mise en relation de l’opérateur (service vocal)
  • son de personnalisation du répondeur (service vocal)
  • feuille de style css (popup)
  • image dans l’entête de la popup (popup)

Attention, toutes les variables sont envoyées en GET, sauf les fichiers envoyés en POST. 3 méthodes :

  • fichier_recuperer : récupère un fichier
  • fichier_deposer : charge un fichier
  • fichier_supprimer : supprime un fichier

Permet de récupérer les fichiers actuellement utilisés par la pop-up & le service vocal : images, feuilles css, son répondeur, son mise en relation opérateur/internaute ou l’enregistrement des conversations si l’option a été souscrite.

  • Méthode : fichier_recuperer
  • Mandatory aprameters : email, pass, id_popup, type

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=fichier_recuperer&[email protected]&pass=a&id_popup=77&type=son_internaute

Permet de déposer les fichiers que l’on souhaite voir utilisés par la popup ou le service vocal.

  • Méthode : fichier_deposer
  • Obligatoires : email, pass, id_popup, type, son_internaute|son_operateur|son_repondeur|entete_popup|css_popup

Le fichier demandé est retourné au format binaire.

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=fichier_deposer&[email protected]&pass=a&id_popup=77&type=son_repondeur

Permet de supprimer un fichier du serveur.

  • Méthode : fichier_supprimer
  • Obligatoires : email, pass, id_popup, type

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=fichier_supprimer&[email protected]&pass=a&id_popup=77&type=son_repondeur

Haut de page

Appels

Les 2 dernières méthodes suivantes permettent de configurer un appel sortant et récupérer les statistiques.

Permet d’instancier un appel entre l’internaute et les opérateurs.

  • Méthode : appel
  • Obligatoires : email, pass, id_popup, e164, nbressais, rec, dureemaxi
  • Facultatifs : delais, nom, usr1, usr2, usr3

Cette méthode retourne un identifiant de tracking vous permettant de faire le lien avec les données dans les statistiques.

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=appel&[email protected]&pass=a&id_popup=77&e164=33170200258

Permet d’instancier un appel entre l’internaute et les opérateurs.

  • Méthode : appel_annuler
  • Obligatoires : email, pass, id_popup, id_contact

Cette méthode permet de stopper une demande de rappel si cette dernière n’a pas encore été initiée.

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=appel&[email protected]&pass=a&id_popup=77&id_contact=xx

Permet de récupérer les statistiques d’appels d’une journée

  • Méthode : appel_listing
  • Obligatoires : email, pass, id_popup
  • Facultatifs : id_tracking, date_debut, date_fin

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=appel_listing&[email protected]&pass=a&id_popup=77&date_debut=2008-10-01&date_fin=2008-11-01

ou https://webservices.axialys.net/get/webappel/api.php?methode=appel_listing&[email protected]&pass=a&id_popup=77&id_tracking=8

Cette méthode retourne les données suivantes :

id_tracking;date_time;delais;dt;ip;duree_sonnerie;duree_appel;type_dest;prix;nom;usr1;usr2;usr3;provena nce;etat

Attention l’état correspond à l’état final de l’appel.

Permet de récupérer les statistiques d’appels d’une journée.

  • Méthode : appel_listing
  • Obligatoires : email, pass, id_popup
  • Facultatifs : id_tracking, date_debut, date_fin

Exemple : https://webservices.axialys.net/get/webappel/api.php?methode=appels_resume&[email protected]&pass=a&id_popup=77&date_debut=2008-10-01&date_fin=2008-11-01 ou

https://webservices.axialys.net/get/webappel/api.php?methode=appels_resume&[email protected]&pass=a&id_popup=77&id_tracking=8

Cette méthode retourne les données suivantes : id_tracking;id_popup;date_time;delais;ip;duree_appel;nom;usr1;usr2;usr3;etat

Attention l’état correspond à l’état final de l’appel.

Haut de page