Number Identification (/ani/)

You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).

This resource is intended to set, change and reset the settings for identifying the number for outgoing calls to external numbers at the client and in extension numbers. 

Description of Data Structures 

Name 

Type 

Mandatory 

Description 

Name 

Type 

Mandatory 

Description 

client_id 

integer 

yes 

Identifier of the client 

extension_id 

string 

yes 

Identifier of the extension number 

default 

string 

no 

Installed ANI. If no ANI is installed, it has the value 'None' 

ani_number 

string 

yes 

Number from the client external number list. If it is missed, it has the value 'None' 

Example 

Let's set identification of the external number 78121234567 for the extension number with the ID 372850: 

System response: 

{   "default": "78121234567" }

"Client" Section Resources 

GET /client/{client_id}/ani/ 

Request the number identification option in the client settings 

URL Options 

Name 

Type 

Name 

Type 

client_id 

integer 

Response Options 

Name 

Type 

Name 

Type 

default 

string 

PUT /client/{client_id}/ani/ 

Set the number identification option in the client settings 

URL Options 

Name 

Type 

Name 

Type 

client_id 

string 

Request Options 

Name 

Type 

Name 

Type 

ani_number 

string 

Response Options 

Name 

Type 

Name 

Type 

default 

string 

"Extension Number” Section Resources 

GET /extension/{extension_id}/ani/ 

Request the number identification option in the extension number settings 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

Response Options 

Name 

Type 

Name 

Type 

default 

string 

PUT /extension/{extension_id}/ani/ 

Set the number identification option in the extension number settings 

URL Options 

Name 

Type 

Name 

Type 

extension_id 

string 

Request Options 

Name 

Type 

Name 

Type 

ani_number 

string 

Response Options 

Name 

Type 

Name 

Type 

default 

string