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 25 Current »

GET /extension_group/{ext_group_id}/extension/

Get extension list

Path parameters

Name

Type

Description

ext_group_id

string

Required.

Query parameters

Name

Type

Description

id

array [string]

name

array [string]

type

array [string]

status

array [string]

caller_id_name

array [string]

Resource fields

Name

Type

Description

status

string

domain

string

create_date

string

name

string

extra_params

string

label

string

caller_id_name

string

client_id

integer

extension_group_id

integer

message_did

string

dial_rule_limit

integer

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string


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

Update extension

Path parameters

Name

Type

Description

ext_group_id

string

Required.

extension_id

integer

Required.

JSON parameters

Name

Type

Description

status

string

One of 'active', 'blocked'.

dial_rule_limit

integer

label

string

caller_id_name

string

extra_params

string

password

string

Resource fields

Name

Type

Description

status

string

domain

string

create_date

string

name

string

extra_params

string

label

string

caller_id_name

string

client_id

integer

extension_group_id

integer

message_did

string

dial_rule_limit

integer

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

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

Get extension

Path parameters

Name

Type

Description

ext_group_id

string

Required.

extension_id

integer

Required.

Resource fields

Name

Type

Description

status

string

domain

string

create_date

string

name

string

extra_params

string

label

string

caller_id_name

string

client_id

integer

extension_group_id

integer

message_did

string

dial_rule_limit

integer

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string


GET /extension_group/{ext_group_id}/extension_group/

Get extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required.

Resource fields

Name

Type

Description

name

string

id

integer

Resource id.

client_id

integer

extra_params

string


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

Get incoming fax message

Path parameters

Name

Type

Description

ext_group_id

string

Required.

fax_uuid

string

Required.


GET /extension_group/{ext_group_id}/record/

Get record list

Path parameters

Name

Type

Description

ext_group_id

string

Required.

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

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

to_domain

string

record_file_size

integer

calls_result

string

from_username

string

calls_hangup_disposition

string

ani_number

string

application

string

start_time_gmt

string

ext_number_reg

string

hangup_cause

string

hangup_disposition

string

extension_group_owner_id

integer

init_time_gmt

string

source_domain

string

dest_domain

string

record_uuid

string

from_domain

string

call_uuid

string

extension_type

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

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.

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

ext_group_id

string

Required.

record_uuid

string

Required.


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

Get record with basic http authentication

Path parameters

Name

Type

Description

ext_group_id

string

Required.

record_uuid

string

Required.


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

Get record storage url

Path parameters

Name

Type

Description

ext_group_id

string

Required.

record_uuid

string

Required.


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

Add new user extension group

Path parameters

Name

Type

Description

ext_group_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

User status. One of 'active', 'blocked'.

name

string

Required. User name.

email_notify

boolean

Send email with access data for new user. Default: False

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

login

string

Required. User login.

password

string

Required. User password.

email_for_notify

string

User email.

email

string

Required. User email.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

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.

Query parameters

Name

Type

Description

id

array [integer]

login

array [string]

name

array [string]

email

array [string]

comment

array [string]

status

array [string]

timezone

array [string]

access

array [string]

Resource fields

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

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.

user_id

integer

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

User status. One of 'active', 'blocked'.

name

string

User name.

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

User email.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

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.

user_id

integer

Required.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

extension_group_id

integer

email

string

access

string

extra_params

string

timezone

string

login

string

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.

user_id

integer

Required.


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

Get voicemail message file

Path parameters

Name

Type

Description

ext_group_id

string

Required.

record_uuid

string

Required.

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

Delete voicemail message

Path parameters

Name

Type

Description

ext_group_id

string

Required.

record_uuid

string

Required.


  • No labels