Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 15 Next »

GET /extension_group/{ext_group_id}/extension/

Get extension list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

status

array [string]

type

array [string]

id

array [string]

Resource id.

name

array [string]

Resource fields

Name

Type

Description

status

string

Agent status.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

label

string

client_id

integer

Client id.

extra_params

string

User extra params.

type

string

Rule type.

id

integer

Resource id.


PUT /extension_group/{ext_group_id}/extension/{extension_id}

Update extension

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

extension_id

integer

Required. Extension id.

JSON parameters

Name

Type

Description

status

string

One of 'active', 'blocked'.

password

string

label

string

extra_params

string

Resource fields

Name

Type

Description

status

string

Agent status.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

label

string

client_id

integer

Client id.

extra_params

string

User extra params.

type

string

Rule type.

id

integer

Resource id.

GET /extension_group/{ext_group_id}/extension/{extension_id}

Get extension

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

extension_id

integer

Required. Extension id.

Resource fields

Name

Type

Description

status

string

Agent status.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

label

string

client_id

integer

Client id.

extra_params

string

User extra params.

type

string

Rule type.

id

integer

Resource id.


GET /extension_group/{ext_group_id}/extension_group/

Get extension

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Resource fields

Name

Type

Description

id

integer

Resource id.

client_id

integer

Client id.

name

string

Domain alias name.


GET /extension_group/{ext_group_id}/fax/in/

Get incoming fax messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

start_datetime

string

Start datetime.

uuid

array [string]

Fax uuid.

destination

array [string]

Destination number.

caller_id

array [string]

Caller id number.

end_datetime

string

End datetime.

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

extension_id

integer

Extension id.

Resource fields

Name

Type

Description

uuid

string

Fax uuid.

destination

string

Destination number.

file_url

object

Fax file url.

caller_id

string

Caller id.

datetime

string

Record datetime.

file_size

integer

Fax file size.

extension_id

integer

Extension id.

client_id

integer

Client id.

extension_group_id

integer

Extension group id.


GET /extension_group/{ext_group_id}/fax/in/{fax_uuid}

Get incoming fax message

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

fax_uuid

string

Required. Fax uuid.


GET /extension_group/{ext_group_id}/record/

Get record list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

start_datetime

string

Required. Start datetime.

end_datetime

string

Required. End datetime.

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name

Type

Description

to_username

string

source_number

string

result

string

duration

integer

hangup_time_gmt

string

dealer_owner_id

integer

to_domain

string

record_file_size

integer

from_username

string

Trunk from username.

start_time_gmt

string

ext_number_reg

string

hangup_cause

string

extension_group_owner_id

integer

init_time_gmt

string

dest_domain

string

record_uuid

string

from_domain

string

Trunk from domain.

source_domain

string

extension_type

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

Extension id.

did_number

string

client_owner_id

integer


GET /extension_group/{ext_group_id}/record/stats/

Get record statistics list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

start_datetime

string

Required. Start datetime.

end_datetime

string

Required. End datetime.

Resource fields

Name

Type

Description

files_size

integer

records_count

integer


GET /extension_group/{ext_group_id}/record/{record_uuid}

Get record

Path parameters

Name

Type

Description

record_uuid

string

Required. Record uuid.

ext_group_id

string

Required. Ext group id.


POST /extension_group/{ext_group_id}/user/extension_group/

Add new user extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

JSON parameters

Name

Type

Description

comment

string

User email.

name

string

Required. User name.

language_id

integer

User language id.

extra_params

string

User extra params.

login

string

Required. User login.

password

string

Required. User password.

email

string

Required. User email.

Resource fields

Name

Type

Description

comment

string

Domain alias comment.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

language_id

integer

User language id.

email

string

User email.

extra_params

string

User extra params.

login

string

User login.

id

integer

Resource id.

GET /extension_group/{ext_group_id}/user/extension_group/

Get user extension group list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

comment

array [string]

name

array [string]

language_id

array [integer]

id

array [integer]

Resource id.

login

array [string]

email

array [string]

Resource fields

Name

Type

Description

comment

string

Domain alias comment.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

language_id

integer

User language id.

email

string

User email.

extra_params

string

User extra params.

login

string

User login.

id

integer

Resource id.


PUT /extension_group/{ext_group_id}/user/extension_group/{user_id}

Update user extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

user_id

integer

Required. User id.

JSON parameters

Name

Type

Description

comment

string

User email.

name

string

Required. User name.

language_id

integer

User language id.

extra_params

string

User extra params.

login

string

Required. User login.

password

string

Required. User password.

email

string

Required. User email.

Resource fields

Name

Type

Description

comment

string

Domain alias comment.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

language_id

integer

User language id.

email

string

User email.

extra_params

string

User extra params.

login

string

User login.

id

integer

Resource id.

GET /extension_group/{ext_group_id}/user/extension_group/{user_id}

Get user extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

user_id

integer

Required. User id.

Resource fields

Name

Type

Description

comment

string

Domain alias comment.

name

string

Domain alias name.

extension_group_id

integer

Extension group id.

language_id

integer

User language id.

email

string

User email.

extra_params

string

User extra params.

login

string

User login.

id

integer

Resource id.

DELETE /extension_group/{ext_group_id}/user/extension_group/{user_id}

Delete user extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

user_id

integer

Required. User id.


GET /extension_group/{ext_group_id}/voicemail/

Get voice mail messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

end_datetime

string

Required. End datetime.

start_datetime

string

Required. Start datetime.

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: desc

extension_id

integer

Extension id.

Resource fields

Name

Type

Description

to_username

string

source_number

string

result

string

duration

integer

hangup_time_gmt

string

dealer_owner_id

integer

to_domain

string

record_file_size

integer

from_username

string

Trunk from username.

start_time_gmt

string

ext_number_reg

string

hangup_cause

string

extension_group_owner_id

integer

init_time_gmt

string

dest_domain

string

record_uuid

string

from_domain

string

Trunk from domain.

source_domain

string

extension_type

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

Extension id.

did_number

string

client_owner_id

integer


GET /extension_group/{ext_group_id}/voicemail/{record_uuid}

Get voicemail message file

Path parameters

Name

Type

Description

record_uuid

string

Required. Record uuid.

ext_group_id

string

Required. Ext group id.

DELETE /extension_group/{ext_group_id}/voicemail/{record_uuid}

Delete voicemail message

Path parameters

Name

Type

Description

record_uuid

string

Required. Record uuid.

ext_group_id

string

Required. Ext group id.


  • No labels