Guide voice management

LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER

Retour au guide

API gestion des numéros de service

Cette API permet de gérer les numéros de service.

L’API permet ainsi de :

  1. Récupérer un ou plusieurs numéros de service,
  2. Modifier un ou plusieurs numéros de service actifs.

1 - Considérations générales

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 ou en PUT, et retourne des données au format JSON.

2 - Récupération des numéros de service

Cette API fournit le listing des numéros de service.

URL /vm/service_numbers
Méthode(s)
GET,POST
Format des requêtes

Les requêtes devront se faire sous la forme

en GET :

				
					curl -u <username>:<password> "https://api.axialys.com/vm/service_numbers?service_number=<e164>&state=<state>&section_id=<num>&billing_account=<alphanum>&record=<bool>" -X GET

en POST :

				
					curl -u <username>:<password> "https://api.axialys.com/vm/service_numbers" -X POST -d '{"service_number":"<e164>","state":"<state>","section_id":"<num>","billing_account":"<alphanum>","record":"<bool>"}'
Paramètres
Nom Type Oblig. Description
service_number
Numérique
N
Numéro du service, au format e164 (sans +)
state
ACTIF, SUSPENDU
N
Etat du numéro
section_id
Numérique
N
Identifiant rubrique
billing_account
Alpha-numérique
N
Nom du compte de facturation rattaché au numéro
record
Booléen
N
Activation de l’enregistrement des communications (0 désactivation, 1 activation)
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
section
Alpha-numérique
Nom de la rubrique

3 - Modification un ou plusieurs numéros de service

URL /vm/service_numbers
Méthode(s)
PUT
Format des requêtes

Les requêtes devront se faire sous la forme

				
					curl -u <username>:<password> "https://api.axialys.com/vm/service_numbers" -X PUT -d '{"service_number":"<e164>","section_id":"<num>","billing_account":"<alphanum>","record":"<bool>"}'
Paramètres
Nom Type Oblig. Description
service_number
Numérique
O
Un ou plusieurs numéros de service, au format e164 (sans +), séparés par des virgules
section_id
Numérique
N
Identifiant rubrique
billing_account
Alpha-numérique
N
Nom du compte de facturation rattaché au numéro
record
Booléen
N
Activation de l’enregistrement des communications (0 désactivation, 1 activation)
Données retournées

Nombre de numéros modifiés.

 
  • Table des matières