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

...

/

Add new user extension groupGet extension call status history by extension

Path parameters

Name

Type

Description

ext_group_id

stringinteger

Required. Ext group id.

...

Query parameters

Name

Type

Description

commentstart_datetime

string

User emailRequired.

nameend_datetime

string

Required. User name.

language_id

integer

User language id.

extension_group_id

integer

Required. User extension id.

login

string

Required. User login.

password

string

Required. User password.

email

string

Required. User email.

...

Resource fields

Name

Type

Description

change_list

array [call_status_change]

extension_id

integer

Resource call_status_change

Name

Type

Description

commentaction

string

Domain alias comment.

name

string

Domain alias name.

language_id

integer

User admin language id.

email

string

User admin email.

extension_group_id

integer

Extension group id.

login

string

User login.

id

integer

Resource id.

duration

integer

change_dt

string

status_id

integer

...

GET /extension_group/{ext_group_id}/

...

cdr/

...

Get user extension group cdr list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

commentstart_datetime

string

Required.

end_datetime

string

Required.

start_duration

integer

end_duration

integer

extension_id

array [stringinteger]

nameflow

array [string]language_id

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

to_username

array [integerstring]

emailfrom_username

array [string]

loginextension_type

array [string]

id

array [integer]

Resource id.

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

Resource fields

Name

Type

Description

commentper_page

string

Domain alias commentinteger

Items per page.

nameorder

string

Domain alias name.

language_id

integer

User admin language id.

email

string

User admin email.

extension_group_id

integer

Extension group id.

login

string

User login.

id

integer

Resource id.

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.

label

string

client_id

integer

Client id.

extension_group_id

integer

Extension group id.

type

string

Dealer type.

id

integer

Resource id.

Datetime sorting order.

cdr

array [cdr_response]

page

integer

Result 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 extensioncalls statistics

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

...

Query parameters

Name

Type

Description

idstart_datetime

integerstring

Resource idRequired.

clientend_iddatetime

integerstring

Client idRequired.

name

string

Domain alias name.

extension_id

array [integer]

...

GET /extension_group/{ext_group_id}/fax/

...

in/

Get record incoming fax messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

Query parameters

Name

Type

Description

uuid

array [string]

Fax uuid.

extension_id

integer

Extension id.

start_datetime

string

Start datetime.

uuidend_datetime

array [string]

Record uuidEnd datetime.

destination

array [string]

Destination number.

caller_id

array [string]

Caller id number. extension_id

order

integer

Extension id.

end_datetime

string

End datetime. string

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

Resource fields

Name

Type

Description

uuid

string

Record Fax uuid.

destination

string

Destination number.

caller_id

string

Caller id.

datetime

string

Record datetime.

file_size

integer

Record Fax file size.

extension_id

integer

Extension id.

client_id

integer

Client id.

extension_group_id

integer

Extension group id.

duration

integer

Record duration.

record_url

object

Record url.

...

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. Ext group id.

user_id

integer

Required. User id.

...

Query parameters

Name

Type

Description

commentstart_datetime

string

User email.

name

string

User nameRequired. Start datetime.

languageend_iddatetime

integerstring

User language id.

extension_group_id

integer

User extension id.

password

string

User password.

email

string

User email. Required. End datetime.

order

string

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

Resource fields

Name

Type

Description

commentstatus

string

Domain alias comment.

name

string

Domain alias name.

language_id

integer

User admin language id.

email

string

User admin email.

extension_group_id

integer

Extension group id.

login

string

User login.

id

integer

Resource id.

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. Ext group id.

user_id

integer

Required. User id.

Resource fields

Query parameters

Name

Type

Description

commentstart_datetime

string

Domain alias commentRequired. Start datetime.

nameend_datetime

string

Domain alias name.

language_id

integer

User admin language id.

email

string

User admin email.

extension_group_Required. End datetime.

order

string

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

extension_id

integer

Extension group id.

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

Resource fields

Name

Type

Description

extto_group_idusername

string

Required. Ext group id.

user_id

integer

Required. User id.

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

Get record

Path parameters

Name

Type

Description

recordsource_number

string

result

string

duration

integer

subcall_uuid

string

Required. Record uuid.

ext_group_id

string

Required. Ext group 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

Resource fields

Name

Type

Description

status

string

Agent status.

name

string

Domain alias name.

label

string

client_id

integer

Client id.

extension_group_id

integer

Extension group id.

type

string

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

label

string

client_id

integer

Client id.

extension_group_id

integer

Extension group id.

type

string

Dealer type.

id

integer

Resource id. 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

...