Client

GET /client/{client_id}/agent/local/{agent_id}/events/

Get queue events

Path parameters

Name

Type

Description

client_id

string

Required.

agent_id

integer

Required.

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

event_name

array [string]

Event type.


GET /client/{client_id}/agent/remote/{agent_id}/events/

Get queue events

Path parameters

Name

Type

Description

client_id

string

Required.

agent_id

integer

Required.

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

event_name

array [string]

Event type.


GET /client/{client_id}/call_history/

Get call history list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

start_duration

integer

end_duration

integer

start_bridged_duration

integer

end_bridged_duration

integer

extension_id

array [integer]

flow

array [string]

One of 'in', 'out'.

bridged_username

array [string]

to_username

array [string]

from_username

array [string]

did_number

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

Resource fields

Name

Type

Description

per_page

integer

Items per page.

call_history

array [call_history]

Default: []

order

string

Datetime sorting order.

page

integer

Result page.

Resource call_history

Name

Type

Description

flow

string

ivr_history

string

result

string

cdr

array [cdr_response]

duration

integer

hangup_time_gmt

string

bridged_domain

string

to_domain

string

from_username

string

start_time_gmt

string

to_username

string

ext_number_reg

string

hangup_cause

string

diversion_number

string

extension_group_owner_id

integer

init_time_gmt

string

from_domain

string

call_uuid

string

extension_type

string

did_domain

string

from_screen_name

string

bridged_duration

integer

bridged_time_gmt

string

extension_name

string

bridged_username

string

hangup_disposition

string

extension_id

integer

did_number

string

client_owner_id

integer


GET /client/{client_id}/call_history/{call_uuid}

Get call history item

Path parameters

Name

Type

Description

client_id

string

Required.

call_uuid

string

Required.

Query parameters

Name

Type

Description

call_month

string

Resource fields

Name

Type

Description

flow

string

ivr_history

string

result

string

cdr

array [cdr_response]

duration

integer

hangup_time_gmt

string

bridged_domain

string

to_domain

string

from_username

string

start_time_gmt

string

to_username

string

ext_number_reg

string

hangup_cause

string

diversion_number

string

extension_group_owner_id

integer

init_time_gmt

string

from_domain

string

call_uuid

string

extension_type

string

did_domain

string

from_screen_name

string

bridged_duration

integer

bridged_time_gmt

string

extension_name

string

bridged_username

string

hangup_disposition

string

extension_id

integer

did_number

string

client_owner_id

integer

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 /client/{client_id}/calls/

Get call list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

start_duration

integer

end_duration

integer

start_bridged_duration

integer

end_bridged_duration

integer

extension_id

array [integer]

flow

array [string]

One of 'in', 'out'.

bridged_username

array [string]

to_username

array [string]

from_username

array [string]

did_number

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

Resource fields

Name

Type

Description

per_page

integer

Items per page.

order

string

Datetime sorting order.

calls

array [calls]

page

integer

Result page.

Resource calls

Name

Type

Description

flow

string

ivr_history

string

result

string

duration

integer

hangup_time_gmt

string

bridged_domain

string

to_domain

string

from_username

string

start_time_gmt

string

to_username

string

ext_number_reg

string

hangup_cause

string

hangup_disposition

string

extension_group_owner_id

integer

init_time_gmt

string

from_domain

string

call_uuid

string

extension_type

string

did_domain

string

from_screen_name

string

bridged_duration

integer

bridged_time_gmt

string

extension_name

string

bridged_username

string

diversion_number

string

extension_id

integer

did_number

string

client_owner_id

integer


GET /client/{client_id}/calls/stats/

Get calls statistics

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

extension_id

array [integer]


GET /client/{client_id}/cdr/

Get call list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

start_duration

integer

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

Resource fields

Name

Type

Description

per_page

integer

Items per page.

order

string

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 /client/{client_id}/cdr/stats/

Get calls statistics

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

extension_id

array [integer]


GET /client/{client_id}/disk_space/

Get client available free disk space

Path parameters

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

total_space

integer

fax_size

integer

voicemail_count

integer

free_space

integer

fax_count

integer

call_records_size

integer

voicemail_size

integer

call_records_count

integer


GET /client/{client_id}/disk_space/stats/

Get client available free disk space

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Start datetime.

end_datetime

string

End datetime.

Resource fields

Name

Type

Description

fax_size

integer

voicemail_count

integer

fax_count

integer

call_records_size

integer

voicemail_size

integer

call_records_count

integer


GET /client/{client_id}/extension/call_status/stats/history/

Get extension call status history

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

extension_id

array [integer]

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

action

string

duration

integer

extension_id

integer

change_dt

string

status_id

integer


GET /client/{client_id}/fax/in/

Get incoming fax messages list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

uuid

array [string]

Fax uuid.

extension_id

integer

Extension id.

extension_group_id

integer

Extension group 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

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 /client/{client_id}/fax/out/

Get client fax messages list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

extension_id

integer

start_datetime

string

Start datetime.

end_datetime

string

End datetime.

order

string

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

Resource fields

Name

Type

Description

id

integer

Resource id.

status

string

dst_num

string

extension_id

integer

datetime

string


GET /client/{client_id}/reg_status_log/

Get logs for change registrations of all client extensions

Path parameters

Name

Type

Description

client_id

string

Required.

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

status

string

date_gmt

string

short_ext_name

string


GET /client/{client_id}/voicemail/

Get voice mail messages list

Path parameters

Name

Type

Description

client_id

string

Required.

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

extension_id

integer

Extension id.

extension_group_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