Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

status

string

domain

string

dialcreate_rule_limitdate

integerstring

name

string

extra_params

string

extension_group_id

integer

ani

string

label

string

caller_id_name

string

client_id

integer

dial_rule_idlimit

integer

message_did

string

createdial_rule_dateid

stringinteger

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

Name

Type

Description

status

string

domain

string

dialcreate_rule_limitdate

integerstring

name

string

extra_params

string

extension_group_id

integer

ani

string

label

string

caller_id_name

string

client_id

integer

dial_rule_idlimit

integer

message_did

string

createdial_rule_dateid

stringinteger

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

Name

Type

Description

status

string

domain

string

dialcreate_rule_limitdate

integerstring

name

string

extra_params

string

extension_group_id

integer

ani

string

label

string

caller_id_name

string

client_id

integer

dial_rule_idlimit

integer

message_did

string

createdial_rule_dateid

stringinteger

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

Name

Type

Description

status

string

domain

string

dialcreate_rule_limitdate

integerstring

name

string

extra_params

string

extension_group_id

integer

ani

string

label

string

caller_id_name

string

client_id

integer

dial_rule_idlimit

integer

message_did

string

createdial_rule_dateid

stringinteger

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

Name

Type

Description

ext_group_id

integer

Required.

client_id

string

Required.

...

POST /client/{client_id}/

...

extensions_bundle/{extension_id}

Add extension bundle

Path parameters

Name

Type

Description

extension_id

integer

Required.

client_id

string

Required.

...

JSON parameters

caller_id

Name

Type

Description

startbundle_datetime

string

Start datetime.

uuid

list

array [stringinteger]

Fax uuid.

destination

array [string]

Destination number.

Resource fields

Name

Type

Description

bundle_list

array [stringinteger]

Caller id number.

end_datetime

string

End datetime.

extension_group_id

integer

Extension group id.

order

string

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

integer

GET /client/{client_id}/extensions_bundle/{extension_id}

Get extension bundle info

Path parameters

Name

Type

Description

extension_id

integer

Extension idRequired.

client_id

string

Required.

Resource fields

Name

Type

Description

uuid

string

Fax uuid.

destination

string

Destination number.

callerbundle_list

array [integer]

bundle_id

string

Caller id.

datetime

string

Record datetime.

file_size

integer

Fax file size. integer

DELETE /client/{client_id}/extensions_bundle/{extension_id}

Delete extension bundle info

Path parameters

Name

Type

Description

extension_id

integer

Extension idRequired.

client_id

integerstring

Client idRequired. extension_group

Resource fields

Name

Type

Description

bundle_list

array [integer]

bundle_id

integer

Extension group id.

...

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

Delete Get incoming fax messages in intervallist

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Start datetime. end_datetime

uuid

array [string]

End datetime.

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

Get incoming fax message

Path parameters

Name

Type

Description

fax_uuid

string

Required.

client_id

string

Required.

DELETE /client/{client_id}/fax/in/{fax_uuid}

Delete record

Path parameters

Name

Type

Description

fax_uuid

string

Required.

client_id

string

Required.

GET /client/{client_id}/fax/out/

Get client fax messages list

Path parameters

Fax uuid.

destination

array [string]

Destination number.

caller_id

array [string]

Caller id number.

end_datetime

string

End datetime.

extension_group_id

integer

Extension group id.

order

string

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

extension_id

integer

Extension id.

Resource fields

Name

Type

Description

client_iduuid

string

RequiredFax uuid.

...

Name

destination

string

Type

Description

start_datetimeDestination number.

caller_id

string

Start datetime.

extension_id

integer

end_Caller id.

datetime

string

End Record datetime.

Name

Type

Description

orderfile_size

string

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

Resource fields

integer

Fax file size.

extension_id

integer

Extension id.

client_id

integer

Resource Client id.

status

string

dst_num

string

extensionextension_group_id

integer

datetime

string

...

Extension group id.

DELETE /client/{client_id}/fax/

...

in/

Add Delete incoming fax messages in interval

Path parameters

Name

Type

Description

client_id

string

Required.

...

Query parameters

Name

Type

Description

timezonestart_datetime

string

RequiredStart datetime. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

Resource condition

end_datetime

string

End datetime.

...

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

Get incoming fax message

Path parameters

Name

Type

Description

startfax_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

uuid

string

Required.

client_id

string

Required.

DELETE /client/{client_id}/fax/in/{fax_uuid}

Delete record

Path parameters

Name

Type

Description

fax_uuid

string

Required.

client_id

string

Required.

...

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

start_datetime

string

Start datetime.

extension_id

integer

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

...

POST /client/{client_id}/interval/

Add interval

Path parameters

Name

Type

Description

client_id

string

Required.

JSON parameters

Name

Type

Description

timezone

string

Required. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

Resource condition

Name

Type

Description

start_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integer

End month day. Min: 1. Max: 31.

start_mday

integer

Start month day. Min: 1. Max: 31.

end_time

string

End time of day.

start_time

string

Start time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

Resource interval_condition

Name

Type

Description

start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

end_dow

integer

End day of week sun = 1, mon = 2, etc.

sched_active_days

integer

Min: 1.

end_mday

integer

start_mday

integer

end_time

string

type

string

start_time

string

end_datetime

string

GET /client/{client_id}/interval/

Get interval list

Path parameters

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

Resource interval_condition

Name

Type

Description

start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

integer

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integerEnd month day. Min: 1. Max: 31.

start_mday

integerStart month day. Min: 1. Max: 31.

end_time

string

End time of day. type

string

start_time

stringStart time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

...

PUT /client/{client_id}/interval/{interval_id}

Update interval

Path parameters

Name

Type

Description

dealerclient_id

integerstring

name

string

extensionRequired.

interval_id

integer

client_id

integer

Required.

JSON parameters

Name

Type

Description

timezone

string

Required. Interval timezone.

conditions

array [interval_condition]

id

integer

Resource idRequired. Datetime conditions.

name

string

Required. Interval name.

Resource

...

condition

Name

Type

Description

start_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integer

End month day. Min: 1. Max: 31.

start_mday

integer

Start month day. Min: 1. Max: 31.

end_time

string

type

string

start_time

string

end_datetime

string

GET /client/{client_id}/interval/

Get interval list

Path parameters

Name

Type

Description

client_id

string

Required

End time of day.

start_time

string

Start time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored.

Resource fields

Name

Type

Description

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

Resource interval_condition

Name

Type

Description

start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

end_dow

integer

End day of week sun = 1, mon = 2, etc.

sched_active_days

integer

Min: 1.

end_mday

integer

start_mday

integer

end_time

string

type

string

start_time

string

end_datetime

string

...

GET /client/{client_id}/interval/{interval_id}

Update Get interval

Path parameters

Name

Type

Description

client_id

string

Required.

interval_id

integer

Required.

...

Resource fields

timezone

Name

Type

Description

dealer_id

integer

name

stringRequired. Interval timezone.

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

Required. Datetime conditions.

name

string

Required. Interval name.

...

id

integer

Resource id.

Resource interval_condition

Name

Type

Description

start_datetime

string

Start datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored. start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

Month. Min: 1. Max: 12.

end_dow

integer

End day of week sun = 1, mon = 2, etc. Min: 1. Max: 7.

sched_active_days

integer

Min: 1.

end_mday

integerEnd month day. Min: 1. Max: 31.

start_mday

integer

Start month day. Min: 1. Max: 31.

end_time

string

End time of day.

start_time

string

Start time of day.

end_datetime

string

End datetime formatted as yyyy-mm-dd hh:mm:ss. if start_datetime and end_datetime passed, other condition parameters will be ignored

end_time

string

type

string

start_time

string

end_datetime

string

DELETE /client/{client_id}/interval/{interval_id}

Delete interval

Path parameters

Name

Type

Description

client_id

string

Required.

interval_id

integer

Required.

...

GET /client/{client_id}/limit/

Get client limits

Path parameters

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

dealerdisk_idquota

integer

name

string

extension_idDefault: 0

ivr_option_limit

integer

clientdial_rule_idlimit

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

Resource interval_condition

Name

Type

Description

start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

end_dow

integer

End day of week sun = 1, mon = 2, etc.

sched_active_days

integer

Min: 1.

end_mday

integer

start_mday

integer

end_time

string

type

string

start_time

string

end_datetime

string

...

user_extension_group_limit

integer

extension_agent_limit

integer

ivr_rule_limit

integer

sound_limit

integer

application_limit

integer

user_client_limit

integer

extension_group_limit

integer

user_extension_limit

integer

calls_limit

integer

network_permission_limit

integer

remote_agent_limit

integer

interval_limit

integer

event_limit

integer

extension_limit

integer

incom_rule_limit

integer

ivr_context_limit

integer

reg_limit

integer

Default: 0

...

POST /client/{client_id}/

...

network_permission/

Add network permission group

Path parameters

Name

Type

Description

client_id

string

Required.

interval_id

integer

JSON parameters

Name

Type

Description

network_address

array [string]

Network_address/mask list.

name

string

Required.

Resource fields

Name

Type

Description

dealernetwork_idcount

integer

name

string

extension_

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

client_Network permission id

integer

timezone

string

conditions

array [interval_condition]

.

client_id

integer

Resource Client id.

Resource interval_condition

Name

Type

Description

start_datetime

string

start_dow

integer

Start day of week sun = 1, mon = 2, etc.

sched_skip_days

integer

Min: 1.

sched_start_date

string

Start datetime formatted as yyyy-mm-dd.

month

integer

end_dow

integer

End day of week sun = 1, mon = 2, etc.

sched_active_days

integer

Min: 1.

end_mday

integer

start_mday

integer

end_time

string

type

string

start_time

string

end_datetime

string

...

name

string

Network permission name.

GET /client/{client_id}/network_permission/

Get network permission group list

Path parameters

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

network_count

integer

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

...

PUT /client/{client_id}/

...

network_permission/{

...

group_id}

Delete intervalUpdate network permission group

Path parameters

Name

Type

Description

clientgroup_id

stringinteger

Required.

intervalclient_id

integerstring

Required.

GET /client/{client_id}/limit/

Get client limits

...

JSON parameters

Name

Type

Description

clientnetwork_idaddress

array [stringRequired. ]

Network_address/mask list.

name

string

Resource fields

Name

Type

Description

disknetwork_quotacount

integer

Network permission count. Default: 0

ivr_option_limitnetwork_address

array [string]

Network addresses list.

id

integer

dial_rule_limit

integer

user_extension_group_limit

integer

extension_agent_limit

integer

ivr_rule_limit

integer

sound_limit

integer

application_limit

integer

user_client_limit

integer

extension_group_limit

integer

user_extension_limit

integer

calls_limit

integer

network_permission_limit

integer

remote_agent_limit

integer

interval_limit

integer

event_limit

integer

extension_limit

integer

incom_rule_limit

integer

ivr_context_limit

integer

reg_limit

integer

Default: 0

...

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

GET /client/{client_id}/network_permission/{group_id}

Get network permission group

Path parameters

Name

Type

Description

group_id

integer

Required.

client_id

string

Required.

Resource fields

Name

Type

Description

network_count

integer

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

DELETE /client/{client_id}/network_permission/{group_id}

Delete network permission group

Path parameters

Name

Type

Description

group_id

integer

Required.

client_id

string

Required.

...

GET /client/{client_id}/

...

record/

Add network permission groupGet record list

Path parameters

Name

Type

Description

client_id

string

Required.

...

Query parameters

Name

Type

Description

networkstart_addressdatetime

array [string]Network_address/mask list

Required. Start datetime.

nameorder

string

Required.

Resource fields

Name

Type

Description

network_count

integer

Network permission countDatetime sorting order. One of 'desc', 'asc'. Default: 0desc

networkend_addressdatetime

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

GET /client/{client_id}/network_permission/

Get network permission group list

...

Required. End datetime.

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

network_count

integer

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

PUT /client/{client_id}/network_permission/{group_id}

Update network permission group

Path parameters

Name

Type

Description

group_id

integer

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

network_address

array [string]

Network_address/mask list.

name

string

Resource fields

Name

Type

Description

network_count

integer

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

...

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

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

DELETE /client/{client_id}/record/

Delete records in interval

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.

...

POST /client/{client_id}/

...

record/archive/

Get record archive

Path parameters

Required.

Name

Type

Description

group_id

integer

client_id

string

Required.

...

JSON parameters

Name

Type

Description

network_count

integer

Network permission count. Default: 0

network_address

array [string]

Network addresses list.

id

integer

Network permission id.

client_id

integer

Client id.

name

string

Network permission name.

DELETE /client/{client_id}/network_permission/{group_id}

Delete network permission group

...

start_datetime

string

Required. Start datetime.

extension_id

array [integer]

email

string

Required.

end_datetime

string

Required. End datetime.

Resource fields

Name

Type

Description

groupstart_datetime

string

extension_id

array [integer

Required.

client_id

string

Required. ]

archive_uuid

string

email

string

end_datetime

string

...

GET /client/{client_id}/record/stats/

Get record statistics list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

string

Required. Start datetime.

order

string

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

end_datetime

string

Required. End datetime.

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

tofiles_usernamesize

stringinteger

sourcerecords_numbercount

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

stringinteger

...

GET /client/{client_id}/record/{record_uuid}

Get record

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

DELETE /client/{client_id}/record/{record_uuid}

Delete record

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

...

GET /client/{client_id}/record/{record_uuid}/download/

Get record with basic http authentication

Path parameters

Name

Type

Description

record_uuid

string

Required.

fromclient_domainid

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

...

Required.

...

GET /client/{client_id}/record/{record_uuid}/path/

Get ftp record path

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

...

GET /client/{client_id}/record/{record_uuid}/storage_url/

Get record storage url

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

...

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

...

POST /client/{client_id}/

...

sound/

Get record archiveAdd sound

Path parameters

Name

Type

Description

client_id

string

Required.

...

Form parameters

Name

Type

Description

start_datetimefile

stringfile

Required. Start datetime.

extension_id

array [integer]

email

title

string

Required.

end_datetime

string

Required. End datetime. Sound title.

Resource fields

Name

Type

Description

start_datetimetitle

string

Sound title.

extensiondealer_id

array [integer]

archive_uuid

string

email

string

end_datetime

id

integer

Resource id.

client_id

integer

filename

string

GET /client/{client_id}/

...

sound/

...

Get record statistics sound list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetimetitle

array [string

Required. Start datetime.

end_datetime

string

Required. End datetime.

Resource fields

Name

Type

Description

files_size

integer

records_count

integer

GET /client/{client_id}/record/{record_uuid}

Get record

...

]

own_only

boolean

id

array [integer]

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

record_uuidtitle

string

Required.

clientdealer_id

string

Required.

DELETE /client/{client_id}/record/{record_uuid}

Delete record

Path parameters

Name

Type

Description

record_uuid

string

Requiredinteger

id

integer

Resource id.

client_id

integer

filename

string

Required.

...

GET /client/{client_id}/

...

sound/search/

Client sounds search

Path parameters

Required.

Name

Type

Description

record_uuid

string

client_id

string

Required.

GET /client/{client_id}/record/{record_uuid}/path/

Get ftp record path

...

Query parameters

Name

Type

Description

record_uuidtitle

array [string

Required.

client_id

string

Required.

GET /client/{client_id}/record/{record_uuid}/storage_url/

Get record storage url

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

...

]

own_only

boolean

q

string

id

array [integer]

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

total_count

integer

...

PUT /client/{client_id}/sound/

...

{sound_id}

Update sound

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

start_datetime

stringsound_id

integer

Required. Start datetime.

end_datetime

string

Required. End datetime.

order

string

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

JSON parameters

Name

Type

Description

title

string

Sound title.

Resource fields

Name

Type

Description

statustitle

string

date_gmt

string

short_ext_namedealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

POST /client/{client_id}/sound/{sound_id}

Add Update sound file

Path parameters

Name

Type

Description

client_id

string

Required.

sound_id

integer

Required.

Form parameters

Required.

Name

Type

Description

file

file

Description

title

string

Required. Sound title.

file

file

Required.

Resource fields

Name

Type

Description

title

string

Sound title.

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /client/{client_id}/sound/{sound_id}

Get sound list

Path parameters

Name

Type

Description

client_id

string

Required.

Query parameters

Name

Type

Description

title

array [string]

own_only

boolean

id

array [integer]

per_page

integer

page

integer

Default: 1

sound_id

integer

Required.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

...

DELETE /client/{client_id}/sound/

...

Client sounds search

Path parameters

...

Name

...

Type

...

Description

...

{sound_id}

...

string

...

Required.

Query parameters

Name

Type

Description

title

array [string]

own_only

boolean

q

string

id

array [integer]

per_page

integer

page

integer

Default: 1

...

Delete sound

Path parameters

Name

Type

Description

total_count

integer

...

client_id

string

Required.

sound_id

integer

Required.

...

GET /client/{client_id}/sound/{sound_id}/download/

Update Get sound file

Path parameters

Name

Type

Description

client_id

string

Required.

sound_id

integer

Required.

...

POST /client/{client_id}/task_scheduler/

Add task scheduler

Path parameters

Name

Type

Description

client_id

string

Required.

JSON parameters

title

Name

Type

Description

comment

string

status

string

One of 'on', 'off'. Default: off

concurrent_task_limit

integer

name

string

Sound titleRequired.

Resource fields

integer

Name

Type

Description

title

string

dealer_id

comment

string

status

string

One of 'off', 'on'. Default: off

name

string

concurrent_task_limit

integer

create_date_utc

string

id

integer

Resource id.

client_id

integer

filename

string

...

PUT /client/{client_id}/

...

task_scheduler/{

...

scheduler_id}

Update sound filescheduler

Path parameters

Name

Type

Description

clientscheduler_id

string

Required.

soundclient_id

integerstring

Required.

...

JSON parameters

Name

Type

Description

titlecomment

string

Sound title.

file

file

Required.

Resource fields

Name

Type

Description

title

string

Sound title.

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /client/{client_id}/sound/{sound_id}

Get sound

Path parameters

status

string

One of 'on', 'off'. Default: off

concurrent_task_limit

integer

Resource fields

Name

Type

Description

client_idcomment

string

Required.

sound_id

integer

Required.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

status

string

One of 'off', 'on'. Default: off

name

string

concurrent_task_limit

integer

create_date_utc

string

id

integer

Resource id.

client_id

integer

filename

string

...

GET /client/{client_id}/

...

task_scheduler/{

...

scheduler_id}

Delete soundGet task scheduler by id for

Path parameters

Name

Type

Description

clientscheduler_id

string

Required.

soundclient_id

integerstring

Required.

GET /client/{client_id}/sound/{sound_id}/download/

Get sound file

Path parameters

Resource fields

Name

Type

Description

client_idcomment

string

status

string

Required.

sound_One of 'off', 'on'. Default: off

name

string

concurrent_task_limit

integer

create_date_utc

string

id

integer

RequiredResource id.

...

POST /client/{client_id}/task_scheduler/{scheduler_id}/task/

Add new task scheduler

Path parameters

Name

Type

Description

scheduler_id

string

Required.

client_id

string

Required.

JSON parameters

Required.

Name

Type

Description

comment

string

status

string

One of 'on', 'off'. Default: off

name

string

try_again_pause

integer

Try_count interval, seconds.

url_success

string

name

string

Task name.

start_time_utc

string

Required. Datetime iso8601 or seconds from now.

url_before

string

a_number

string

Required. Source call number.

url_before_again

string

extension_id

integer

Required. Task owner: extension type="phone".

b_number

string

Required. Destination call number.

url_after

string

try_count

integer

How many times a_number and b_number will try to connect. Default: 1

Resource fields

Name

Type

Description

comment

string

status

string

One of 'off'scheduled', 'executed', 'delayed', 'onfinished'. Default: offidscheduled

try_again_pause

integer

Resource id.

name

string

...

url_success

string

b_number

string

scheduler_id

...

Update scheduler

Path parameters

Name

Type

Description

scheduler_id

string

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

status

string

One of 'on', 'off'. Default: off

Resource fields

Name

Type

Description

comment

string

status

string

One of 'off', 'on'. Default: offinteger

start_time_utc

string

url_before

string

finish_result

string

One of 'success', 'failed'.

a_number

string

url_before_again

string

extension_id

integer

cdr

string

url_after

string

finish_comment

string

try_count

integer

Default: 1

create_date_utc

string

id

integer

Resource id.

name

string

...

GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id}

Get task scheduler by id forclient

Path parameters

Name

Type

Description

client_id

string

Required.

scheduler_id

string

Required.

clienttask_id

stringinteger

Required.

Resource fields

string

Name

Type

Description

comment

status

string

One of 'offscheduled', 'executed', 'delayed', 'onfinished'. Default: off

id

integer

Resource id.

name

string

POST /client/{client_id}/task_scheduler/{scheduler_id}/task/

Add new task

Path parameters

Description

Name

Type

scheduled

try_again_pause

integer

url_success

string

b_number

string

scheduler_id

integer

start_time_utc

string

Required.

client_idurl_before

string

finish_result

string

RequiredOne of 'success', 'failed'.

JSON parameters

Name

Type

Description

try_again_pause

integer

Try_count interval, seconds.

url_success

string

name

string

Task name.

start_time_utc

string

Required. Datetime iso8601 or seconds from now.

url_before

string

a_number

string

Required. Source call number.

url_before_again

string

extension_id

integer

Required. Task owner: extension type="phone".

b_number

string

Required. Destination call number.

url_after

string

try_count

integer

How many times a_number and b_number will try to connect. Default: 1

Resource fields

Name

Type

Description

status

string

One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduleda_number

string

url_before_again

string

extension_id

integer

cdr

string

url_after

string

finish_comment

string

try_count

integer

Default: 1

create_date_utc

string

id

integer

Resource id.

name

string

...

POST /client/{client_id}/task_scheduler/{scheduler_id}/tasks/

Add list of tasks

Path parameters

Name

Type

Description

scheduler_id

string

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

tasks

array [task_args]

Required.

Resource task_args

Name

Type

Description

try_again_pause

integer

url_success

string

b_numbername

string

scheduler_id

integer

start_time_utc

string

url_before

string

finishurl_resultbefore

string

One of 'success', 'failed'.

a_number

string

url_before_again

string

extension_id

integercdr

b_number

string

url_after

string

finish_comment

string

try_count

integer

Default: 1

create_date_utc

string

id

integer

Resource id.

name

string

GET /client/{client_id}/task_scheduler/{scheduler_id}/task/{task_id}

Get client

Path parameters

Resource fields

Name

Type

Description

client_id

string

Required.

scheduler_id

string

Required.

task_id

integer

Required.

Resource fields

tasks

array [task_res]

Resource task_res

Name

Type

Description

status

string

One of 'scheduled', 'executed', 'delayed', 'finished'. Default: scheduled

try_again_pause

integer

url_success

string

b_number

string

scheduler_id

integer

start_time_utc

string

url_before

string

finish_result

string

One of 'success', 'failed'.

a_number

string

url_before_again

string

extension_id

integer

cdr

string

url_after

string

finish_comment

string

try_count

integer

Default: 1

create_date_utc

string

id

integer

Resource id.

name

string

...

POST /client/{client_id}/user/client/

Add new user client

Path parameters

Name

Type

Description

client_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

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /client/{client_id}/user/client/

Get user client list

Path parameters

Name

Type

Description

client_id

string

Required.

...

Name

Type

Description

login

array [string]

id

array [integer]

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

...

PUT /client/{client_id}/user/client/{user_id}

Update user client

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

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

name

string

User name.

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

User email.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /client/{client_id}/user/client/{user_id}

Get user client

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

client_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

DELETE /client/{client_id}/user/client/{user_id}

Delete user client

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

...

POST /client/{client_id}/user/extension/

Add new user extension

Path parameters

Name

Type

Description

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

extension_id

integer

Required. User extension id.

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

email

string

access

string

extension_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /client/{client_id}/user/extension/

Get user extension list

Path parameters

Name

Type

Description

client_id

string

Required.

...

Name

Type

Description

comment

array [string]

status

array [string]

name

array [string]

id

array [integer]

access

array [string]

extension_id

array [integer]

timezone

array [string]

login

array [string]

email

array [string]

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

extension_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

...

PUT /client/{client_id}/user/extension/{user_id}

Update user extension

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

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

name

string

User name.

access

string

User access type. One of 'full', 'read_only'.

extension_id

integer

User extension id.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

User email.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

extension_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /client/{client_id}/user/extension/{user_id}

Get user extension

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

extension_id

integer

extra_params

string

timezone

string

login

string

id

integer

Resource id.

DELETE /client/{client_id}/user/extension/{user_id}

Delete user extension

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

...

Add new user extension group

Path parameters

Name

Type

Description

client_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

extra_params

string

User extra params.

access

string

User access type. One of 'full', 'read_only'.

extension_group_id

integer

Required. User extension id.

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 user extension group list

Path parameters

Name

Type

Description

client_id

string

Required.

...

Name

Type

Description

comment

array [string]

status

array [string]

name

array [string]

id

array [integer]

access

array [string]

extension_group_id

array [integer]

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.

...

Update user extension group

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

JSON parameters

Name

Type

Description

comment

string

User email.

status

string

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

name

string

User name.

extension_group_id

integer

User extension id.

access

string

User access type. One of 'full', 'read_only'.

extra_params

string

User extra params.

timezone

string

User timezone.

password

string

User password.

email

string

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 /client/{client_id}/user/extension_group/{user_id}

Get user extension group

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

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 user extension group

Path parameters

Name

Type

Description

user_id

integer

Required.

client_id

string

Required.

...

POST /client/{client_id}/variables/

Post client variables

Path parameters

Name

Type

Description

client_id

string

Required.

JSON parameters

Name

Type

Description

variablesstring

array [client_vars]

Required.

Resource client_vars

Name

Type

Description

var

string

value

string

GET /client/{client_id}/variables/

Get client variables

Path parameters

Name

Type

Description

client_id

string

Required.

...

Get voice mail messages list

Path parameters

Name

Type

Description

client_id

string

Required.

...

Name

Type

Description

start_datetime

string

Required. Start datetime.

end_datetime

string

Required. End datetime.

extension_group_id

integer

Extension id.

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

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

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

...

Delete voice mail messages in interval

Path parameters

Name

Type

Description

client_id

string

Required.

...

Get voicemail message file

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

DELETE /client/{client_id}/voicemail/{record_uuid}

Delete voice message

Path parameters

Name

Type

Description

record_uuid

string

Required.

client_id

string

Required.

...