Versions Compared

Key

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

GET /api/ver1.0/extension/{extension_id}/cdr/

Get cdr list

Path parameters

Name

Type

Description

extension_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

start_duration

integer

end_duration

integer

flow

array [string]

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

to_username

array [string]

from_username

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

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 /api/ver1.0/extension/{extension_id}/cdr/stats/

Get calls statistics

Path parameters

Name

Type

Description

extension_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required.

end_datetime

string

Required.

GET /api/ver1.0/extension/{extension_id}/chat/{chat_id}/messages/

Get chat messages list

Path parameters

Name

Type

Description

extension_id

string

Required.

chat_id

string

Required.

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

start_datetime

string

Start datetime.

end_datetime

string

End datetime.

order

string

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

src_num

string

dst_num

string

Resource fields

Name

Type

Description

status

string

init_time_gmt

string

src_num

string

read

boolean

text

string

flow

string

dst_num

string

chat_id

string

id

string

Resource id.

extension_id

integer

GET /api/ver1.0/extension/{extension_id}/fax/in/

Get incoming fax messages list

Path parameters

Name

Type

Description

extension_id

string

Required.

Query parameters

Name

Type

Description

uuid

array [string]

Fax uuid.

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 /api/ver1.0/extension/{extension_id}/fax/out/

Get fax messages list

Path parameters

Name

Type

Description

extension_id

string

Required.

Query parameters

Name

Type

Description

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

status

string

dst_num

string

id

integer

Resource id.

datetime

string

GET /api/ver1.0/extension/{extension_id}/fax/out/{message_id}

Get fax message

Path parameters

Name

Type

Description

extension_id

string

Required.

message_id

integer

Required.

Resource fields

Name

Type

Description

status

string

dst_num

string

id

integer

Resource id.

datetime

string

GET /api/ver1.0/extension/{extension_id}/queue/distribution/

Get agent distribution statistics

Path parameters

Name

Type

Description

extension_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

bridged_duration

integer

Default: 0

agent_extension_id

integer

offered

integer

Default: 0

failed

integer

Default: 0

agent_type

string

agent_id

integer

bridged

integer

Default: 0

GET /api/ver1.0/extension/{extension_id}/queue/events/

Get queue events

Path parameters

Name

Type

Description

extension_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

event_name

array [string]

Event type.

Resource fields

Name

Type

Description

event_name

string

Event type.

agent_extension_id

integer

call_uuid

string

agent_type

string

agent_id

integer

event_time_gmt

string

queue_id

integer

GET /api/ver1.0/extension/{extension_id}/queue/stats/

Get queue statistics

Path parameters

Name

Type

Description

extension_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

failed

integer

Default: 0

total

integer

Default: 0

bridged_duration

integer

Default: 0

bridged

integer

Default: 0

GET /api/ver1.0/extension/{extension_id}/reg_status_log/

Get logs for change registration extension

Path parameters

Name

Type

Description

extension_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 /api/ver1.0/extension/{extension_id}/voicemail/

Get voice mail messages list

Path parameters

Name

Type

Description

extension_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

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

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