Page Comparison

...

Name	Type	Description
`registered`	`boolean`	Default: False
`extension_id`	`integer`	Extension id, multiple possible.
`registrations`	`array [registration]`	Default: []

Resource registration

Name	Type	Description
`device`	`object`
`real_address`	`string`
`contact_address`	`object`
`expires`	`integer`
`registration_id`	`string`

...

`POST /extension/{extension_id}/agent/`

...

Name	Type	Description
`per_page`	`integer`	Items per page.
`order`	`string`	Datetime sorting order.
`cdr`	`array [cdr_response]`
`page`	`integer`	Result page.

`GET /extension/{extension_id}/cdr/stats/`

Get calls statistics

Path parameters

Resource cdr_response

Name	Type	Description
`extensionto_idusername`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required.
`end_datetime`	`string`	Required.

`PUT /extension/{extension_id}/chat/{chat_id}/messages/`

Change chat messages

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`chat_id`	`string`	Required.

JSON parameters

Name	Type	Description
`read`	`boolean`

Resource fields

Name	Type	Description
`read`	`boolean`
`id`	`string`	Resource id.

`GET /extension/{extension_id}/chat/{chat_id}/messages/`

Get chat messages list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`chat_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Start datetime.
`src_num`	`string`
`page`	`integer`	Default: 1
`dst_num`	`string`
`end_datetime`	`string`	End datetime.
`per_page`	`integer`
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name	Type	Description
`status`	`string`
`init_time_gmt`	`string`
`src_num`	`string`
`read`	`boolean`
`text`	`string`
`flow`	`string`
`dst_num`	`string`
`chat_id`	`string`
`id`	`string`	Resource id.
`extension_id`	`integer`

...

`source_number`	`string`
`result`	`string`
`duration`	`integer`
`hangup_time_gmt`	`string`
`to_domain`	`string`
`record_file_size`	`integer`
`calls_result`	`string`
`from_username`	`string`
`calls_hangup_disposition`	`string`
`ani_number`	`string`
`application`	`string`
`start_time_gmt`	`string`
`ext_number_reg`	`string`
`hangup_cause`	`string`
`hangup_disposition`	`string`
`extension_group_owner_id`	`integer`
`init_time_gmt`	`string`
`source_domain`	`string`
`dest_domain`	`string`
`record_uuid`	`string`
`from_domain`	`string`
`call_uuid`	`string`
`extension_type`	`string`
`did_domain`	`string`
`from_screen_name`	`string`
`extension_name`	`string`
`flow`	`string`
`dest_number`	`string`
`extension_id`	`integer`
`did_number`	`string`
`client_owner_id`	`integer`

...

`GET /extension/{extension_id}/cdr/stats/`

Get calls statistics

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required.
`end_datetime`	`string`	Required.

...

`PUT /extension/{extension_id}/chat/{chat_id}/messages/`

Delete all Change chat messages

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`chat_id`	`string`	Required.

...

JSON parameters

Name	Type	Description
`read`	`boolean`

Resource fields

Name	Type	Description
`read`	`boolean`
`id`	`string`	Resource id.

`GET /extension/{extension_id}/chat/{chat_id}/`

...

`messages/`

Update conference configurationGet chat messages list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

...

chat_id

string

Required.

Query parameters

Name	Type	Description
`moderatorstart_pindatetime`	`string``pin`	Start datetime.
`src_num`	`string`
`max_members``page`	`integer`	Default: 1
`music_on_hold_sound`	`integer`
`announce_caller_name`	`boolean`
`enter_sound`	`integer`
`record_enabled`	`boolean`
`mute_non_moderator`	`boolean``dst_num`	`string`
`end_datetime`	`string`	End datetime.
`per_page`	`integer`
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc

Resource fields

Name	Type	Description
`moderator_pin``status`	`string`
`init_time_gmt`	`string`
`src_num`	`string`
`read`	`boolean`
`text`	`string`
`pin``flow`	`string`
`maxdst_membersnum`	`integer``string`
`music_on_hold_sound`	`integer`
`announce_caller_name`	`boolean`	Default: False
`enter_sound`	`integer`
`record_enabled`	`boolean`	Default: False
`mute_non_moderator`	`boolean`	Default: False

...

`chat_id`	`string`
`id`	`string`	Resource id.
`extension_id`	`integer`

`DELETE /extension/{extension_id}/chat/{chat_id}/messages/`

Delete all chat messages

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`chat_id`	`string`	Required.

...

`PUT /extension/{extension_id}/conference/`

Get Update conference configuration

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

...

JSON parameters

Name	Type	Description
`moderator_pin`	`string`
`pin`	`string`
`max_members`	`integer`
`music_on_hold_sound`	`integer`
`announce_caller_name`	`boolean`	Default: False
`enter_sound`	`integer`
`record_enabled`	`boolean`	Default: False
`mute_non_moderator`	`boolean`	Default: False

`GET /extension/{extension_id}/current_calls/`

Get active calls for extension type phone

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`call_list`	`array [call_mdl]`

...

Resource fields

Name	Type	Description
`moderator_pin`	`string`
`pin`	`string`
`max_members`	`integer`
`music_on_hold_sound`	`integer`
`announce_caller_name`	`boolean`	Default: False
`enter_sound`	`integer`
`record_enabled`	`boolean`	Default: False
`mute_non_moderator`	`boolean`	Default: False

`GET /extension/{extension_id}/`

...

`conference/`

Get conference configuration

Path parameters

string

Name	Type	Description	`call_api_id`
Required.	`extension_id`	`string`	Required.

...

Resource fields

Name	Type	Description
`action`	`string`	Required. One of 'eavesdrop', 'whisper', 'conference', 'transfer', 'attended_transfer', 'hold', 'offhold', 'park', 'pickup'.
`caller_id_name`	`string`
`send_dst`	`string`
`caller_id_number`	`string``moderator_pin`	`string`
`pin`	`string`
`max_members`	`integer`
`music_on_hold_sound`	`integer`
`announce_caller_name`	`boolean`	Default: False
`enter_sound`	`integer`
`record_enabled`	`boolean`	Default: False
`mute_non_moderator`	`boolean`	Default: False

...

`GET /extension/{extension_id}/current_calls/`

...

Get active call calls for extension type phone by call_api_id

Path parameters

Name	Type	Description
`call_apiextension_id`	`string`	Required.
`extension_id`	`string`	Required.

...

Resource fields

Name	Type	Description
`call_list`	`array [call_mdl]`

Resource call_mdl

Name	Type	Description
`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`

...

`PUT /extension/{extension_id}/current_calls/{call_api_id`}

Delete Update call

Path parameters

Name	Type	Description
`call_api_id`	`string`	Required.
`extension_id`	`string`	Required.

`POST /extension/{extension_id}/event/`

Add extension event

Path parameters

...

Name

JSON parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Required. Request url.
`event_type`	`action`	`string`	Required. Call event type. One of 'dial-ineavesdrop', 'dial-outwhisper', 'hangupconference', 'answertransfer', 'message-inattended_transfer', 'message-outhold', 'message-out-statusoffhold', '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.

park', 'pickup'.
`caller_id_name`	`string`
`send_dst`	`string`
`caller_id_number`	`string`

`GET /extension/{extension_id}/`

...

`current_calls/{call_api_id`}

Get extension event listactive call for extension type phone by call_api_id

Path parameters

Name	Type	Description
`call_api_id`	`string`	Required.
`extension_id`	`string`	Required.

Resource fields

Resource id.

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`
`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`

`DELETE /extension/{extension_id}/`

...

`current_calls/{call_api_id`}

Delete call

Path parameters

Name	Type	Description
`call_api_id`	`string`	Required.
`extension_id`	`string`	Required.

...

`POST /extension/{extension_id}/event/`

...

Update Add extension event

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

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', 'message-out-status', '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 /extension/{extension_id}/event/`

...

Get extension event list

Path parameters

Required.

Name	Type	Description
`extension_id`	`string`	Required.	`id`	`integer`

Resource

...

fields

Name	Type	Description
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`DELETE /extension/{extension_id}/event/`

...

Delete all extension eventevents

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`id`	`integer`	Required. Resource id.

...

`PUT /extension/{extension_id}/`

...

`event/{id`}

Get Update extension event

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

...

id

integer

Required. Resource id.

JSON parameters

Name	Type	Description
`status``url`	`string``domain`	Request url.
`event_type`	`string`
`dial_rule_limit`	`integer`
`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_id`	`integer`
`message_did`	`string`
`create_date`	`string`
`ani_rfc3325`	`boolean`
Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', 'message-out-status', '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.
`did_as_transfer_caller_id`	`string`

...

`GET /extension/{extension_id}/`

...

`event/`

...

`{id`}

Get extension event

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

...

id

integer

Required. Resource id.

Resource fields

Name	Type	Description
`fax_in_format``url`	`string`
`fax_mailto``method`	`string`
`faxevent_out_greetingtype`	`integer`
`email_to_fax_accept`	`array [string]`

Resource fields

Name	`string`
`id`	`integer`	Resource id.

`DELETE /extension/{extension_id}/event/{id`}

Delete extension event

Path parameters

Name	Type	Description
`faxextension_in_formatid`	`string`	Default: tiff
`fax_mailto`	`string`
`fax_out_greeting`	`integer`
`email_to_fax_accept`	`array [string]`
Required.
`id`	`integer`	Required. Resource id.

...

`GET /extension/{extension_id}/`

...

`extension/`

Get fax configextension

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`fax_in_format``status`	`string`	Default: tiff
`fax_mailto``domain`	`string`
`faxdial_outrule_greetinglimit`	`integer`
`email_to_fax_accept`	`array [string]`

`GET /extension/{extension_id}/fax/in/`

Get incoming fax messages list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Start datetime.
`uuid`	`array [string]`	Fax uuid.
`destination`	`array [string]`	Destination number.
`caller_id`	`array [string]`	Caller id number.
`end_datetime`	`string`	End datetime.
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc

...

`name`	`string`
`extra_params`	`string`
`extension_group_id`	`integer`
`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`

...

`PUT /extension/{extension_id}/fax/`

Update fax config

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`uuid``fax_in_format`	`string`	Fax uuid.
`destination`	`string`	Destination number.
`caller_id`	`string`	Caller id.
`datetime`	`string`	Record datetime.
`file_size`	`integer`	Fax file size.
`extension_id`	`integer`	Extension id.
`client_id`	`integer`	Client id.
`extension_group_id`	`integer`	Extension group id. `fax_mailto`	`string`
`fax_out_greeting`	`integer`
`email_to_fax_accept`	`array [string]`

Resource fields

Name	Type	Description
`fax_in_format`	`string`	Default: tiff
`fax_mailto`	`string`
`fax_out_greeting`	`integer`
`email_to_fax_accept`	`array [string]`

`GET /extension/{extension_id}/fax`

...

`/`

...

Get incoming fax messageconfig

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`fax_in_format`	`string`	Default: tiff
`fax_uuidmailto`	`string`	Required.

...


`fax_out_greeting`	`integer`
`email_to_fax_accept`	`array [string]`

...

`GET /extension/{extension_id}/fax/`

...

`in/`

Send Get incoming fax messagemessages list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

...

Query parameters

Name	Type	Description
`dststart_numdatetime`	`string`	RequiredStart datetime. Destination number.
`file`	`file`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`dst_num`	`string``uuid`	`array [string]`	Fax uuid.
`destination`	`array [string]`	Destination number.
`caller_id`	`integer`	Resource id.
`datetime`	`string`

`GET /extension/{extension_id}/fax/out/`

Get fax messages list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
start`array [string]`	Caller id number.
`end_datetime`	`string`	Start End datetime.
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc	`end_datetime`	`string`	End datetime.

Resource fields

Name	Type	Description
`status``uuid`	`string``dst_num`	Fax uuid.
`destination`	`string`	Destination number.
`caller_id`	`integer``string`	Resource Caller id.
`datetime`	`string`

...

Record datetime.
`file_size`	`integer`	Fax file size.
`extension_id`	`integer`	Extension id.
`client_id`	`integer`	Client id.
`extension_group_id`	`integer`	Extension group id.

...

`GET /extension/{extension_id}/fax/`

...

`in/{`

...

`fax_`

...

`uuid`}

Change Get incoming fax message

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`fax_uuid`	`string`	Required.

...

`POST /extension/{extension_id}/fax/out/`

Send fax message

Path parameters

Name	Type	Description
`extension_id`	`integer``string`	Required.

...

Form parameters

Name	Type	Description
`action``dst_num`	`string`	Required. One of 'cancel', 'retry'. Destination number.
`file`	`file`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`dst_num`	`string`	Destination number.
`id`	`integer`	Resource id.
`datetime`	`string`

`GET /extension/{extension_id}/fax/out/`

...

Get fax messagemessages list

Path parameters

Required

Name	Type	Description
`extension_id`	`string`	Required.	`message_id`	`integer`

Query parameters

Name	Type	Description
`start_datetime`	`string`	Start datetime.
`order`	`string`	Datetime sorting order. One of 'desc', 'asc'. Default: desc
`end_datetime`	`string`	End datetime.

Resource fields

Name	Type	Description
`status`	`string`
`dst_num`	`string`
`id`	`integer`	Resource id.
`datetime`	`string`

...

`PUT /extension/{extension_id}/`

...

`fax/out/{message_id`}

Change fax message

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`message_id`	`integer`	Required.

...

Query parameters

Name	Type	Description
`allow_public_transfer`	`boolean`	Allow public called destinations to transfer calls. Default: False
`extension_call_status`	`string`	Extension call status`action`	`string`	Required. One of 'no_answercancel', 'busy', 'any'. Default: anycall_retry'.

Resource fields

Name	Type	Description
`status`	`string`	Call status. One of 'no_answer', 'busy', 'any'. Default: any
`transfer_dst`	`string`	Transfer destination for transfer rule. multiple destinations divided by space.
`enable_call_screening`	`boolean`	Enable call screening for transfer call. Default: False
`enabled`	`boolean`	Rule is active. Default: True
`interval`	`integer`	Time interval id.
`caller_id_action`	`string`	Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. Default: 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. Default: True
`extension_status`	`string`	Extension status. One of 'registered', 'unreachable`dst_num`	`string`
`id`	`integer`	Resource id.
`datetime`	`string`

`GET /extension/{extension_id}/fax/out/{message_id`}

Get fax message

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`message_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`dst_num`	`string`
`id`	`integer`	Resource id.
`datetime`	`string`

...

`POST /extension/{extension_id}/incom_rule/`

Add extension incoming call rule

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`allow_public_transfer`	`boolean`	Allow public called destinations to transfer calls. Default: False
`extension_call_status`	`string`	Extension call status. One of 'no_answer', 'busy', 'any'. Default: any
`transfercall_timeoutstatus`	`integer`	Ring to transfer destination this count of seconds`string`	Call status. One of 'no_answer', 'busy', 'any'. Default: 60any
`playfiletransfer_sounddst`	`integer``string`	Sound id Transfer destination for playfile transfer rule.
`cascade_numbers`	`array [cascade_number]`	List of elements for cascade rule.
`type`	`string`	Required. 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. Default: True
`name`	`string`	Rule name.

Resource fields

Name	Type	Description
`allow_public_transfer`	`boolean`	Default: False
`extension_call_status`	`string`	One of 'no_answer', 'busymultiple destinations divided by space.
`enable_call_screening`	`boolean`	Enable call screening for transfer call. Default: False
`enabled`	`boolean`	Rule is active. Default: True
`interval`	`integer`	Time interval id.
`caller_id_action`	`string`	Caller id matching method. One of 'matches', 'not_matches', 'anonymous', 'any'. Default: 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. Default: True
`extension_status`	`string`	Extension status. One of 'registered', 'unreachable', 'any'. Default: any
`calltransfer_statustimeout`	`string`	One of 'no_answer', 'busy', 'any'`integer`	Ring to transfer destination this count of seconds. Default: any60
`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`	Sound id for playfile rule.
`cascade_numbers`	`array [cascade_number]`	List of elements for cascade rule.
`type`	`string`	Required. 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. Default: True
`name`	`string`

`GET /extension/{extension_id}/incom_rule/`

Get extension incoming call rules list

Path parameters

Rule name.

Resource cascade_number

extension_id

Name	Type	Description
`delay`	`integer`	Required.
`number`	`string`	Required.

Resource fields

Name	Type	Description
`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`

...

Resource cascade_number

Name	Type	Description
`delay`	`integer`	Required.
`number`	`string`	Required.

`GET /extension/{extension_id}/incom_rule`

...

`/`

Update current rules orderGet extension incoming call rules list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`rules_ids`	`array [integer]`	Required. All rules ids in needed order.

Resource fields

Name	Type	Description
`rulesallow_public_ids``array [integer]``transfer`	`boolean`	Default: []False

...

extension

...

Get current rules order

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`rules_ids`	`array [integer]`	Default: []

`PUT /extension/{extension_id}/incom_rule/{rule_id`}

Update extension incoming call rule by id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`rule_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`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.

...

`_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`

Resource cascade_number

Name	Type	Description
`delay`	`integer`	Required.
`number`	`string`	Required.

...

`PUT /extension/{extension_id}/incom_rule/order/`

Update current rules order

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`rules_ids`	`array [integer]`	Required. All rules ids in needed order.

Resource fields

Name	Type	Description
`rules_ids`	`array [integer]`	Default: []

`GET /extension/{extension_id}/incom_rule/order/`

Get current rules order

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`rules_ids`	`array [integer]`	Default: []

...

`PUT /extension/{extension_id}/incom_rule/{rule_id`}

Update extension incoming call rule by id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`rule_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`allow_public_transfer`	`boolean`Default: False	Allow public called destinations to transfer calls.
`extension_call_status`	`string`	Extension call status. One of 'no_answer', 'busy', 'any'. Default: any
`call_status`	`string`	Call status. One of 'no_answer', 'busy', 'any'. Default: any
`playfiletransfer_sound``integer``dst`	`string`	Transfer destination for transfer rule. multiple destinations divided by space.
`enable_call_screening`	`boolean`Default: False	Enable call screening for transfer call.
`enabled`	`boolean`Default: True	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	`integer`	Resource 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'. Default: any
`transfer_timeout`	`integer`
`ignore_early_media`	`boolean`	Default: False
`transfer_dst`	`string`
	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`Default: True	If rule is final, next rules will be not executed if call failed.
`name`	`string`

`GET /extension/{extension_id}/incom_rule/{rule_id`}

Get extension incoming call rule by id

Path parameters

Rule name.

Resource cascade_number

Name	Type	Description
`extension_id``delay`	`string``integer`	Required.
`rule_id``number`	`integer``string`	Required.

Resource fields

Name	Type	Description
`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`

...

Resource cascade_number

Name	Type	Description
`delay`	`integer`	Required.
`number`	`string`	Required.

`GET /extension/{extension_id}/incom_rule/{rule_id`}

Delete Get extension incoming call rule by id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`rule_id`	`integer`	Required.

`POST /extension/{extension_id}/interval/`

Add interval

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`timezone`	`string`	Required. Interval timezone.
`conditions`	`array [condition]`	Required. Datetime conditions.
`name`	`string`	Required. Interval name.	`string`	Required.
`rule_id`	`integer`	Required.

Resource fields

Name	Type	Description
`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`

Resource cascade_number

Name	Type	Description
`delay`	`integer`	Required.
`number`	`string`	Required.

`DELETE /extension/{extension_id}/incom_rule/{rule_id`}

Delete extension incoming call rule by id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`rule_id`	`integer`	Required.

...

`POST /extension/{extension_id}/interval/`

Add interval

Path parameters

Name	Type	Description
`extension_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 /extension/{extension_id}/interval/`

Get interval list

Path parameters

Name	Type	Description
`extension_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 /extension/{extension_id}/interval/{interval_id`}

Update interval

Path parameters

Name	Type	Description
`extension_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.

`GET /extension/{extension_id}/interval/`

Get interval list

Path parameters

Resource interval_condition

Name	Type	Description
`extension_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.

...


`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 /extension/{extension_id}/interval/{interval_id`}

Update Get interval

Path parameters

Name	Type	Description
`extension_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 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.

`GET /extension/{extension_id}/interval/{interval_id`}

Get interval

Path parameters

Name	Type	Description
`extension_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 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 /extension/{extension_id}/interval/{interval_id`}

...

Name	Type	Description
`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.
`voice_helper_final_count`	`integer`	Number of times to wait for final words recognitions.
`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.
`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`_interactive_timeout`	`integer`	Call interactive timout.
`record_digits_sound`	`integer`	Id of sound to play record_digits.

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

Resource fields

Name	Type	Description
`transfer_variable`	`string`
`call_status`	`string`	Default: any
`play_digits_method`	`string`
`voice_helper_classic_term`	`boolean`	Default: True
`caller_id`	`string`
`voice_helper_final_count`	`integer`
`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`

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

`GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/`

...

Name	Type	Description
`transfer_variable`	`string`
`call_status`	`string`	Default: any
`play_digits_method`	`string`
`voice_helper_classic_term`	`boolean`	Default: True
`caller_id`	`string`
`voice_helper_final_count`	`integer`
`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`

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

...

`PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/`

...

Name	Type	Description
`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.
`voice_helper_final_count`	`integer`	Number of times to wait for final words recognitions.
`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.

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

Resource fields

Name	Type	Description
`transfer_variable`	`string`
`call_status`	`string`	Default: any
`play_digits_method`	`string`
`voice_helper_classic_term`	`boolean`	Default: True
`caller_id`	`string`
`voice_helper_final_count`	`integer`
`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_sound`	`integer`

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

`GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id`}

...

Name	Type	Description
`transfer_variable`	`string`
`call_status`	`string`	Default: any
`play_digits_method`	`string`
`voice_helper_classic_term`	`boolean`	Default: True
`caller_id`	`string`
`voice_helper_final_count`	`integer`
`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`

Resource voice_helper_rules

Name	Type	Description
`transcription`	`string`	Required.
`to_option`	`integer`	Required.

`DELETE /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id`}

...

Name	Type	Description
`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`

Resource context_model

Name	Type	Description
`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`	`string`	Context name.

...

`POST /extension/{extension_id}/mail_notification/`

...

Name	Type	Description
`registered`	`boolean`	Default: False
`extension_id`	`integer`
`registrations`	`array [registration]`	Default: []

Resource registration

Name	Type	Description
`device`	`object`
`real_address`	`string`
`contact_address`	`object`
`expires`	`integer`
`registration_id`	`string`

`DELETE /extension/{extension_id}/registration/`

...

Page Comparison

Versions Compared

Old Version 104

New Version 105

Key

Resource registration

POST /extension/{extension_id}/agent/

GET /extension/{extension_id}/cdr/stats/

Path parameters

Resource cdr_response

Query parameters

PUT /extension/{extension_id}/chat/{chat_id}/messages/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/chat/{chat_id}/messages/

Path parameters

Query parameters

Resource fields

GET /extension/{extension_id}/cdr/stats/

Path parameters

Query parameters

PUT /extension/{extension_id}/chat/{chat_id}/messages/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/chat/{chat_id}/

messages/

Path parameters

Query parameters

Resource fields

DELETE /extension/{extension_id}/chat/{chat_id}/messages/

Path parameters

PUT /extension/{extension_id}/conference/

Path parameters

JSON parameters

GET /extension/{extension_id}/current_calls/

Path parameters

Resource fields

Resource fields

GET /extension/{extension_id}/

conference/

Path parameters

Resource fields

GET /extension/{extension_id}/current_calls/

Get active call calls for extension type phone by call_api_id

Path parameters

Resource fields

Resource call_mdl

PUT /extension/{extension_id}/current_calls/{call_api_id}

Path parameters

POST /extension/{extension_id}/event/

Path parameters

JSON parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/

current_calls/{call_api_id}

Path parameters

Resource fields

DELETE /extension/{extension_id}/

current_calls/{call_api_id}

Path parameters

POST /extension/{extension_id}/event/

Update Add extension event

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/event/

Get extension event list

Path parameters

Resource

fields

DELETE /extension/{extension_id}/event/

Delete all extension eventevents

Path parameters

PUT /extension/{extension_id}/

event/{id}

Path parameters

JSON parameters

`POST /extension/{extension_id}/agent/`

`GET /extension/{extension_id}/cdr/stats/`

`PUT /extension/{extension_id}/chat/{chat_id}/messages/`

`GET /extension/{extension_id}/chat/{chat_id}/messages/`

`GET /extension/{extension_id}/cdr/stats/`

`PUT /extension/{extension_id}/chat/{chat_id}/messages/`

`GET /extension/{extension_id}/chat/{chat_id}/`

`messages/`

`DELETE /extension/{extension_id}/chat/{chat_id}/messages/`

`PUT /extension/{extension_id}/conference/`

`GET /extension/{extension_id}/current_calls/`

`GET /extension/{extension_id}/`

`conference/`

`GET /extension/{extension_id}/current_calls/`

`PUT /extension/{extension_id}/current_calls/{call_api_id`}

`POST /extension/{extension_id}/event/`

`GET /extension/{extension_id}/`

`current_calls/{call_api_id`}

`DELETE /extension/{extension_id}/`

`current_calls/{call_api_id`}

`POST /extension/{extension_id}/event/`

`GET /extension/{extension_id}/event/`

`DELETE /extension/{extension_id}/event/`

`PUT /extension/{extension_id}/`

`event/{id`}

`GET /extension/{extension_id}/`

`event/`

`{id`}

`DELETE /extension/{extension_id}/event/{id`}

`GET /extension/{extension_id}/`

`extension/`

`GET /extension/{extension_id}/fax/in/`

`PUT /extension/{extension_id}/fax/`

`GET /extension/{extension_id}/fax`

`/`

`GET /extension/{extension_id}/fax/`

`in/`

`GET /extension/{extension_id}/fax/out/`

`GET /extension/{extension_id}/fax/`

`in/{`

`fax_`

`uuid`}

`POST /extension/{extension_id}/fax/out/`

`GET /extension/{extension_id}/fax/out/`

`PUT /extension/{extension_id}/`

`fax/out/{message_id`}

`GET /extension/{extension_id}/fax/out/{message_id`}

`POST /extension/{extension_id}/incom_rule/`

`GET /extension/{extension_id}/incom_rule/`

`GET /extension/{extension_id}/incom_rule`

`/`