Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

GET /dealer/helpers/resource_fields/{resource_name}

Get admin helper

Path parameters

Name

Type

Description

resource_name

string

Required.

Resource fields

Name

Type

Description

description

string

name

string

GET /dealer/helpers/resources

Get admin helper

Query parameters

Name

Type

Description

name

array [string]

Required.

Resource fields

Name

Type

Description

description

string

name

string

PUT /dealer/helpers/{resource_name}

Put admin helper

Path parameters

Name

Type

Description

resource_name

string

Required.

JSON parameters

Name

Type

Description

resource_description

string

field_name

string

field_description

string

Resource fields

Name

Type

Description

description

string

name

string

GET /dealer/{dealer_id}/alias/

Get alias list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

domain

array [string]

name

array [string]

id

array [integer]

extension_id

array [integer]

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

PUT /dealer/{dealer_id}/alias/{alias_id}

Update alias

Path parameters

Name

Type

Description

dealer_id

string

Required.

alias_id

integer

Required.

JSON parameters

Name

Type

Description

extension_id

integer

client_id

integer

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.

GET /dealer/{dealer_id}/alias/{alias_id}

Get alias

Path parameters

Name

Type

Description

dealer_id

string

Required.

alias_id

integer

Required.

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.

POST /dealer/{dealer_id}/client/

Add client

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

ivr_option_limit

integer

hold_music

integer

Music on hold sound id.

presence

string

One of 'yes', 'no'.

speech_to_text

boolean

blind_transfer_return

boolean

user_client_limit

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

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

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

reg_status_log

boolean

fact_address

string

extension_agent_limit

integer

exclude_codecs

string

Comma-separated list of codecs without spaces.

disk_space_notify_threshold

integer

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

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

string

incom_rule_limit

integer

ivr_context_limit

integer

Resource fields

Name

Type

Description

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blind_transfer_return

boolean

Default: False

sip_network_permission_id

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integer

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

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

integer

name

string

fact_address

string

extension_agent_limit

integer

user_client_limit

integer

exclude_codecs

string

disk_space_notify_threshold

integer

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

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

string

incom_rule_limit

integer

ivr_context_limit

integer

GET /dealer/{dealer_id}/client/

Get client list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

extension_len

array [integer]

order_by

string

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

name

array [string]

domain_id

array [integer]

id

array [integer]

prefix

array [string]

per_page

integer

type

array [string]

order

string

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

page

integer

Default: 1

Resource fields

Name

Type

Description

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blind_transfer_return

boolean

Default: False

sip_network_permission_id

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integer

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

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

integer

name

string

fact_address

string

extension_agent_limit

integer

user_client_limit

integer

exclude_codecs

string

disk_space_notify_threshold

integer

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

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

string

incom_rule_limit

integer

ivr_context_limit

integer

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

Client search

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

page

integer

Default: 1

q

string

Required.

order_by

string

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

per_page

integer

order

string

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

Resource fields

Name

Type

Description

total_count

integer

result

array [client_search]

Name

Type

Description

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blind_transfer_return

boolean

Default: False

routing_list_id

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integer

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

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

integer

name

string

fact_address

string

extension_agent_limit

integer

sip_network_permission_id

integer

exclude_codecs

string

extra_params

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

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

user_client_limit

integer

PUT /dealer/{dealer_id}/client/{client_id}

Update client

Path parameters

Name

Type

Description

dealer_id

string

Required.

client_id

integer

Required.

JSON parameters

Name

Type

Description

ivr_option_limit

integer

hold_music

integer

Music on hold sound id.

presence

string

One of 'yes', 'no'.

speech_to_text

boolean

blind_transfer_return

boolean

sip_network_permission_id

integer

hidden_json

string

network_permission_limit

integer

extension_limit

integer

extension_group_limit

integer

record_stereo

boolean

hidden_comment

string

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.

disk_space_notify_threshold

integer

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

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

Resource fields

Name

Type

Description

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blind_transfer_return

boolean

Default: False

sip_network_permission_id

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integer

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

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

integer

name

string

fact_address

string

extension_agent_limit

integer

user_client_limit

integer

exclude_codecs

string

disk_space_notify_threshold

integer

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

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

string

incom_rule_limit

integer

ivr_context_limit

integer

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

Get client

Path parameters

Name

Type

Description

dealer_id

string

Required.

client_id

integer

Required.

Resource fields

Name

Type

Description

ivr_option_limit

integer

create_date

string

hold_music

integer

presence

string

speech_to_text

boolean

Default: False

blind_transfer_return

boolean

Default: False

sip_network_permission_id

integer

hidden_json

string

network_permission_limit

integer

hidden_comment

string

prefix

string

extension_group_limit

integer

record_stereo

boolean

Default: False

extension_limit

integer

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

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

integer

name

string

fact_address

string

extension_agent_limit

integer

user_client_limit

integer

exclude_codecs

string

disk_space_notify_threshold

integer

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

record_format

string

Default: mp3

short_local_caller_id

string

disk_space_notify_email

string

extra_params

string

incom_rule_limit

integer

ivr_context_limit

integer

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

Delete client

Path parameters

Name

Type

Description

dealer_id

string

Required.

client_id

integer

Required.

GET /dealer/{dealer_id}/dealer/

Get dealer information

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

dispatcher_list_name

string

create_date

string

jur_address

string

routing_list_name

string

fact_address

string

client_calls_limit

integer

exclude_codecs

string

contact_phones

string

fax_out_greeting

integer

client_day_limit

integer

contact_emails

string

dial_rule_id

integer

ambassadors

string

type

string

id

integer

Resource id.

geo_list

string

name

string

POST /dealer/{dealer_id}/dial_rule/

Add dealer dial rule list

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

dial_rules

array [dial_rule]

Required.

name

string

Required.

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

Resource fields

Name

Type

Description

dial_rules

array [dial_rule]

dealer_id

integer

id

integer

Resource id.

client_id

integer

name

string

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

GET /dealer/{dealer_id}/dial_rule/

Get dealer dial rule lists list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

dial_rules

array [dial_rule]

dealer_id

integer

id

integer

Resource id.

client_id

integer

name

string

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

PUT /dealer/{dealer_id}/dial_rule/{dial_rules_id}

Update dealer dial rule list

Path parameters

Name

Type

Description

dealer_id

string

Required.

dial_rules_id

integer

Required.

JSON parameters

Name

Type

Description

dial_rules

array [dial_rule]

name

string

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

Resource fields

Name

Type

Description

dial_rules

array [dial_rule]

dealer_id

integer

id

integer

Resource id.

client_id

integer

name

string

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

GET /dealer/{dealer_id}/dial_rule/{dial_rules_id}

Get dealer dial rule list

Path parameters

Name

Type

Description

dealer_id

string

Required.

dial_rules_id

integer

Required.

Resource fields

Name

Type

Description

dial_rules

array [dial_rule]

dealer_id

integer

id

integer

Resource id.

client_id

integer

name

string

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

DELETE /dealer/{dealer_id}/dial_rule/{dial_rules_id}

Delete dealer dial rule list

Path parameters

Name

Type

Description

dealer_id

string

Required.

dial_rules_id

integer

Required.

GET /dealer/{dealer_id}/did/

Get did list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

domain

array [string]

name

array [string]

id

array [integer]

extension_id

array [integer]

client_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

PUT /dealer/{dealer_id}/did/{did_id}

Update did

Path parameters

Name

Type

Description

did_id

integer

Required.

dealer_id

string

Required.

JSON parameters

Name

Type

Description

local_did

boolean

Default: False

extension_id

integer

client_id

integer

message_extension_id

integer

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

GET /dealer/{dealer_id}/did/{did_id}

Get did

Path parameters

Name

Type

Description

did_id

integer

Required.

dealer_id

string

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

PUT /dealer/{dealer_id}/did_match_rules/

Update did match rules

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

Name

Type

Description

did_match_rules

array [dial_rule]

Required.

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

Resource fields

Name

Type

Description

did_match_rules

array [dial_rule]

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

GET /dealer/{dealer_id}/did_match_rules/

Get did match rules

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

did_match_rules

array [dial_rule]

Resource dial_rule

Name

Type

Description

comment

string

repl_exp

string

Required.

match_exp

string

Required.

GET /dealer/{dealer_id}/domain/

Get domain list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

domain_prefix

array [string]

id

array [integer]

name

array [string]

Resource fields

Name

Type

Description

domain_prefix

string

id

integer

Resource id.

name

string

GET /dealer/{dealer_id}/domain/{domain_id}

Get domain

Path parameters

Name

Type

Description

dealer_id

string

Required.

domain_id

integer

Required.

Resource fields

Name

Type

Description

domain_prefix

string

id

integer

Resource id.

name

string

GET /dealer/{dealer_id}/extension/

Get extension list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

status

array [string]

name

array [string]

id

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

GET /dealer/{dealer_id}/extension/search/

Extension search

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

q

string

Required.

per_page

integer

page

integer

Default: 1

Resource fields

Name

Type

Description

total_count

integer

result

array [extension_search]

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

POST /dealer/{dealer_id}/interval/

Add interval

Path parameters

Name

Type

Description

dealer_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 /dealer/{dealer_id}/interval/

Get interval list

Path parameters

Name

Type

Description

dealer_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.

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

PUT /dealer/{dealer_id}/interval/{interval_id}

Update interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

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 /dealer/{dealer_id}/interval/{interval_id}

Get interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

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.

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

DELETE /dealer/{dealer_id}/interval/{interval_id}

Delete interval

Path parameters

Name

Type

Description

dealer_id

string

Required.

interval_id

integer

Required.

POST /dealer/{dealer_id}/sound/

Add sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

Form parameters

Name

Type

Description

file

file

Required.

title

string

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 /dealer/{dealer_id}/sound/

Get sound list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

per_page

integer

title

array [string]

id

array [integer]

page

integer

Default: 1

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

PUT /dealer/{dealer_id}/sound/{sound_id}

Update sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

JSON parameters

Name

Type

Description

title

string

Sound title.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

GET /dealer/{dealer_id}/sound/{sound_id}

Get sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

Resource fields

Name

Type

Description

title

string

dealer_id

integer

id

integer

Resource id.

client_id

integer

filename

string

DELETE /dealer/{dealer_id}/sound/{sound_id}

Delete sound

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

GET /dealer/{dealer_id}/sound/{sound_id}/download/

Get sound file

Path parameters

Name

Type

Description

dealer_id

string

Required.

sound_id

integer

Required.

POST /dealer/{dealer_id}/template/

Add dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

JSON parameters

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

subject

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

GET /dealer/{dealer_id}/template/

Get dealer template list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

PUT /dealer/{dealer_id}/template/{type}/{language}

Update dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

JSON parameters

Name

Type

Description

body

string

from_name

string

from_address

string

subject

string

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

GET /dealer/{dealer_id}/template/{type}/{language}

Get dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

Resource fields

Name

Type

Description

body

string

from_name

string

from_address

string

language

string

type

string

subject

string

DELETE /dealer/{dealer_id}/template/{type}/{language}

Delete dealer template

Path parameters

Name

Type

Description

dealer_id

string

Required.

type

string

Required.

language

string

Required.

POST /dealer/{dealer_id}/user/dealer/

Add new user dealer

Path parameters

Name

Type

Description

dealer_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

dealer_id

integer

name

string

email

string

access

string

extra_params

string

timezone

string

login

string

id

integer

Resource id.

GET /dealer/{dealer_id}/user/dealer/

Get user dealer list

Path parameters

Name

Type

Description

dealer_id

string

Required.

Query parameters

Name

Type

Description

login

array [string]

id

array [integer]

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.

PUT /dealer/{dealer_id}/user/dealer/{user_id}

Update user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

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.

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.

GET /dealer/{dealer_id}/user/dealer/{user_id}

Get user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

user_id

integer

Required.

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.

DELETE /dealer/{dealer_id}/user/dealer/{user_id}

Delete user dealer

Path parameters

Name

Type

Description

dealer_id

string

Required.

user_id

integer

Required.

  • No labels