Versions Compared

Key

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

...

Query parameters

Name

Type

Description

domainpage

integer

Default: 1

per_page

integer

id

array [stringinteger]

name

array [string]

iddomain

array [integerstring]

extensionclient_id

array [integer]

clientextension_id

array [integer]

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

create_date

string

id

integer

Resource 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

user_client_limit

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

Default: False

extension_limit

integer

ambassadors

string

user_extension_limit

integer

domain_id

integer

Required.

reg_limit

integer

user_extension_group_limit

integer

extension_len

integer

Default: 3

dial_rule_limit

integer

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

exclude_codecs

string

Comma-separated list of codecs without spaces.

diskcall_spaceinteractive_notify_thresholdurl

integerstring

Call interactive url.

outg_call_VR_on_fail

boolean

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

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

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

extra_params

stringdisk_space_notify_threshold

integer

incom_rule_limit

integer

ivr_context_limit

integer

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

sip_network_permission_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

routing_list_name

object

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

user_client_limit

integer

exclude_codecs

string

diskcall_spaceinteractive_notify_thresholdurl

integerstring

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

stringdisk_space_notify_threshold

integer

incom_rule_limit

integer

ivr_context_limit

integer

call_interactive_timeout

integer

GET /dealer/{dealer_id}/client/

...

Query parameters

Name

Type

Description

extension_lenpage

array [integer]

order_by

string

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

nameinteger

Default: 1

per_page

integer

name

array [string]

domain_id

array [integer]

domain_id

array [integer]

prefix

array [string]

per_page

integer

type

array [string]

type

array [string]

extension_len

array [integer]

order_by

string

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

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

sip_network_permission_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

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

routing_list_name

object

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

user_client_limit

integer

exclude_codecs

string

diskcall_spaceinteractive_notify_thresholdurl

integerstring

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0

bl_xfer_return_timeout

integer

event_limit

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

string

disk_space_notify_threshold

integer

incom_rule_limit

integer

ivr_context_limit

integer

call_interactive_timeout

integer

...

GET /dealer/{dealer_id}/client/search/

...

Name

Type

Description

page

integer

Default: 1

per_page

integer

q

string

Required.

order_by

string

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

per_page

integer

order

string

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

...

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

...

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

sip_network_permission_id

integer

hidden_json

string

disk_space_notify_threshold

integer

network_permission_limit

integer

extension_limit

integercall_interactive_method

string

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

extension_group_limit

integer

record_stereo

boolean

hiddenextension_commentlimit

stringinteger

ambassadors

string

user_extension_limit

integer

reg_limit

integer

user_extension_group_limit

integer

outg_call_VR_on_fail

boolean

dial_rule_limit

integer

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

reg_status_log

boolean

fact_address

string

extension_agent_limit

integer

user_client_limit

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

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'. za', 'zu'.

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

string

incom_rule_limit

integer

ivr_context_limit

integer

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

sip_network_permission_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

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

routing_list_name

object

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

user_client_limit

integer

exclude_codecs

string

diskcall_spaceinteractive_notify_thresholdurl

integerstring

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0bl_xfer_return_timeout

integer

event_limit

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

language

string

string

language

string

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

stringdisk_space_notify_threshold

integer

incom_rule_limit

integer

ivr_context_limit

integer

call_interactive_timeout

integer

GET /dealer/{dealer_id}/client/{client_id}

...

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

sip_network_permission_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

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

routing_list_name

object

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

user_client_limit

integer

exclude_codecs

string

diskcall_spaceinteractive_notify_thresholdurl

integerstring

outg_call_VR_on_fail

boolean

Default: False

disk_quota

integer

Default: 0bl_xfer_return_timeout

integer

event_limit

integer

geo_list

string

did_as_transfer_caller_id

string

timezone

string

Default: Europe/Moscow

jur_address

string

languagestring

string

call_interactive_out_call

boolean

Default: False

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

stringdisk_space_notify_threshold

integer

incom_rule_limit

integer

ivr_context_limit

integer

call_interactive_timeout

integer

DELETE /dealer/{dealer_id}/client/{client_id}

...

Query parameters

domain

Name

Type

Description

page

integer

Default: 1

per_page

integer

id

array [stringinteger]

name

array [string]

iddomain

array [integerstring]

extensionclient_id

array [integer]

clientextension_id

array [integer]

per_page

integer

page

integer

Default: 1

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

create_date

string

id

integer

Resource id.

allow_message

boolean

name

string

...

Path parameters

Name

Type

Description

diddealer_id

integerstring

Required.

dealerdid_id

stringinteger

Required.

JSON parameters

Name

Type

Description

local_did

boolean

Default: False

extension_id

integer

client_id

integer

message_extension_id

integer

...

Path parameters

Name

Type

Description

diddealer_id

integerstring

Required.

dealerdid_id

stringinteger

Required.

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

create_date

string

id

integer

Resource id.

allow_message

boolean

name

string

...

Query parameters

Name

Type

Description

domain_prefixid

array [stringinteger]

idname

array [integerstring]

namedomain_prefix

array [string]

Resource fields

...

Name

Type

Description

dealer_id

string

Required.

Query parameters

...

Name

...

Type

...

Description

...

parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

id

array [string]

name

array [string]

nametype

array [string]

idstatus

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]

...

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

...

Query parameters

Name

Type

Description

page

integer

Default: 1

per_page

integer

titleid

array [stringinteger]

idtitle

array [integer]

page

integer

Default: 1string]

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

...

Name

Type

Description

body

string

Required.

from_name

string

Required.

from_address

string

Required.

language

string

Required. One of 'default', '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'.

type

string

Required. One of 'password_reset', 'call_failed_mail', 'record_archive', 'fax_delivery_success', 'fax_delivery_fail', 'email_to_fax_confirm', 'email_to_fax_fail', 'low_disk_space', 'voicemail', 'fax_to_email', 'create_user', 'create_user_extension', 'create_user_extension_group', 'call_center_report'.

subject

string

Required.

Resource fields

...

Query parameters

Name

Type

Description

loginid

array [stringinteger]

idlogin

array [integerstring]

Resource fields

Name

Type

Description

comment

string

status

string

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

...