Versions Compared

Key

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

...

Query parameters

Name

Type

Description

domain

array [string]

dealer_page

integer

Default: 1

per_page

integer

id

array [integer]

name

array [string]

iddomain

array [string]

address

array [integerstring]

extensiondealer_id

array [integer]

client_id

array [integer]

addressextension_id

array [stringinteger]

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

comment

string

domain

object

dealer_id

integer

name

string

extension_id

integer

client_id

integer

address

string

create_date

string

id

integer

Resource id.

...

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

pageq

integer

Default: 1string

Required.

Resource fields

Name

Type

Description

total_count

integer

result

array [alias]

...

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

user_id

array [string]

page

integer

Default: 1

user_id

array [string]

Resource fields

...

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

q

string

Required.

user_id

array [string]

page

integer

Default: 1

Resource fields

Name

Type

Description

total_count

integer

result

array [application]

...

Path parameters

Name

Type

Description

limitapplication_id

integerstring

Required.

applicationlimit_id

stringinteger

Required.

JSON parameters

Name

Type

Description

limit_value

integer

Required.

...

Path parameters

Name

Type

Description

limitapplication_id

integerstring

Required.

applicationlimit_id

stringinteger

Required.

Resource fields

Name

Type

Description

limit_value

integer

id

integer

Resource id.

limit_name

string

...

Path parameters

Name

Type

Description

limitapplication_id

integerstring

Required.

applicationlimit_id

stringinteger

Required.

...

PUT /admin/application/{id}

...

JSON parameters

Name

Type

Description

hidden_comment

string

forced_prefix

string

hold_music

integer

Music on hold sound id.

presence

string

One of 'yes', 'no'.

speech_to_text

boolean

blindrecord_transfer_returnstereo

boolean

Default: False

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_comment

string

record_stereo

boolean

Default: False

limit

integer

extension_group_limit

integer

ivr_option_limit

integer

extension_limit

integercall_interactive_method

string

Call interactive method. One of 'GET', 'POST'. Default: GET

ambassadors

string

user_extension_limit

integer

domain_id

integer

Required.

reg_limit

integer

user_extension_group_limit

integer

extension_len

integer

Default: 3

dealer_id

integer

Required.

reg_status_log

boolean

sound_limit

integer

application_limit

integer

contact_phones

string

name

string

Required.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

One of 'J', 'F'.

email

string

Required.

status

string

One of 'active', 'blocked'.

ivr_rule_limit

integer

regextra_status_logparams

booleanstring

fact_address

string

extension_agent_limit

integer

user_client_limit

integer

exclude_codecs

string

Comma-separated list of codecs without spaces.

extracall_interactive_paramsurl

string

Call interactive url.

outg_call_VR_on_fail

boolean

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

dial_rule_limit

integer

geo_list

string

did_as_transfer_caller_id

string

One of 'default', 'from', 'diversion'.

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'.

ivr_context_limit

integer

call_interactive_out_call

boolean

Default: False

record_format

string

One of 'mp3', 'wav'. Default: mp3

short_local_caller_id

string

One of 'yes', 'no'.

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

Music for outg_call_vr_on_fail param.

call_interactive_timeout

integer

Call interactive timout.

Resource fields

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blindreg_transfer_returnlimit

booleaninteger

Default: False0

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_commentlimit

stringinteger

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integercall_interactive_method

string

Default: GET

ambassadors

string

user_extension_limit

integer

domain_idinteger

reg_limit

integer

Default: 0

user_extension_group_limit

integer

extension_len

integer

dial_rule_limit

integer

reg_status_log

boolean

name

string

sound_limit

integer

application_limit

integer

contact_phones

string

id

integer

Resource id.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

email

string

status

string

ivr_rule_limit

integername

extra_params

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extracall_interactive_paramsurl

string

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0bl_xfer_return_timeout

integer

event_limit

integer

dealer_id

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

ivr_context_limit

integer

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

call_interactive_timeout

integer

user_client_limit

integer

GET /admin/client/

...

Query parameters

extension_len

Name

Type

Description

page

integer

Default: 1

per_page

integer

name

array [integerstring]

dealer_id

array [integer]

namedomain_id

array [stringinteger]

domaindealer_id

array [integer]

routing_list_id

array [integer]

idprefix

array [integerstring]

prefixtype

array [string]

extension_len

array [integer]

order_by

string

One of 'name', 'prefix', 'domain_id', 'status'.

per_page

integer

type

array [string]

order

string

One of 'desc', 'asc'. Default: asc

page

integer

Default: 1

Resource fields

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blindreg_transfer_returnlimit

booleaninteger

Default: False0

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_commentlimit

stringinteger

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integercall_interactive_method

string

Default: GET

ambassadors

string

user_extension_limit

integer

domain_idinteger

reg_limit

integer

Default: 0

user_extension_group_limit

integer

extension_len

integer

dial_rule_limit

integer

reg_status_log

boolean

name

string

sound_limit

integer

application_limit

integer

contact_phones

string

id

integer

Resource id.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

email

string

status

string

ivr_rule_limit

integername

extra_params

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extracall_interactive_paramsurl

string

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0bl_xfer_return_timeout

integer

event_limit

integer

dealer_id

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

ivr_context_limit

integer

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

call_interactive_timeout

integer

user_client_limit

integer

...

GET /admin/client/search/

...

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

q

string

Required.

order_by

string

One of 'name', 'prefix', 'domain_id', 'status'.

order

string

One of 'desc', 'asc'. Default: asc

q

string

Required.

dealer_id

integer

per_page

integer

page

integerDefault: 1

Resource fields

Name

Type

Description

total_count

integer

result

array [client_search]

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blindreg_transfer_returnlimit

booleaninteger

Default: False0

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_commentlimit

stringinteger

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integercall_interactive_method

string

Default: GET

ambassadors

string

user_extension_limit

integer

domain_id

integer

reg_limit

integer

Default: 0

user_extension_group_limit

integer

extension_len

integer

dial_rule_limit

integer

reg_status_log

boolean

name

string

sound_limit

integer

application_limit

integer

contact_phones

string

id

integer

Resource id.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

email

string

status

string

ivr_rule_limit

integername

extra_params

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extracall_interactive_paramsurl

string

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

dealer_id

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

ivr_context_limit

integer

record_format

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

call_interactive_timeout

integer

user_client_limit

integer

...

PUT /admin/client/{client_id}

...

JSON parameters

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

hold_music

integer

Music on hold sound id.

presence

string

One of 'yes', 'no'.

speech_to_text

boolean

blindreg_transfer_returnlimit

booleaninteger

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddencall_interactive_commentmethod

string

Call interactive method. One of 'GET', 'POST'. Default: GET

extension_group_limit

integer

record_stereo

boolean

extension_limit

integer

ambassadors

string

user_extension_limit

integer

reg_limit

integer

user_extension_group_limit

integer

outg_call_VR_on_fail

boolean

dealer_id

integer

reg_status_log

boolean

sound_limit

integer

application_limit

integer

contact_phones

string

name

string

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

One of 'J', 'F'.

email

string

status

string

One of 'active', 'blocked'.

ivr_rule_limit

integer

regextra_status_logparams

booleanstring

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

Comma-separated list of codecs without spaces.

diskcall_space_notify_thresholdintegerinteractive_url

string

Call interactive url.

disk_quota

integer

bl_xfer_return_timeout

integer

event_limit

integer

dial_rule_limit

integer

geo_list

string

did_as_transfer_caller_id

string

One of 'default', 'from', 'diversion'.

timezone

string

jur_address

string

language

string

One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'.

ivr_context_limit

integer

call_interactive_out_call

boolean

Default: False

record_format

string

One of 'mp3', 'wav'.

short_local_caller_id

string

One of 'yes', 'no'.

disk_space_notify_email

string

extra_params

stringdisk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

Music for outg_call_vr_on_fail param.

call_interactive_timeout

integer

Call interactive timout.

user_client_limit

integer

Resource fields

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blindreg_transfer_returnlimit

booleaninteger

Default: False0

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_commentlimit

stringinteger

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integercall_interactive_method

string

Default: GET

ambassadors

string

user_extension_limit

integer

domain_idinteger

reg_limit

integer

Default: 0

user_extension_group_limit

integer

extension_len

integer

dial_rule_limit

integer

reg_status_log

boolean

name

string

sound_limit

integer

application_limit

integer

contact_phones

string

id

integer

Resource id.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

email

string

status

string

ivr_rule_limit

integername

extra_params

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extracall_interactive_paramsurl

string

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

dealer_id

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

ivr_context_limit

integer

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

call_interactive_timeout

integer

user_client_limit

integer

...

Resource fields

Name

Type

Description

hidden_comment

string

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blindreg_transfer_returnlimit

booleaninteger

Default: False0

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hiddenextension_commentlimit

stringinteger

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integercall_interactive_method

string

Default: GET

ambassadors

string

user_extension_limit

integer

domain_id

integer

reg_limit

integer

Default: 0

user_extension_group_limit

integer

extension_len

integer

dial_rule_limit

integer

reg_status_log

boolean

name

string

sound_limit

integer

application_limit

integer

contact_phones

string

id

integer

Resource id.

calls_limit

integer

remote_agent_limit

integer

interval_limit

integer

outg_call_VR_code_list

string

dial_rule_id

integer

type

string

email

string

status

string

ivr_rule_limit

integername

extra_params

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extracall_interactive_paramsurl

string

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

dealer_id

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

ivr_context_limit

integer

record_format

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

VR_sound

integer

call_interactive_timeout

integer

user_client_limit

integer

DELETE /admin/client/{client_id}

...

Name

Type

Description

id

array [integer]

valuename

array [string]

namevalue

array [string]

Resource fields

...

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

id

array [integer]

name

array [string]

domain

array [string]

dealertrunk_id

array [integer]

namedealer_id

array [stringinteger]

order_type

string

One of 'desc', 'asc'. Default: asc

client_id

array [integer]

extension_id

array [integer]

clientmessage_extension_id

array [integer]

order_by

string

One of 'name', 'id'. Default: name

perorder_pagetype

integer

trunk_id

array [integer]

page

integer

Default: 1

message_extension_id

array [integer]

string

One of 'desc', 'asc'. Default: asc

Resource fields

Name

Type

Description

comment

string

domain

object

dealer_id

integer

message_extension_id

integer

local_did

boolean

extension_id

integer

client_id

integer

registration

boolean

Default: False

create_date

string

trunk_id

integer

id

integer

Resource id.

allow_message

boolean

name

string

...

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

page

integer

Default: 1

q

string

Required.

client_id

string

Resource fields

Name

Type

Description

total_count

integer

result

array [did_search]

...

Query parameters

Name

Type

Description

commentid

array [stringinteger]

domain_prefixname

array [string]

iddomain_prefix

array [integerstring]

namecomment

array [string]

Resource fields

...

Query parameters

status

Name

Type

Description

page

integer

Default: 1

per_page

integer

id

array [string]

name

array [string]

idtype

array [string]

status

array [string]

client_id

array [integer]

extension_group_id

array [integer]

per_page

integer

type

array [string]

page

integer

Default: 1

Resource fields

Name

Type

Description

status

string

domain

string

dial_rule_limit

integer

from_public_caller_id_number

boolean

Default: False

extra_params

string

name

string

rfc_public_caller_id_number

boolean

Default: False

extension_group_id

integer

public_caller_id_number

string

label

string

caller_id_name

string

client_id

integer

dial_rule_id

integer

message_did

string

create_date

string

ani_rfc3325

boolean

type

string

id

integer

Resource id.

did_as_transfer_caller_id

string

...

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

pageq

integer

Default: 1string

Required.

Resource fields

Name

Type

Description

total_count

integer

result

array [extension_search]

...

Name

Type

Description

auth_type

string

One of 'digest', 'network', 'both'. Default: digest

vm_enabled

boolean

Voicemail enabled.

hold_music

integer

Music on hold sound id.

keep_alive

boolean

preserve_caller_id_number_att_tr

boolean

Preserve original caller id number on attended transfer.

conference_pin

string

conference_end_on_exit

boolean

network_permission_group_id

integer

append_to_cid_name_on_transfer

string

Append to cid name on transfer.

static_reg_user

string

Static registration user.

record_stereo

string

One of 'yes', 'no', 'None'.

hangup_timeout

integer

Timeout in seconds before hangup if extension does not answer.

incoming_limit

integer

vm_mailto

string

Email address for voicemail notifications.

conference_announce_sound_upon_incoming_callintegercaller_name

boolean

vm_greeting

integer

Voicemail greeting sound id.

record_enabled

boolean

Call record enabled.

vm_attach_file

boolean

Attach voicemail message to notification email.

intercom

integer

conferenceannounce_sound_announceupon_callerincoming_namecall

booleaninteger

announce_sound_upon_outgoing_call

integer

transfer_caller_id_number

string

Transfer caller id number.

ignore_early_media

boolean

Ignore early media.

static_reg_host

string

Static registration host.

vm_profile

string

Voicemail configuration. One of 'default', 'record_silence'.

static_reg_address

string

Static registration address:port.

password

string

geo_list

string

call_screening_enabled

boolean

Call screening enabled.

ringback_sound

integer

Ringback sound id.

record_format

string

One of 'mp3', 'wav', 'None'.

replace_pin

string

record_transfer

boolean

external_number

string

...

Name

Type

Description

auth_type

string

vm_enabled

boolean

Default: False

hold_music

integer

keep_alive

boolean

preserve_caller_id_number_att_tr

boolean

Default: False

conference_pin

string

conference_end_on_exit

boolean

Default: True

network_permission_group_id

integer

append_to_cid_name_on_transfer

string

static_reg_user

object

record_stereo

string

hangup_timeout

integer

Default: 60

incoming_limit

integer

vm_mailto

string

conference_announce_caller_name

boolean

Default: False

label

string

vm_greeting

integer

record_enabled

boolean

Default: False

vm_attach_file

boolean

Default: True

intercom

integer

announce_sound_upon_incoming_call

integer

announce_sound_upon_outgoing_call

integer

transfer_caller_id_number

string

ignore_early_media

boolean

Default: False

static_reg_host

object

vm_profile

string

Default: default

bundle_id

integer

static_reg_address

string

geo_list

string

bundle_list

array [integer]

call_screening_enabled

boolean

Default: False

ringback_sound

integer

record_format

string

replace_pin

string

record_transfer

boolean

Default: False

external_number

string

...

Name

Type

Description

auth_type

string

vm_enabled

boolean

Default: False

hold_music

integer

keep_alive

boolean

preserve_caller_id_number_att_tr

boolean

Default: False

conference_pin

string

conference_end_on_exit

boolean

Default: True

network_permission_group_id

integer

append_to_cid_name_on_transfer

string

static_reg_user

object

record_stereo

string

hangup_timeout

integer

Default: 60

incoming_limit

integer

vm_mailto

string

conference_announce_caller_name

boolean

Default: False

label

string

vm_greeting

integer

record_enabled

boolean

Default: False

vm_attach_file

boolean

Default: True

intercom

integer

announce_sound_upon_incoming_call

integer

announce_sound_upon_outgoing_call

integer

transfer_caller_id_number

string

ignore_early_media

boolean

Default: False

static_reg_host

object

vm_profile

string

Default: default

bundle_id

integer

static_reg_address

string

geo_list

string

bundle_list

array [integer]

call_screening_enabled

boolean

Default: False

ringback_sound

integer

record_format

string

replace_pin

string

record_transfer

boolean

Default: False

external_number

string

...

Query parameters

Name

Type

Description

per_page

integerpage

Default: 1

per_page

integerDefault: 1

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.

...

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

pageq

integer

Default: 1string

Required.

Resource fields

Name

Type

Description

total_count

integer

result

array [network_permission]

...

Name

Type

Description

group_id

integer

Required.

...

POST /admin/notify_extension/

Notify extensions

JSON parameters

Name

Type

Description

extension_ids

array [integer]

Extension id for notification.

need_reboot

boolean

Need to reboot extensions. Default: False

Resource fields

Name

Type

Description

notify_status

string

...

GET /admin/rate_limit/

Get rate limit list

Resource fields

Name

Type

Description

limit

integer

id

integer

Resource id.

name

string

...

Name

Type

Description

limit_id

integer

Required.

JSON parameters

Name

Type

Description

limit

integer

Required.

Resource fields

Name

Type

Description

limit

integer

id

integer

Resource id.

name

string

...

Name

Type

Description

limit_id

integer

Required.

Resource fields

Name

Type

Description

limit

integer

id

integer

Resource id.

name

string

...

Get count of registered extensions

Resource fields

Name

Type

Description

registration_count

integer

...

POST /admin/

...

routing/

Get restapi logs

...

Add routing list

JSON parameters

Name

Type

Description

startrouting_datetimestringrules

array [routing_rule]

Required. Routing rules list.

methodname

array [string]

end_datetimestring

Required. Routing list name.

Resource routing_rule

Name

Type

Description

prefix

string

Required.

clienttrunk_idids

array [integer]

per_page

integer

page

integer

Default: 1

resource_type

array [string]

extension_id

array [integer]

Resource fields

Name

Type

Description

application_id

string

description

string

url

string

response_code

string

id

integer

Resource id.

method

string

extension_id

integer

client_id

integer

dt

string

ip_address

string

auth_id

integer

resource_type

string

POST /admin/routing/

Add routing list

JSON parameters

trunk_id]

description

string

Resource fields

Name

Type

Description

routing_rules

array [routing_rule]Required. Routing rules list.

id

integer

Resource id.

name

string

Required. Routing list name.

Resource routing_rule

Name

Type

Description

prefix

string

Required.

trunk_ids

array [trunk_id]

description

string

GET /admin/routing/

Get routing list

Resource fields

Name

Type

Description

routing_rules

array [routing_rule]

id

integer

Resource id.

name

string

Resource routing_rule

Name

Type

Description

prefix

string

Required.

trunk_ids

array [trunk_id]

description

string

...

PUT /admin/routing/{id}

Get Update routing list

...

Path parameters

Name

Type

Description

routing_rules

array [routing_rule]

id

integer

Resource id.

name

string

Resource routing_rule

Name

Type

Description

prefix

string

Required.

trunk_ids

array [trunk_id]

description

string

PUT /admin/routing/{id}

Update routing list

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

JSON parameters

Name

Type

Description

routing_rules

array [routing_rule]

Routing rules list.

name

string

Routing list name.

...

Form parameters

Name

Type

Description

filetitlefile

string

Required. Sound title. title

file

stringfile

Required. Sound title.

Resource fields

Name

Type

Description

title

string

Sound title.

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /admin/sound/

Get sound list

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

titleid

array [stringinteger]

idtitle

array [integerstring]

page

integer

Default: 1

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

...

GET /admin/sound/search/

Common sounds search

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

pageq

integer

Default: 1string

Required.

Resource fields

Name

Type

Description

total_count

integer

...

Name

Type

Description

sound_id

integer

Required.

JSON parameters

Name

Type

Description

title

string

Sound title.

...

POST /admin/trunk/

Add trunk

JSON parameters

Name

Type

Description

from_domain

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

any_extension

string

One of 'yes', 'no'. Default: no

strip

integer

any_did

string

One of 'yes', 'no'. Default: no

pri_prefix

string

from_username

string

auth_pass

string

channel_limit

integer

Default: 0

call_interactive_fields

string

direction

string

Required. One of 'in', 'out', 'all'.

src_address

string

history_info

boolean

Default: False

status_in

string

One of 'active', 'blocked'.

rfc_2543_in

string

One of 'yes', 'no'.

address

string

insert_internal_user

string

One of 'yes', 'no'.

auth_username

string

name

string

Required.

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

status_outuse_dns_srv

boolean

Default: False

status_out

string

One of 'active', 'blocked'.

Resource fields

Name

Type

Description

fromsrc_domainaddress

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

Default: []

any_extension

string

strip

integer

any_did

string

id

integer

Resource id.

pri_prefix

string

from_username

string

auth_pass

string

channelfrom_limit

integer

Default: 0domain

string

call_interactive_fields

string

direction

string

src_address

stringchannel_limit

integer

Default: 0

history_info

boolean

Default: False

status_in

string

rfc_2543_in

string

address

string

insert_internal_user

string

auth_username

string

name

string

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

GET /admin/trunk/

Get trunk list

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

network_permission_group_idname

array [integerstring]

id

array [integer]

page

integer

Default: 1

name

array [stringnetwork_permission_group_id

array [integer]

Resource fields

Name

Type

Description

fromsrc_domainaddress

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

Default: []

any_extension

string

strip

integer

any_did

string

id

integer

Resource id.

pri_prefix

string

from_username

string

auth_pass

string

channelfrom_limitdomain

integerstring

Default: 0

call_interactive_fields

string

direction

string

src_address

stringchannel_limit

integer

Default: 0

history_info

boolean

Default: False

status_in

string

rfc_2543_in

string

address

string

insert_internal_user

string

auth_username

string

name

string

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

...

GET /admin/trunk/search/

Trunk search

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

pageq

integer

Default: 1string

Required.

Resource fields

Name

Type

Description

total_count

integer

result

array [trunk_search]

Name

Type

Description

fromsrc_domainaddress

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

Default: []

any_extension

string

strip

integer

any_did

string

id

integer

Resource id.

pri_prefix

string

from_username

string

auth_pass

string

channelfrom_limit

integer

Default: 0domain

string

call_interactive_fields

string

direction

string

src_address

stringchannel_limit

integer

Default: 0

history_info

boolean

Default: False

status_in

string

rfc_2543_in

string

address

string

insert_internal_user

string

auth_username

string

name

string

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

...

PUT /admin/trunk/{id}

...

Name

Type

Description

id

integer

Required. Resource id.

JSON parameters

Name

Type

Description

from_domain

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

any_extension

string

One of 'yes', 'no'. Default: no

strip

integer

any_did

string

One of 'yes', 'no'. Default: no

pri_prefix

string

from_username

string

auth_pass

string

channel_limit

integer

Default: 0

call_interactive_fields

string

direction

string

Required. One of 'in', 'out', 'all'.

src_address

string

history_info

boolean

Default: False

status_in

string

One of 'active', 'blocked'.

rfc_2543_in

string

One of 'yes', 'no'.

address

string

insert_internal_user

string

One of 'yes', 'no'.

auth_username

string

name

string

Required.

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

One of 'active', 'blocked'.

Resource fields

Name

Type

Description

fromsrc_domainaddress

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

Default: []

any_extension

string

strip

integer

any_did

string

id

integer

Resource id.

pri_prefix

string

from_username

string

auth_pass

string

channelfrom_limitdomain

integerstring

Default: 0

call_interactive_fields

string

direction

string

src_address

string

channel_limit

integer

Default: 0

history_info

boolean

Default: False

status_in

string

rfc_2543_in

string

address

string

insert_internal_user

string

auth_username

string

name

string

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

GET /admin/trunk/{id}

...

Resource fields

Name

Type

Description

fromsrc_domainaddress

string

backup_errors_regexp

string

rfc_3325_out_uri

string

network_permission_group_id

integer

super_trunk_ip

array [string]

Default: []

any_extension

string

strip

integer

any_did

string

id

integer

Resource id.

pri_prefix

string

from_username

string

auth_pass

string

channelfrom_limitdomain

integerstring

Default: 0

call_interactive_fields

string

direction

string

src_address

stringchannel_limit

integer

Default: 0

history_info

boolean

Default: False

status_in

string

rfc_2543_in

string

address

string

insert_internal_user

string

auth_username

string

name

string

outin_anumber_rule_id

integer

inout_anumber_rule_id

integer

non_backup_errors_regexp

string

use_dns_srv

boolean

Default: False

status_out

string

DELETE /admin/trunk/{id}

...

POST /admin/user/admin/

Add admin user

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.

...

GET /admin/user/admin/

Get admin user list

Query parameters

Name

Type

Description

loginid

array [stringinteger]

idlogin

array [integerstring]

Resource fields

Name

Type

Description

comment

string

status

string

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

...

Name

Type

Description

user_id

integer

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.

...

GET /admin/users/

Get user list

Query parameters

boolean

Name

Type

Description

admin

page

integer

Default: 1

per_page

integer

id

array [integer]

login

array [string]

sha256pass

array [string]

per_pageadmin

integerboolean

loginstatus

array [string]

page

integer

Default: 1string

One of 'active', 'blocked'.

access

string

One of 'full', 'read_only'.

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

Id of dealer resource.

name

string

admin

boolean

User is admin. Default: False

extra_params

string

id

integer

Resource id.

access

string

extension_id

integer

Id of extension resource.

client_id

integer

Id of client resource.

extension_group_id

integer

Id of extension_group resource.

timezone

string

login

string

email

string

...

GET /admin/users/search/

User search

Query parameters

Name

Type

Description

qpage

string

Required. integer

Default: 1

per_page

integer

q

string

Required.

admin

boolean

page

integer

Default: 1

status

string

One of 'active', 'blocked'.

access

string

One of 'full', 'read_only'.

Resource fields

Name

Type

Description

total_count

integer

result

array [user_search]

...

Name

Type

Description

user_id

integer

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.

...

Name

Type

Description

user_id

string

Required.

JSON parameters

Name

Type

Description

network_address

array [string]

Network_address/mask list.

description

array [string]

Network_address/mask list.

...

Name

Type

Description

user_id

integer

network_address

string

description

string

id

integer

Resource id.

PUT /admin/{client_id}/phone_event/{id}

Update client event

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

client_id

string

Required.

JSON parameters

Name

Type

Description

url

string

Request url.

event_type

string

Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'.

method

string

Http request method. One of 'GET', 'POST'.

Resource fields

Name

Type

Description

url

string

method

string

event_type

string

id

integer

Resource id.

GET /admin/{client_id}/phone_event/{id}

Get client event

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

client_id

string

Required.

Resource fields

Name

Type

Description

url

string

method

string

event_type

string

id

integer

Resource id.

DELETE /admin/{client_id}/phone_event/{id}

Delete client event

Path parameters

Name

Type

Description

id

integer

Required. Resource id.

client_id

string

Required.

POST /admin/{client_id}/phone_events/

Add client phone event

Path parameters

Name

Type

Description

client_id

string

Required.

JSON parameters

Name

Type

Description

url

string

Required. Request url.

event_type

string

Required. Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'voicemail'.

method

string

Required. Http request method. One of 'GET', 'POST'.

Resource fields

Name

Type

Description

url

string

method

string

event_type

string

id

integer

Resource id.

GET /admin/{client_id}/phone_events/

Get client event list

Path parameters

Name

Type

Description

client_id

string

Required.

Resource fields

Name

Type

Description

url

string

method

string

event_type

string

id

integer

Resource id.

DELETE /admin/{client_id}/phone_events/

Delete all client events

...

GET /admin/voicemail/{record_uuid}/full_path/

Get voicemail storage url

Path parameters

Name

Type

Description

clientrecord_iduuid

string

Required.

...