Versions Compared

Key

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

...

Name

Type

Description

comment

string

status

string

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

name

string

concurrent_task_limit

integer

create_date_utc

string

id

integer

Resource id.

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

Add new task

Path parameters

Name

Type

Description

scheduler_id

string

Required.

client_id

string

Required.

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

...

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

Get client

Path parameters

Name

Type

Description

client_id

string

Required.

scheduler_id

string

Required.

task_id

integer

Required.

Resource fields

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

...

Name

Type

Description

try_again_pause

integer

url_success

string

name

string

start_time_utc

string

url_before

string

a_number

string

url_before_again

string

extension_id

integer

b_number

string

url_after

string

try_count

integer

Default: 1

Resource fields

Name

Type

Description

tasks

array [task_res]

...

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

variables

array [client_vars]

Required.

...

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.

...