Groups of available callerID (/caller_id_group/)

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).

The resource allows the client to enable employees to set callerID for outgoing calls. To do this, you can select the required numbers from the list of external client numbers and assign this list to an extension (parameter “caller_id_group_id”). Subsequently, the employee can select the callerID he needs from this list (parameter “client_public_caller_id_number“).

Description of data structures

Name

Type

Required

Description

Name

Type

Required

Description

did_list

array [integer]
or
array [caller_id_group_values]

no

List of identifiers (“id”) of external numbers

or

List of the form {"did_id": integer, "value": "string"} - identifiers of external numbers with values

id

integer

yes

Group ID

name

string

yes

Group name (must be unique)

Resources in the “Client” section

POST /client/{client_id}/caller_id_group/

Add a group of CallerIDs

URL Parameters

Name

Type

Name

Type

client_id

string

Request parameters

Name

Type

Name

Type

did_list

array [integer]

name

string

Response Options

Name

Type

Name

Type

did_list

array [integer]

id

long

client_id

long

name

string

GET /client/{client_id}/caller_id_group/

Get a list of all callerID groups

URL Parameters

Name

Type

Name

Type

client_id

string

Response Options

Name

Type

Name

Type

did_list

array [integer]

id

long

client_id

long

name

string

PUT /client/{client_id}/caller_id_group/{group_id}

Change CallerID group

URL Parameters

Name

Type

Name

Type

group_id

integer

client_id

string

Request parameters

Name

Type

Name

Type

did_list

array [integer]

name

string

Response Options

Name

Type

Name

Type

did_list

array [integer]

id

long

client_id

long

name

string

GET /client/{client_id}/caller_id_group/{group_id}

Request CallerID group parameters by id

URL Parameters

Name

Type

Name

Type

group_id

integer

client_id

string

Response Options

Name

Type

Name

Type

did_list

array [integer]

id

long

client_id

long

name

string

DELETE /client/{client_id}/caller_id_group/{group_id}

Delete callerID group

URL Parameters

Name

Type

Name

Type

group_id

integer

client_id

string

Resources in the "Extension number" section