Guide Centrex

Le guide de votre solution de téléphonie d'entreprise

Retour au guide

API Centrex temps réel

Présentation du document

Ce document décrit l’API HTTP mise à la disposition des systèmes clients pour permettre une interaction en temps réel avec la plate-forme Axialys Centrex.

Elle permettra à l’utilisateur d’effectuer des opérations basiques de click-to-call, ainsi que de recevoir des notifications de la plate-forme relatives aux événements provenant des appareils en temps réel.

Ce document est destiné aux ingénieurs logiciels connaissant les API basées sur le HTTP.

Principes de fonctionnement

Cette API est conçue pour être utilisée à partir d’un seul système côté client desservant l’ensemble des comptes, tel qu’un serveur d’applications web.

Les notifications parviendront au système client par le biais de rappels HTTP effectués vers une URL spécifiée par le client.

Options de configuration

Ce service est fourni par Axialys. Axialys communique au client les détails de ses identifiants (clé API).

Restrictions de connexion

Par défaut, les connexions sont autorisées à partir de n’importe quelle IP. Sur demande du client, l’accès à l’API pour un compte spécifique peut être limité à une ou plusieurs IPs fournies par le client.

Axialys peut à tout moment restreindre l’accès à l’API afin d’éviter les abus.

Détails de la mise en œuvre

Cette API est basée sur les échanges HTTP(S). La plupart des paramètres des requêtes sont fournis par les paramètres de l’URL de la requête, tandis que les données de la réponse sont codées en JSON.

L’encodage des données de test est UTF-8 L’adresse de base est : https://popc.axialys.com/api

Détail des fonctions

Click-to-call

Cette fonction demande de passer un nouvel appel. Cet appel fait d’abord sonner le téléphone de l’utilisateur Centrex spécifié, puis le destinataire de l’appel.

L’authentification est basée soit sur la clé api_key, soit sur le mot de passe du compte.

Veuillez noter que le click-to-call n’est actuellement pris en charge que pour les comptes ayant une configuration de notification valide.

Attention : Il faut d’abord configurer l’URL de callback (ci dessous)

Paramètres d’entrée
Paramètre Type M/O Description
API endpoint
URL
M
/centrex/v1/call
account_id
String
M
account_id : ID du compte Centrex
password
String
O
Mot de passe (si l’authentification au niveau du compte est utilisée) : A trouver sur la fiche du compte Centrex "Mot de passe du compte sip"
api_key
String
O
Clé API (si l’authentification au niveau du client est utilisée)
number
String
M
Numéro de téléphone à appeler, au format E.164.
Résultat

TBD

set_callback

Cette fonction permet au client de définir l’URL de rappel vers son infrastructure pour obtenir diverses notifications de statut. Cette URL doit être accessible depuis les serveurs d’Axialys.

Toute URL précédemment définie est réinitialisée après cet appel. Indiquer une URL vide désactive les notifications.

Paramètres de saisie
Paramètre Type M/O Description
API endpoint
URL
M
/centrex/v1/set_callback
api_key
String
M
Clé API (si l’authentification au niveau du client est utilisée)
url
String
M
URL de rappel
Résultat

TBD

Détail des fonctions

À la demande du client, Axialys notifiera l’URL spécifiée pour les différents événements liés aux appels sur le service Centrex.

L’URL est désignée sous le libellé :

http://<customer url>/?call_id={call_id}&event={event}

Les paramètres sont définis en fonction des événements signalés.

Paramètre Type Description
event
Chaîne
outgoing_call_start
call_id
Chaîne
Le call_id unique identifiant un appel
calling_number
Chaîne
Le numéro d’appel, en E164
called_number
Chaîne
Le numéro appelé, en E164
account_id
Chaîne
L’account_id auquel ce compte est lié
Paramètre Type Description
event
Chaîne
incoming_call_start
call_id
Chaîne
Le call_id unique identifiant un appel
calling_number
Chaîne
Le numéro d’appel, en E164
called_number
Chaîne
Le numéro appelé, en E164
account_id
Chaîne
L’account_id auquel ce compte est lié
Paramètre Type Description
event
Chaîne
call_connected
call_id
Chaîne
Le call_id unique identifiant un appel
Paramètre Type Description
event
Chaîne
call_end
call_id
Chaîne
Le call_id unique identifiant un appel
call_id
Chaîne
Le call_id unique identifiant un appel
status
Chaîne
Statut de fin d’appel
billable_duration
Nombre entier
Durée facturable pour cet appel en secondes

Veuillez noter que d’autres paramètres peuvent être définis par la plate-forme et ne doivent pas causer de perturbation au système du client.

La plateforme Axialys n’attend aucune valeur de retour sur ces rappels.

  • Table des matières