Voice Management Guide

The Voice Management user guide

Back to guide

API service number management

This API allows you to manage service numbers.


The API thus allows you to:

  1. Retrieve one or more service numbers
  2. Change one or more active service numbers

1 - General comments

The API operates within a REST paradigm, accepting data as parameters made through GET, POST or PUT and returns the data in a JSON format.

2 - Retrieval of service numbers

This API provides a listing of the service numbers.

URL /vm/service_numbers
Method(s)
GET,POST

Query format

Queries should be made as follows:

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

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>"}'
Settings
Name Type Mandatory Description
service_number
Digital
N
Service number, in E.164 format (without +)
state
active, suspended
N
Number status
section_id
Digital
N
Category ID
billing_account
Alphanumeric
N
Name of the billing account associated with the number
record
Boolean
N
Activation of call recording (0 deactivate, 1 activate)

Data returned


The data returned includes the settings passed as input, in addition to the following data:

Name Type Description
section
Alphanumeric
Rubric name

3 - Changing one or more service numbers

URL /vm/service_numbers
Method(s)
PUT

Query format


Queries should be made as follows:

				
					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>"}'
Setting
Name Type Mandatory Description
service_number
Digital
Y
One or more service numbers, in E.164 format (without +), separated by commas
section_id
Digital
N
Category ID
billing_account
Alphanumeric
N
Name of the billing account associated with the number
record
Boolean
N
Activation of call recording (0 deactivate, 1 activate)

Data returned :
# of numbers changed.

  • Table of contents