Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

GET /extension_group/{ext_group_id}/

...

call_status/stats/history_by_extension/

Get cdr listextension call status history by extension

Path parameters

Name

Type

Description

ext_group_id

stringinteger

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

from_username

array [string]

to_username

array [string]

flow

array [string]

One of 'in', 'out', 'transfer'.

order

string

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

extension_id

array [integer]

end_datetime

string

Required.

extension_type

array [string]

per_page

integer

Items per page. Default: 100000

end_duration

integer

start_duration

integer

page

integer

Result page. Default: 1

Resource fields

Name

Type

Description

per_page

integer

Items per page.

order

string

Datetime sorting order.

cdrchange_list

array [cdrcall_status_responsechange]

pageextension_id

integerResult page.

Resource

...

call_status_

...

change

Name

Type

Description

to_username

string

source_number

string

resultaction

string

duration

integer

hangupchange_time_gmtdt

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

status_id

integer

...

GET /extension_group/{ext_group_id}/cdr

...

/

Get calls statisticscdr list

Path parameters

Name

Type

Description

ext_group_id

string

Required.

...

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

extensionstart_idduration

array [integer]

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

status

array [string]

name

array [string]

caller_id_name

array [string]

type

array [string]

id

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/

Get incoming fax messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required.

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

integer

extension_id

array [integer]

flow

array [string]

One of 'in', 'out', 'transfer'.

to_username

array [string]

from_username

array [string]

extension_type

array [string]

page

integer

Result page. Default: 1

per_page

integer

Items per page. Default: 100000

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.

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.

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

start_datetime

string

Required. Start datetime.

per_page

integer

Items per page.

order

string

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

end_datetime

string

Required. End datetime.

per_

cdr

array [cdr_response]

page

integer

page

integer

Default: 1Result page.

Resource

...

cdr_response

Name

Type

Description

to_username

string

source_number

string

result

string

duration

integer

subcall_uuid

string

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

transfer_reason

string

bundle_info

string

remote_call_sign

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}/

...

cdr/stats/

Get record calls 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

extension_id

array [integer]

...

GET /extension_group/{ext_group_id}/

...

fax/in/

Get incoming fax messages list

Path parameters

string

Name

Type

Description

record_uuid

Required.

ext_group_id

string

Required.

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

Get record with basic http authentication

...

Query parameters

Name

Type

Description

record_uuid

array [string]

RequiredFax uuid.

ext_groupextension_id

string

Required.

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

Get record storage url

Path parameters

Name

Type

Description

record_uuid

string

Required.

ext_group_id

string

Required.

GET /extension_group/{ext_group_id}/reg_status_log/

Get logs change registration for all extension in group

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

Extension id.

start_datetime

string

Start datetime.

end_datetime

string

End datetime.

destination

array [string]

Destination number.

caller_id

array [string]

Caller id number.

order

string

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

Resource fields

Name

Type

Description

statusuuid

string

date_gmt

string

short_ext_name

string

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

comment

array [string]

status

array [string]

name

array [string]

id

array [integer]

access

array [string]

timezone

array [string]

login

array [string]

email

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.

...

Fax uuid.

destination

string

Destination number.

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}/

...

reg_status_log/

Get logs change registration for all extension in group

Path parameters

Name

Type

Description

ext_group_id

string

Required.

user_id

integer

Required.

...

Query parameters

Name

Type

Description

commentstart_datetime

string

User emailRequired. Start datetime.

statusend_datetime

string

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

nameRequired. End datetime.

order

string

User name.

access

string

User access type. Datetime sorting order. One of 'fulldesc', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

User email.

asc'. Default: desc

Resource fields

comment

Name

Type

Description

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.

date_gmt

string

short_ext_name

string

...

GET /extension_group/{ext_group_id}/voicemail/

Get voice mail messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required.

Query parameters

Name

Type

Description

endstart_datetime

string

Required. End Start datetime.

startend_datetime

string

Required. Start End 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

subcall_uuid

string

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

transfer_reason

string

bundle_info

string

remote_call_sign

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.

ext_group_id

string

Required.

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

Delete voicemail message

Path parameters

Name

Type

Description

record_uuid

string

Required.

ext_group_id

string

Required.

...