Page Comparison

device

string

real_address

string

contact_address

string

expires

integer

registration_id

string

call_list

array [call_mdl]

called_number

string

record_uuid

string

init_time_gmt

string

real_call

boolean

Default: True

call_flow

string

called_did

string

callback_id

string

caller_id_name

string

call_api_id

string

extension_id

integer

answer_time_gmt

string

caller_id_number

string

delay

integer

Required.

number

string

Required.

allow_public_transfer

boolean

Default: False

extension_call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

playfile_sound

integer

enable_call_screening

boolean

Default: False

enabled

boolean

Default: True

interval

integer

caller_id_action

string

control_code

string

caller_id

string

id

integer

Resource id.

extension_status

string

One of 'registered', 'unreachable', 'any'. Default: any

transfer_timeout

integer

ignore_early_media

boolean

Default: False

transfer_dst

string

cascade_numbers

array [cascade_number]

type

string

final

boolean

Default: True

name

string

delay

integer

Required.

number

stringRequired.

allow_public_transfer

boolean

Default: False

extension_call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

playfile_sound

integer

enable_call_screening

boolean

Default: False

enabled

boolean

Default: True

interval

integer

caller_id_action

string

control_code

string

caller_id

string

id

integer

Resource id.

extension_status

string

One of 'registered', 'unreachable', 'any'. Default: any

transfer_timeout

integer

ignore_early_media

boolean

Default: False

transfer_dst

string

cascade_numbers

array [cascade_number]

type

string

final

boolean

Default: True

delay

integer

Required.

name

string

number

string

Required.

allow_public_transfer

boolean

Allow public called destinations to transfer calls.

extension_call_status

string

Extension call status. One of 'no_answer', 'busy', 'any'.

call_status

string

Call status. One of 'no_answer', 'busy', 'any'.

transfer_dst

string

Transfer destination for transfer rule. multiple destinations divided by space.

enable_call_screening

boolean

Enable call screening for transfer call.

enabled

boolean

Rule is active.

interval

integer

Time interval id.

caller_id_action

string

Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'.

control_code

string

Rule control code.

caller_id

string

Caller id.

ignore_early_media

boolean

While transfer play ring back tones instead of early media.

extension_status

string

Extension status. One of 'registered', 'unreachable', 'any'.

transfer_timeout

integer

Ring to transfer destination this count of seconds.

playfile_sound

integer

Sound id for playfile rule.

cascade_numbers

array [cascade_number]

List of elements for cascade rule.

type

string

Rule type. One of 'busy', 'transfer', 'hangup', 'playfile', 'voicemail', 'cascade', 'simple_transfer', 'simple_cascade'.

final

boolean

If rule is final, next rules will be not executed if call failed.

name

string

Rule name.

delay

integer

Required. number

string

Required.

allow_public_transfer

boolean

Default: False

extension_call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

call_status

string

One of 'no_answer', 'busy', 'any'. Default: any

playfile_sound

integer

enable_call_screening

boolean

Default: False

enabled

boolean

Default: True

interval

integer

caller_id_action

string

control_code

string

caller_id

string

id

integer

Resource id.

extension_status

string

One of 'registered', 'unreachable', 'any'. Default: any

transfer_timeout

integer

ignore_early_media

boolean

Default: False

transfer_dst

string

cascade_numbers

array [cascade_number]

type

string

final

boolean

Default: True

delay

integer

Required.

name

string

number

string

Required.

delay

integer

Required.

number

string

Required.

start_datetimedealer_id

integer

name

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.

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

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

extension_id

string

Required.

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

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

extension_id

string

Required.

interval_id

integer

Required.

timezone

string

Required. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

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.

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

extension_id

string

Required.

startdealer_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

id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

extension_id

string

Required.

interval_id

integer

Required.

timezone

string

Required. Interval timezone.

conditions

array [condition]

Required. Datetime conditions.

name

string

Required. Interval name.

extension_id

string

Required.

interval_id

integer

Required.

dealer_id

integer

name

string

extension_id

integer

client_id

integer

timezone

string

conditions

array [interval_condition]

id

integer

Resource id.

transfer_variable

string

Variable name for transfer_from_variable.

call_status

string

Call status. One of 'no_answer', 'busy', 'any'. Default: any

play_digits_method

string

Playing method to play digits. One of 'pronounced', 'iterated', 'None'.

voice_helper_classic_term

boolean

If true - classic ivr navigation from the keyboard will be enabled after recognition (if none of the matches were received earlier).

caller_id

string

Caller id.

match_variable_value

string

Variable value for variable-based condition.

play_digits_variable

string

Variable name for play_digits_variable.

call_interactive_method

string

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

voice_helper_timeout

integer

Timeout in milliseconds before stop listen voice and start recognize.

record_digits_max

integer

Maximum digits amount for record_digits.

is_simple_transfer

boolean

If true - transfer to dst from variable will be simple, default false. Default: False

voice_helper_digits_max

integer

Maximum digits to terminate listen voice and start recognize.

match_variable_name

string

Variable name for variable-based condition.

caller_id_action

string

Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. Default: any

context_option

string

Context option to jump.

silence_time

integer

Silence duration in milliseconds.

set_variable_name

string

Variable name for set_variable.

caller_id_number

string

Caller_id_number.

hangup_cause

string

One of 'normal', 'busy'. Default: normal

final

boolean

If rule is final, next rules will be not executed if call failed. Default: True

sound

integer

Sound to play.

sound_type

string

Sound type. One of 'background', 'foreground', 'None'.

max_rate

integer

call_interactive_url

string

Call interactive url.

order_position

string

Insert new rule in position.

caller_id_name

string

Caller_id_name.

voice_helper_rules

array [voice_helper_rules]

List of elements for voice helper rule.

transfer_timeout

integer

Ring to transfer destination this count of seconds.

digits

string

Digits to play.

name

string

Rule name.

record_digits_variable

string

Variable name for record_digits.

play_sound_from_variable

boolean

Check if sound in variable- if so - file from variable will be played instead other sound.

interval

integer

Rule time interval.

record_digits_timeout

integer

Record digits timeout in milliseconds.

transfer_dst

string

Transfer destination.

context

integer

Context to jump.

action

string

Required. Rule action. One of 'transfer', 'hangup', 'play_sound', 'play_silence', 'jump_to_context', 'play_digits', 'call_interactive', 'transfer_from_variable', 'set_variable', 'voicemail', 'simple_transfer', 'set_caller_id_name', 'set_caller_id_number', 'record_digits', 'play_digits_from_variable', 'quality_rate', 'voice_helper', 'start_record'.

set_variable_value

string

Variable value for set_variable.

call_interactive_timeout

integer

Call interactive timout.

record_digits_sound

integer

Id of sound to play record_digits.

transcription

string

Required.

to_option

integer

Required

Call interactive timout.

record_digits_sound

integer

Id of sound to play record_digits.

transfer_variable

string

call_status

string

Default: any

play_digits_method

string

voice_helper_classic_term

boolean

Default: True

caller_id

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

voice_helper_timeout

integer

id

integer

Resource id.

record_digits_max

string

is_simple_transfer

boolean

Default: False

voice_helper_digits_max

string

match_variable_name

string

caller_id_action

string

context_option

string

silence_time

integer

set_variable_name

string

caller_id_number

string

hangup_cause

string

Default: normal

final

boolean

Default: True

sound

integer

sound_type

string

max_rate

integer

Default: 5

call_interactive_url

string

caller_id_name

string

voice_helper_rules

array [voice_helper_rules]

transfer_timeout

integer

digits

string

name

string

record_digits_variable

string

play_sound_from_variable

boolean

Default: False

interval

integer

record_digits_timeout

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

transcription

string

Required.

to_option

integerRequired.

transfer_variable

string

call_status

string

Default: any

play_digits_method

string

voice_helper_classic_term

boolean

Default: True

caller_id

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

voice_helper_timeout

integer

id

integer

Resource id.

record_digits_max

string

is_simple_transfer

boolean

Default: False

voice_helper_digits_max

string

match_variable_name

string

caller_id_action

string

context_option

string

silence_time

integer

set_variable_name

string

caller_id_number

string

hangup_cause

string

Default: normal

final

boolean

Default: True

sound

integer

sound_type

string

max_rate

integer

Default: 5

call_interactive_url

string

caller_id_name

string

voice_helper_rules

array [voice_helper_rules]

transfer_timeout

integer

digits

string

name

string

record_digits_variable

string

play_sound_from_variable

boolean

Default: False

interval

integer

record_digits_timeout

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

transcription

string

Required.

to_option

integer

Required.

transfer_variable

string

Variable name for transfer_from_variable.

call_status

string

Call status. One of 'no_answer', 'busy', 'any'.

play_digits_method

string

Playing method to play digits. One of 'pronounced', 'iterated', 'None'.

voice_helper_classic_term

boolean

If true - classic ivr navigation from the keyboard will be enabled after recognition (if none of the matches were received earlier).

caller_id

string

Caller id.

match_variable_value

string

Variable value for variable-based condition.

play_digits_variable

string

Variable name for play_digits_variable.

call_interactive_method

string

Call interactive method. One of 'GET', 'POST', 'None'.

voice_helper_timeout

integer

Timeout in milliseconds before stop listen voice and start recognize.

record_digits_max

integer

Maximum digits amount for record_digits.

is_simple_transfer

boolean

If true - transfer to dst from variable will be simple, default false. Default: False

voice_helper_digits_max

integer

Maximum digits to terminate listen voice and start recognize.

match_variable_name

string

Variable name for variable-based condition.

caller_id_action

string

Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'.

context_option

string

Context option to jump.

silence_time

integer

Silence duration in milliseconds.

set_variable_name

string

Variable name for set_variable.

caller_id_number

string

Caller_id_number.

hangup_cause

string

One of 'normal', 'busy'.

final

boolean

If rule is final, next rules will be not executed if call failed.

sound

integer

Sound to play.

sound_type

string

Sound type. One of 'background', 'foreground', 'None'.

max_rate

integer

call_interactive_url

string

Call interactive url.

caller_id_name

string

Caller_id_name.

voice_helper_rules

array [voice_helper_rules]

List of elements for voice helper rule.

transfer_timeout

integer

Ring to transfer destination this count of seconds.

digits

string

Digits to play.

name

string

Rule name.

record_digits_variable

string

Variable name for record_digits.

play_sound_from_variable

boolean

Check if sound in variable- if so - file from variable will be played instead other sound.

interval

integer

Rule time interval.

record_digits_timeout

integer

Record digits timeout in milliseconds.

transfer_dst

string

Transfer destination.

context

integer

Context to jump.

action

string

Rule action. One of 'transfer', 'hangup', 'play_sound', 'play_silence', 'jump_to_context', 'play_digits', 'call_interactive', 'transfer_from_variable', 'set_variable', 'voicemail', 'simple_transfer', 'set_caller_id_name', 'set_caller_id_number', 'record_digits', 'play_digits_from_variable', 'quality_rate', 'voice_helper', 'start_record'.

set_variable_value

string

Variable value for set_variable.

call_interactive_timeout

integer

Call interactive timout.

record_digits_sound

integer

Id of sound to play record_digits.

transcription

string

Required.

to_option

integer

Required.

transfer_variable

string

call_status

string

Default: any

play_digits_method

string

voice_helper_classic_term

boolean

Default: True

caller_id

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

voice_helper_timeout

integer

id

integer

Resource id.

record_digits_max

string

is_simple_transfer

boolean

Default: False

voice_helper_digits_max

string

match_variable_name

string

caller_id_action

string

context_option

string

silence_time

integer

set_variable_name

string

caller_id_number

string

hangup_cause

string

Default: normal

final

boolean

Default: True

sound

integer

sound_type

string

max_rate

integer

Default: 5

call_interactive_url

string

caller_id_name

string

voice_helper_rules

array [voice_helper_rules]

transfer_timeout

integer

digits

string

name

string

record_digits_variable

string

play_sound_from_variable

boolean

Default: False

interval

integer

record_digits_timeout

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

transcription

string

Required.

to_option

integerRequired.

transfer_variable

string

call_status

string

Default: any

play_digits_method

string

voice_helper_classic_term

boolean

Default: True

caller_id

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

voice_helper_timeout

integer

id

integer

Resource id.

record_digits_max

string

is_simple_transfer

boolean

Default: False

voice_helper_digits_max

string

match_variable_name

string

caller_id_action

string

context_option

string

silence_time

integer

set_variable_name

string

caller_id_number

string

hangup_cause

string

Default: normal

final

boolean

Default: True

sound

integer

sound_type

string

max_rate

integer

Default: 5

call_interactive_url

string

caller_id_name

string

voice_helper_rules

array [voice_helper_rules]

transfer_timeout

integer

digits

string

name

string

record_digits_variable

string

play_sound_from_variable

boolean

Default: False

interval

integer

record_digits_timeout

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

transcription

string

Required.

to_option

integer

Required.

lifetime_exp_action

string

entry_context

integer

contexts

array [context_model]

vm_enabled

boolean

Default: False

vm_greeting

integer

lifetime_exp_transfer_dst

string

vm_profile

string

Default: default

lifetime

integer

vm_attach_file

boolean

Default: True

sleep_time

integer

vm_mailto

string

description

string

inter_digit_timeout

integer

options

array [option_model]

timeout

integer

extra_params

string

allow_any_dial

boolean

id

integer

Resource id.

digit_len

integer

name

stringContext name.

registered

boolean

Default: False

extension_id

integer

registrations

array [registration]

Default: []

device

string

real_address

string

contact_address

string

expires

integer

registration_id

string