Internal Numbers Group (/extension_group/)

Owned by esnata (Unlicensed)
Last updated: Jul 07, 2021
3 min read

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 you to manage groups of internal client numbers. Internal numbers groups are designed to combine the client's internal numbers into a group, which allows you to:

  • work with a number of resources (call recordings, voice mail, incoming faxes) at the group level. For example, you can get a list of call records for internal numbers that are in a specific group;

  • organize access to internal number resources by creating a user of the "internal numbers group" type. Such a user, unlike a user of the "internal number" type, can use the resources of several internal numbers, but, unlike a user of the "client" type, he can only access the resources of those internal numbers that are in his group.

Description of data structures

Name

Type

Description

Name

Type

Description

id 

long

Unique ID of the internal numbers group

name 

string

Name of the internal numbers group

client_id

long

ID of the client that the group belongs to

extra_params 

string

Additional parameters

Examples

Name of the internal numbers group

System response:

{   "id": 14,   "name": "New group of internal numbers",   "client_id": 12,   "extra_params": null }

Placing an internal number with ID 30 in a previously created group
(for this, the internal number must be previously created):

System response:

{   "status": "active",   "domain": "sip.ringme.ru",   "create_date": "2020-03-16 12:18:08",   "name": "000*300",   "dial_rule_limit": null,   "extension_group_id": 14,   "label": "Petrov",   "caller_id_name": "Petrov P. P.",   "client_id": 12,   "extra_params": "null",   "message_did": "string",   "dial_rule_id": null,   "ani_rfc3325": false,   "type": "phone",   "id": 30,   "did_as_transfer_caller_id": null }

Similarly, we place the previously created internal number with the ID 28 in the previously created group:

System response:

{   "status": "active",   "domain": "sip.ringme.ru",   "create_date": "2020-03-16 12:18:08",   "name": "000*301",   "dial_rule_limit": null,   "extension_group_id": 14,   "label": "Sidorov",   "caller_id_name": "Sidorov S. S.",   "client_id": 12,   "extra_params": "312",   "message_did": "string",   "dial_rule_id": null,   "ani_rfc3325": false,   "type": "phone",   "id": 28,   "did_as_transfer_caller_id": null }

Getting a list of all internal numbers in a given group:

Getting a list of call records of internal numbers in a given group from April 1 to April 21, 2016:

 

Resources of the "Client" section

POST /client/{client_id}/extension_group/

Add a group of internal numbers

URL Parameters

Name

Type

Name

Type

client_id

string

JSON parameters

Name

Type

Mandatory

Name

Type

Mandatory

name

string

none

extra_params 

string

none

Response fields

Name

Type

Name

Type

id

integer

client_id

integer

name

string

extra_params 

string

GET /client/{client_id}/extension_group/

Get a list of the client's internal numbers groups

URL Parameters

Name

Type

Name

Type

client_id

string

Request parameters

Name

Type

Name

Type

id

array [string]

name

array [string]

Response fields

Name

Type

Name

Type

id

integer

client_id

integer

name

string

extra_params 

string

PUT /client/{client_id}/extension_group/{ext_group_id}

Add a group of internal numbers

URL Parameters

Name

Type

Name

Type

ext_group_id

integer

client_id

string

JSON parameters

Name

Type

Mandatory

Name

Type

Mandatory

name

string

none

extra_params 

string

none

Response fields

Name

Type

Name

Type

id

integer

client_id

integer

name

string

extra_params 

string

Resources of the "Internal numbers group" section

Â