API listant les comptes Centrex

Cette API permet de lister l’ensemble des comptes Centrex afin d’obtenir le détail d’un ou plusieurs comptes.

L’API fonctionne suivant un paradigme de type REST, en acceptant des données sous forme de paramètres passés en GET, en POST, et retourne des données au format JSON.

Cette API fournit le listing des comptes Centex.

URL /centrex/centrex_account
Méthode(s) GET, POST

Format des requêtes

Les requêtes devront se faire sous la forme :

en GET :

curl -u <username>/token:<token> "https://api.axialys.com/centrex/centrex_account?centrex_account_id=<id>&phone_number=<phone_number>&state=<state>&site=<site>&last_registration_at=<date>&last_registration_at_end=<date>" -X GET

en POST :

curl -u <username>/token:<token> "https://api.axialys.com/centrex/centrex_account" -X POST -d '{"centrex_account_id":"<id>","phone_number":"<phone_number>","state":"<state>","site":"<site>","last_registration_at":"<date>","last_registration_at_end":"<date>"}'

Si vous utilisez le paramètre “site”, il faut que le nom du site soit complet et remplacez les caractères “ ” par des “+”.

Le username et le token seront transmis par Axialys à votre demande.

Paramètres

Nom Type Oblig. Description
centrex_account_id Numérique N Identifiant du compte Centrex
phone_number Numérique N SDA du compte au format e164
state active, suspended N Etat du compte centrex
site Alpha-numérique N Nom du site géographique
last_registration_at YYYY-MM-DDTHH:MM N Date de début ou date du jour demandé (format ISO 8601)
last_registration_at_end YYYY-MM-DDTHH:MM N Date de fin (format ISO 8601)

Données retournées

Les données retournées incluent les paramètres passés en entrée, ainsi que les données suivantes :

Nom Type Description
centrex_account_pwd Alpha-numérique Mot de passe du compte sip
phone_number Array Un à plusieurs SDA du compte au format e164
server Alpha-numérique Serveur sur lequel le compte se connecte
simultaneous_calls_count Alpha-numérique Nombre d’appels simultanés autorisés
user_name Alpha-numérique Prénom et nom de l’utilisation du compte
codec_mode preferred, forced Mode du codec
codec Alpha-numérique Code VoIP employé (FAX/G711a/G711u/G722/G726-32/G729/H264/OPUS)
transport Alpha-numérique Protocole de transport VoIP utilisé (UDP / TCP / WS)
dial_plan Alpha-numérique Plan de numérotation
short_phone_number Numérique Numéro court
displayed_number Numérique Numéro affiché lors d’un appel sortant
voicemail Array Informations pour la boîte vocale (détails plus bas)
call_forwarding Array Informations de renvoi (détails plus bas)
phone Array Informations de téléphone (détails plus bas)
call_recording Booléen Activation de l’enregistrement des conversations (0 désactivation, 1 activation)
ringback_message Booléen Activation du message de pré-décroché (0 désactivation, 1 activation)
interception_right Booléen Autorisation d’avoir le droit d’interception d’appels entrants, d’un membre du même groupe (0 désactivation, 1 activation)
fax_numbers_right Booléen Autorisation d’accéder à tous les numéros de fax sur l’interface du compte utilisateur (0 désactivation, 1 activation)
limited_account Booléen Si activé, le compte ne pourra pas passer d’appel s’il a épuisé son forfait (0 désactivation, 1 activation)
vas_numbers_block Booléen Si activé, le compte ne pourra pas passer d’appel vers les 08 (0 désactivation, 1 activation)
zoiper_download_url URL Adresse internet de la version 3 de Zoiper, pré-configuré
last_registration_at YYYY-MM-DDTHH:MMZ Date du dernier enregistrement
ldap_connection Array Informations de connexion LDAP (détails plus bas)
Informations pour la boîte vocale :
  • email_address : Adresse email pour la réception de message vocaux de la boite vocale
  • visual_notification : Indication visuelle sur le téléphone de la présence d’un nouveau message en boite vocale
  • edit_message_right : Autorisation du changement du message d’accueil de la boite vocale
Informations de renvoi :
  • unconditional : Renvoi permanent (inactive / voicemail / short_number / number / hang_up)
  • unconditional_number : Numéro affiché (caller / account)
  • unreachable : Renvoi sur injoignabilité (inactive / voicemail / short_number / number / hang_up)
  • unreachable_number : Numéro affiché (caller / account)
  • no_answer : Non réponse, renvoi vers (inactive / voicemail / short_number / number / hang_up)
  • no_answer_number : Numéro affiché (caller / account)
  • delay : Délai avant renvoi (20 sec. par défaut)
  • secretary : Renvoi secrétaire(s) (inactive / active)
Informations de téléphone :
  • phone_model : Référence du téléphone
  • mac_address : Adresse MAC
  • port : Port
  • snom_handset_ref : Référence du combiné SNOM
Informations de connexion LDAP :
  • hostname = Nom d’hôte
  • user = Utilisateur
  • pwd = Mot de passe
  • domain = domaine