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 extension call status history by extension list

Path parameters

Name

Type

Description

ext_group_id

stringinteger

Required. Ext group id.

Query parameters

Name

Type

Description

statusstart_datetime

array [string]

type

array [string]

id

array [string]

Resource id.

name

array [string]

Required.

end_datetime

string

Required.

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

change_list

array [call_status_change]

extension_id

integer

Resource call_status_change

Name

Type

Description

ext_group_idaction

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.

duration

integer

change_dt

string

status_id

integer

...

GET /extension_group/{ext_group_id}/

...

cdr/

...

Get extensioncdr list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

extension_id

integer

Required. Extension id.

Resource fields

Query parameters

Name

Type

Description

statusstart_datetime

string

Agent statusRequired.

nameend_datetime

string

Domain alias nameRequired.

extensionstart_group_idduration

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.

uuidend_duration

integer

extension_id

array [integer]

flow

array [string]

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

to_username

array [string]

Fax uuid.

destination

from_username

array [string]

Destination number.

caller_idextension_type

array [string]

Caller id number.

end_datetime

string

End datetime.

page

integer

Result page. Default: 1

per_page

integer

Items per page. Default: 100000

order

string

Datetime sorting order. One of 'desc', 'asc'. Default: descextension_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

...

per_page

integer

Items per page.

order

string

Datetime sorting order.

cdr

array [cdr_response]

page

integer

Result page.

Resource cdr_response

string

Name

Type

Description

ext_group_id

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

subcall_uuid

string

hangup_time_gmt

string

dealer_owner_id

integer

to_domain

string

record_file_size

integer

calls_result

string

from_username

stringTrunk from username.

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

Trunk from domain.

source_domaincall_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

integerExtension id.

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

extension_id

array [integer]

...

GET /extension_group/{ext_group_id}/fax/

...

in/

...

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

Get incoming fax messages list

Path parameters

Name

Type

Description

ext_group_id

string

Required. Ext group id.

...

Query parameters

Name

Type

Description

commentuuid

array [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]

Fax uuid.

extension_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

start_datetime

string

Start datetime.

end_datetime

string

End datetime.

destination

array [string]

name

array [string]

languageDestination number.

caller_id

array [integerstring]

id

array [integer]

Resource idCaller id number.

loginorder

array [string]

email

array [string]

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

Resource fields

Name

Type

Description

commentuuid

string

Domain alias commentFax uuid.

namedestination

string

Domain alias nameDestination number.

extension_groupcaller_id

integerstring

Extension group Caller id.

language_id

integer

User language id.

emaildatetime

string

User emailRecord datetime.

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

usersize

integer

Fax file size.

extension_id

integer

Required. User Extension id.

JSON parameters

Name

Type

Description

comment

string

User email.

name

string

Required. User name.

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

Client id.

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

...

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.

Resource fields

Query parameters

Name

Type

Description

commentstart_datetime

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

status

string

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.

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

dealer_owner_id

integer

to_domain

string

record_file_size

integer

calls_result

string

from_username

stringTrunk from username.

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

Trunk from domain.

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

...