Page Comparison

Table of Contents

maxLevel	3

`GET /extension/registration/`

Get extension registration status

Query parameters

Name	Type	Description
`extension_id`	`array [integer]`	Extension id, multiple possible.

Resource fields

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

Resource registration

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

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

Add new agent

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'. Default: available
`agent_sound_id`	`integer`
`name`	`string`	Required. Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again. Default: 10
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again. Default: 10
`call_timeout`	`integer`	Agent call timeout.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one. Default: 0
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount. Default: 10
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/agent/`

Get agents list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`PUT /extension/{extension_id}/agent/{agent_id`}

Update agent

Path parameters

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

JSON parameters

Name	Type	Description
`status`	`string`	Agent status. One of 'logged_out', 'available'.
`agent_sound_id`	`integer`
`name`	`string`	Agent name.
`busy_delay_time`	`integer`	If the agent is on do not disturb, we wait this defined time before trying him again.
`no_answer_delay_time`	`integer`	If the agent does not answer the call, we wait this defined time before trying him again.
`call_timeout`	`integer`	Agent call timeout.
`wrap_up_time`	`integer`	Allow an agent to have a delay when finishing a call before receiving another one.
`reject_delay_time`	`integer`	If the agent press the reject on their phone, we wait this defined time amount.
`extra_params`	`string`

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/agent/{agent_id`}

Get agent by id

Path parameters

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

Resource fields

Name	Type	Description
`status`	`object`
`agent_sound_id`	`integer`
`name`	`string`
`busy_delay_time`	`integer`
`no_answer_delay_time`	`integer`
`call_timeout`	`integer`	Default: 60
`wrap_up_time`	`integer`
`extension_id`	`integer`
`reject_delay_time`	`integer`
`extra_params`	`string`
`id`	`integer`	Resource id.

`DELETE /extension/{extension_id}/agent/{agent_id`}

Delete agent

Path parameters

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

Query parameters

Name	Type	Description
`remove_from_queues`	`boolean`	Default: True

`GET /extension/{extension_id}/alias/`

Get alias list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`name`	`array [string]`
`domain`	`array [string]`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`create_date`	`string`
`name`	`string`
`extension_id`	`integer`
`id`	`integer`	Resource id.

`PUT /extension/{extension_id}/ani/`

Update extension ani

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`ani_number`	`string`	Required. Ani .

Resource fields

Name	Type	Description
`default`	`string`

`GET /extension/{extension_id}/ani/`

Get extension ani

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`default`	`string`

`POST /extension/{extension_id}/callback/`

Create callback

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`allow_public_transfer`	`boolean`	Restrict or permit transfer of a phone call made to a phone number external to the system. Default: False
`transfer_after_dst_hangup`	`string`	Will transfer src on number if other side hang up.
`src_num`	`array [string]`	Required. Source call number.
`callback_rate_limit`	`integer`	Rate limits for callback to prevent all calls consist of callback.
`call_duration`	`integer`	Total duration of the call, in seconds.
`src_caller_id_number`	`string`	Source caller id.
`transfer_after_src_hangup`	`string`	Will transfer dst on number if other side hang up.
`wait_for_pickup`	`integer`	The maximum number of seconds to wait until one of the phone numbers used picks up.
`caller_id_name`	`string`	Caller name.
`dst_num`	`string`	Required. Destination call number.
`dst_ani`	`string`	Dst number identification on trunks.
`src_caller_id_name`	`string`	Source caller name.
`caller_id_number`	`string`	Caller id.
`announce_sound_id`	`integer`	Announce sound id, the sound that will hear src after answer.
`dst_announce_sound_id`	`integer`	Announce sound id. the sound that will hear dst and src after dst answer.
`src_ani`	`string`	Src number identification on trunks.
`dst_dtmf`	`string`	Dtmf digtis to send to destination .

Resource fields

Name	Type	Description
`call_api_id`	`string`
`call_id`	`string`

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

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

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`
`enter_sound`	`integer`
`record_enabled`	`boolean`
`mute_non_moderator`	`boolean`

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

Name	Type	Description
`extension_id`	`string`	Required.

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

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

Manage conference

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`mute`	`boolean`
`stop_play`	`boolean`
`lock`	`boolean`
`deaf`	`boolean`
`enter_sound`	`boolean`
`member_id`	`integer`
`play_file`	`integer`

`GET /extension/{extension_id}/conference/status/`

Get conference status

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`action`	`string`	Required. One of 'show_members', 'is_locked', 'max_members', 'count', 'run_time'.

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

Update call

Path parameters

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

JSON parameters

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`

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

Get active call for extension type phone by call_api_id

Path parameters

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

Resource fields

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`

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

Delete call

Path parameters

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

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

Add extension event

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`url`	`string`	Required. Request url.
`event_type`	`string`	Required. Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', '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

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

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

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

Delete all extension events

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

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

Update extension event

Path parameters

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

JSON parameters

Name	Type	Description
`url`	`string`	Request url.
`event_type`	`string`	Call event type. One of 'dial-in', 'dial-out', 'hangup', 'answer', 'message-in', 'message-out', '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.

`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
`url`	`string`
`method`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

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

Delete extension event

Path parameters

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

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

Get extension

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`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`
`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
`fax_in_format`	`string`
`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 fax config

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

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/in/{fax_uuid`}

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`	`string`	Required.

Form parameters

Name	Type	Description
`dst_num`	`string`	Required. Destination number.
`file`	`file`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`dst_num`	`string`	Destination number.
`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
`action`	`string`	Required. One of 'cancel', 'retry'.

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
`call_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', 'any'. Default: any
`transfer_timeout`	`integer`	Ring to transfer destination this count of seconds. Default: 60
`playfile_sound`	`integer`	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`	Rule name.

Resource cascade_number

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

Get extension incoming call rules list

Path parameters

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

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

Resource cascade_number

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/{rule_id`}

Get extension incoming call rule by id

Path parameters

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

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

Delete interval

Path parameters

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

`PUT /extension/{extension_id}/ivr/`

Change ivr configuration

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`lifetime_exp_action`	`string`	Action after lifetime expires. One of 'hangup', 'transfer'.
`entry_context`	`integer`	Context with starts when ivr called.
`lifetime_exp_transfer_dst`	`string`	Transfer destination while lifetime expires.
`vm_enabled`	`boolean`	Voicemail enabled.
`vm_greeting`	`integer`	Voicemail greeting sound id.
`vm_profile`	`string`	Voicemail configuration. One of 'default', 'record_silence'.
`lifetime`	`integer`	Ivr call lifetime in seconds.
`vm_attach_file`	`boolean`	Attach voicemail message to notification email.
`sleep_time`	`integer`	Milliseconds before entry context starts.
`vm_mailto`	`string`	Email address for voicemail notifications.

Resource fields

Name	Type	Description
`lifetime_exp_action`	`string`
`entry_context`	`integer`
`lifetime_exp_transfer_dst`	`string`
`vm_enabled`	`boolean`	Default: False
`vm_greeting`	`integer`
`vm_profile`	`string`	Default: default
`lifetime`	`integer`
`vm_attach_file`	`boolean`	Default: True
`sleep_time`	`integer`
`vm_mailto`	`string`

`GET /extension/{extension_id}/ivr/`

Get ivr configuration

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`lifetime_exp_action`	`string`
`entry_context`	`integer`
`lifetime_exp_transfer_dst`	`string`
`vm_enabled`	`boolean`	Default: False
`vm_greeting`	`integer`
`vm_profile`	`string`	Default: default
`lifetime`	`integer`
`vm_attach_file`	`boolean`	Default: True
`sleep_time`	`integer`
`vm_mailto`	`string`

`POST /extension/{extension_id}/ivr/context/`

Add ivr context

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`name`	`string`	Required. Context name.
`inter_digit_timeout`	`integer`	Number of milliseconds to wait for a selection. Default: 2000
`timeout`	`integer`	Number of milliseconds to wait conform entered digits. Default: 5000
`extra_params`	`string`
`allow_any_dial`	`boolean`	Allow dial any extension. Default: False
`digit_len`	`integer`	Maximum number of digits to collect before searching for a matching menu entry.
`description`	`string`

Resource fields

Name	Type	Description
`description`	`string`
`inter_digit_timeout`	`integer`
`timeout`	`integer`
`extra_params`	`string`
`allow_any_dial`	`boolean`
`id`	`integer`	Resource id.
`digit_len`	`integer`
`name`	`string`	Context name.

`GET /extension/{extension_id}/ivr/context/`

Get ivr context list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`description`	`string`
`inter_digit_timeout`	`integer`
`timeout`	`integer`
`extra_params`	`string`
`allow_any_dial`	`boolean`
`id`	`integer`	Resource id.
`digit_len`	`integer`
`name`	`string`	Context name.

`PUT /extension/{extension_id}/ivr/context/{context_id`}

Update ivr context

Path parameters

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

JSON parameters

Name	Type	Description
`name`	`string`	Context name.
`inter_digit_timeout`	`integer`	Number of milliseconds to wait conform entered digits.
`timeout`	`integer`	Number of milliseconds to wait for a selection.
`extra_params`	`string`
`allow_any_dial`	`boolean`	Allow dial any extension.
`digit_len`	`integer`	Maximum number of digits to collect before searching for a matching menu entry.
`description`	`string`

Resource fields

Name	Type	Description
`description`	`string`
`inter_digit_timeout`	`integer`
`timeout`	`integer`
`extra_params`	`string`
`allow_any_dial`	`boolean`
`id`	`integer`	Resource id.
`digit_len`	`integer`
`name`	`string`	Context name.

`GET /extension/{extension_id}/ivr/context/{context_id`}

Get ivr context

Path parameters

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

Resource fields

Name	Type	Description
`description`	`string`
`inter_digit_timeout`	`integer`
`timeout`	`integer`
`extra_params`	`string`
`allow_any_dial`	`boolean`
`id`	`integer`	Resource id.
`digit_len`	`integer`
`name`	`string`	Context name.

`DELETE /extension/{extension_id}/ivr/context/{context_id`}

Delete ivr context

Path parameters

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

`POST /extension/{extension_id}/ivr/context/{context_id}/options/`

Add context option

Path parameters

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

JSON parameters

Name	Type	Description
`digits`	`string`	Required.

Resource fields

Name	Type	Description
`digits`	`string`

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

Get context options list

Path parameters

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

Resource fields

Name	Type	Description
`digits`	`string`

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

Delete context option

Path parameters

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

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

Add context rule

Path parameters

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

JSON parameters

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

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

Get context rules list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`context_id`	`integer`	Required.
`option_digits`	`string`	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`
`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/`

Udpate context option rules order

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`context_id`	`integer`	Required.
`option_digits`	`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}/ivr/context/{context_id}/options/{option_digits}/rules/order/`

Get context option rules order

Path parameters

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

Resource fields

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

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

Update context rule

Path parameters

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

JSON parameters

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.
`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`
`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/{rule_id`}

Get context rule

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.
`context_id`	`integer`	Required.
`option_digits`	`string`	Required.
`rule_id`	`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`
`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`}

Delete context rule

Path parameters

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

`GET /extension/{extension_id}/ivr/scheme/`

Get full ivr scheme

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

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

Add extension notification

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`mail`	`string`	Required. Email for notification.
`event_type`	`string`	Required. Notification type. One of 'call_failed_mail'.

Resource fields

Name	Type	Description
`mail`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/mail_notification/`

Get extension notification list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`mail`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`PUT /extension/{extension_id}/mail_notification/{id`}

Update extension notification

Path parameters

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

JSON parameters

Name	Type	Description
`mail`	`string`	Email for notification.
`event_type`	`string`	Notification type. One of 'call_failed_mail'.

Resource fields

Name	Type	Description
`mail`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/mail_notification/{id`}

Get extension notification

Path parameters

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

Resource fields

Name	Type	Description
`mail`	`string`
`event_type`	`string`
`id`	`integer`	Resource id.

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

Delete extension notification

Path parameters

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

`PUT /extension/{extension_id}/phone/`

Change phone configuration

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`auth_type`	`string`	One of 'digest', 'network', 'both'. Default: digest
`vm_enabled`	`boolean`	Voicemail enabled.
`hold_music`	`integer`	Music on hold sound id.
`preserve_caller_id_number_att_tr`	`boolean`	Preserve original caller id number on attended transfer.
`conference_pin`	`string`
`conference_end_on_exit`	`boolean`
`network_permission_group_id`	`integer`
`append_to_cid_name_on_transfer`	`string`	Append to cid name on transfer.
`record_stereo`	`string`	One of 'yes', 'no', 'None'.
`hangup_timeout`	`integer`	Timeout in seconds before hangup if extension does not answer.
`incoming_limit`	`integer`
`vm_mailto`	`string`	Email address for voicemail notifications.
`conference_announce_caller_name`	`boolean`
`vm_greeting`	`integer`	Voicemail greeting sound id.
`record_enabled`	`boolean`	Call record enabled.
`vm_attach_file`	`boolean`	Attach voicemail message to notification email.
`intercom`	`integer`
`announce_sound_upon_incoming_call`	`integer`
`announce_sound_upon_outgoing_call`	`integer`
`transfer_caller_id_number`	`string`	Transfer caller id number.
`ignore_early_media`	`boolean`	Ignore early media.
`vm_profile`	`string`	Voicemail configuration. One of 'default', 'record_silence'.
`static_reg_address`	`string`	Static registration address:port.
`password`	`string`
`geo_list`	`string`
`call_screening_enabled`	`boolean`	Call screening enabled.
`ringback_sound`	`integer`	Ringback sound id.
`record_format`	`string`	One of 'mp3', 'wav', 'None'.
`replace_pin`	`string`
`record_transfer`	`boolean`
`external_number`	`string`

Resource fields

Name	Type	Description
`auth_type`	`string`
`vm_enabled`	`boolean`	Default: False
`hold_music`	`integer`
`preserve_caller_id_number_att_tr`	`boolean`	Default: False
`conference_pin`	`string`
`conference_end_on_exit`	`boolean`	Default: True
`network_permission_group_id`	`integer`
`append_to_cid_name_on_transfer`	`string`
`record_stereo`	`string`
`hangup_timeout`	`integer`	Default: 60
`incoming_limit`	`integer`
`vm_mailto`	`string`
`conference_announce_caller_name`	`boolean`	Default: False
`label`	`string`
`vm_greeting`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`intercom`	`integer`
`announce_sound_upon_incoming_call`	`integer`
`announce_sound_upon_outgoing_call`	`integer`
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`string`
`name`	`string`
`call_screening_enabled`	`boolean`	Default: False
`ringback_sound`	`integer`
`record_format`	`string`
`replace_pin`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

`GET /extension/{extension_id}/phone/`

Get phone configuration

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`auth_type`	`string`
`vm_enabled`	`boolean`	Default: False
`hold_music`	`integer`
`preserve_caller_id_number_att_tr`	`boolean`	Default: False
`conference_pin`	`string`
`conference_end_on_exit`	`boolean`	Default: True
`network_permission_group_id`	`integer`
`append_to_cid_name_on_transfer`	`string`
`record_stereo`	`string`
`hangup_timeout`	`integer`	Default: 60
`incoming_limit`	`integer`
`vm_mailto`	`string`
`conference_announce_caller_name`	`boolean`	Default: False
`label`	`string`
`vm_greeting`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`intercom`	`integer`
`announce_sound_upon_incoming_call`	`integer`
`announce_sound_upon_outgoing_call`	`integer`
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`string`
`name`	`string`
`call_screening_enabled`	`boolean`	Default: False
`ringback_sound`	`integer`
`record_format`	`string`
`replace_pin`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

`PUT /extension/{extension_id}/queue/`

Update queue by extension id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`announce_sound`	`integer`	Announce sound id.
`no_agent_timeout_transfer_dst_sound`	`integer`	Sound id. plays before transfer to destination if no no agents available.
`start_sound`	`integer`	Start sound id.
`exit_key`	`string`	Key for exit from queue.
`append_to_cid_name_on_transfer`	`string`
`agent_announce_sound`	`integer`	Agent announce sound id.
`position_announce_frequency`	`integer`	Queue member position announce frequency.
`agent_hangup_action`	`string`	One of 'None', 'transfer', 'quality_rate'.
`skip_busy_agents`	`boolean`	Do not try to call busy agents.
`vm_mailto`	`string`	Email address for voicemail notifications.
`no_agent_timeout_transfer_dst`	`string`	Transfer destination on no agent timeout.
`agent_report_wait_time`	`boolean`	Report how long caller was in a queue.
`vm_enabled`	`boolean`	Voicemail enabled.
`quality_rate_sound`	`integer`
`strategy`	`string`	Queue call strategy. One of 'ring-all', 'longest-idle-agent', 'round-robin', 'top-down', 'agent-with-least-talk-time', 'agent-with-fewest-calls', 'sequentially-by-agent-order', 'random'. Default: round-robin
`try_same_agent_time`	`integer`	Try to connect caller to the same agent if connected in last try_same_agent_time seconds.
`record_enabled`	`boolean`	Queue calls recording enabled.
`vm_attach_file`	`boolean`	Attach voicemail message to notification email.
`tier_rule_wait_multiply_level`	`boolean`	If false, then once tier_rule_wait_second is passed, the caller is offered to all tiers in order (level/position). if true, the tier_rule_wait_second will be multiplied by the tier level.
`sound_type`	`string`	Sound type. One of 'ring', 'music'. Default: ring
`timeout_transfer_dst_sound`	`integer`	Sound id. plays before transfer to destination if timeout.
`tier_rules_apply`	`boolean`	Defines if we should apply tier rules.
`disable_answer`	`boolean`	Disable answer in queue.
`vm_profile`	`string`	Voicemail configuration. One of 'default', 'record_silence'.
`vm_greeting`	`integer`	Voicemail greeting sound id.
`quality_rate_finish_sound`	`integer`
`announce_frequency`	`integer`	Announce_sound will play at intervals defined in this parameter (in seconds).
`exit_transfer_dst`	`string`	Transfer destination on exit.
`tier_rule_wait_second`	`integer`	The time in seconds that a caller is required to wait before advancing to the next tier.
`sound`	`integer`	Queue main sound id.
`exit_with_no_av_agents`	`boolean`	Do not put call into the queue if there is no agents available.
`exit_transfer_dst_sound`	`integer`	Sound id. plays before transfer to destination on caller exit.
`quality_rate_max`	`integer`
`timeout_transfer_dst`	`string`	Transfer destination on timeout.
`max_wait_time`	`integer`	Define the delay before we quit queue if the member haven't been answered by an agent.
`agent_hangup_transfer_dst`	`string`	Transfer on agent hangup destination.
`max_wait_time_with_no_agent`	`integer`	Maximum time in seconds with no agents in queue before exit.

Resource fields

Name	Type	Description
`announce_sound`	`integer`
`no_agent_timeout_transfer_dst_sound`	`integer`
`start_sound`	`integer`
`exit_key`	`string`
`append_to_cid_name_on_transfer`	`string`
`agent_announce_sound`	`integer`
`position_announce_frequency`	`integer`
`agent_hangup_action`	`string`
`skip_busy_agents`	`boolean`	Default: False
`vm_mailto`	`string`
`no_agent_timeout_transfer_dst`	`string`
`agent_report_wait_time`	`boolean`	Default: False
`vm_enabled`	`boolean`	Default: False
`quality_rate_sound`	`integer`
`strategy`	`string`
`try_same_agent_time`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`tier_rule_wait_multiply_level`	`boolean`	Default: False
`sound_type`	`string`	Default: music
`timeout_transfer_dst_sound`	`integer`
`tier_rules_apply`	`boolean`	Default: False
`disable_answer`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`vm_greeting`	`integer`
`quality_rate_finish_sound`	`integer`
`announce_frequency`	`integer`
`exit_transfer_dst`	`string`
`tier_rule_wait_second`	`integer`	Default: 0
`sound`	`integer`
`exit_with_no_av_agents`	`boolean`	Default: False
`exit_transfer_dst_sound`	`integer`
`quality_rate_max`	`integer`
`timeout_transfer_dst`	`string`
`max_wait_time`	`integer`
`agent_hangup_transfer_dst`	`string`
`max_wait_time_with_no_agent`	`integer`

`GET /extension/{extension_id}/queue/`

Get queue by extension id

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`announce_sound`	`integer`
`no_agent_timeout_transfer_dst_sound`	`integer`
`start_sound`	`integer`
`exit_key`	`string`
`append_to_cid_name_on_transfer`	`string`
`agent_announce_sound`	`integer`
`position_announce_frequency`	`integer`
`agent_hangup_action`	`string`
`skip_busy_agents`	`boolean`	Default: False
`vm_mailto`	`string`
`no_agent_timeout_transfer_dst`	`string`
`agent_report_wait_time`	`boolean`	Default: False
`vm_enabled`	`boolean`	Default: False
`quality_rate_sound`	`integer`
`strategy`	`string`
`try_same_agent_time`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`tier_rule_wait_multiply_level`	`boolean`	Default: False
`sound_type`	`string`	Default: music
`timeout_transfer_dst_sound`	`integer`
`tier_rules_apply`	`boolean`	Default: False
`disable_answer`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`vm_greeting`	`integer`
`quality_rate_finish_sound`	`integer`
`announce_frequency`	`integer`
`exit_transfer_dst`	`string`
`tier_rule_wait_second`	`integer`	Default: 0
`sound`	`integer`
`exit_with_no_av_agents`	`boolean`	Default: False
`exit_transfer_dst_sound`	`integer`
`quality_rate_max`	`integer`
`timeout_transfer_dst`	`string`
`max_wait_time`	`integer`
`agent_hangup_transfer_dst`	`string`
`max_wait_time_with_no_agent`	`integer`

`POST /extension/{extension_id}/queue/agents/local/`

Add agent to queue

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`position`	`integer`	Agent position. Default: 0
`agent_id`	`integer`	Required. Agent id.
`level`	`integer`	Agent level. Default: 0

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent extension id.
`level`	`integer`	Default: 1

`GET /extension/{extension_id}/queue/agents/local/`

Get queue agents

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent extension id.
`level`	`integer`	Default: 1

`PUT /extension/{extension_id}/queue/agents/local/{agent_id`}

Update agent in queue details

Path parameters

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

JSON parameters

Name	Type	Description
`position`	`integer`	Agent position.
`level`	`integer`	Agent level.

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent extension id.
`level`	`integer`	Default: 1

`GET /extension/{extension_id}/queue/agents/local/{agent_id`}

Get agent in queue details

Path parameters

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

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent extension id.
`level`	`integer`	Default: 1

`DELETE /extension/{extension_id}/queue/agents/local/{agent_id`}

Delete agent from queue

Path parameters

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

`POST /extension/{extension_id}/queue/agents/remote/`

Add queue to agent

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

JSON parameters

Name	Type	Description
`position`	`integer`	Agent position. Default: 0
`agent_id`	`integer`	Required. Agent id.
`level`	`integer`	Agent level. Default: 0

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent id.
`level`	`integer`	Default: 1

`GET /extension/{extension_id}/queue/agents/remote/`

Get queue agents

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent id.
`level`	`integer`	Default: 1

`PUT /extension/{extension_id}/queue/agents/remote/{agent_id`}

Update agent in queue details

Path parameters

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

JSON parameters

Name	Type	Description
`position`	`integer`	Agent position.
`level`	`integer`	Agent level.

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent id.
`level`	`integer`	Default: 1

`GET /extension/{extension_id}/queue/agents/remote/{agent_id`}

Get agent in queue details

Path parameters

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

Resource fields

Name	Type	Description
`position`	`integer`	Default: 1
`agent_id`	`integer`	Agent id.
`level`	`integer`	Default: 1

`DELETE /extension/{extension_id}/queue/agents/remote/{agent_id`}

Delete agent from queue

Path parameters

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

`GET /extension/{extension_id}/queue/status/`

Get queue status

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`answered_members`	`integer`	Default: 0
`waiting_members`	`integer`	Default: 0
`trying_members`	`integer`	Default: 0

`GET /extension/{extension_id}/queue/status/agents/`

Get queue agents status

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`name_fs`	`string`
`name`	`string`
`extension_name`	`string`
`call_duration`	`integer`
`state`	`string`

`GET /extension/{extension_id}/queue/status/members/`

Get queue members status

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

Name	Type	Description
`state`	`string`
`number`	`string`
`wait_time`	`integer`
`joined_datetime`	`string`
`call_api_id`	`string`
`serving_agent`	`string`

`GET /extension/{extension_id}/record/`

Get record list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

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

Resource fields

Name	Type	Description
`to_username`	`string`
`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}/record/stats/`

Get record statistics list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required. Start datetime.
`end_datetime`	`string`	Required. End datetime.

Resource fields

Name	Type	Description
`files_size`	`integer`
`records_count`	`integer`

`GET /extension/{extension_id}/record/{record_uuid`}

Get record

Path parameters

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

`GET /extension/{extension_id}/record/{record_uuid}/download/`

Get record with basic http authentication

Path parameters

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

`GET /extension/{extension_id}/record/{record_uuid}/storage_url/`

Get record storage url

Path parameters

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

`GET /extension/{extension_id}/registration/`

Get extension registration status

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Resource fields

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

Resource registration

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

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

Delete all extension registrations

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

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

Delete registration

Path parameters

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

`GET /extension/{extension_id}/sound/`

Get sound list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`title`	`array [string]`

Resource fields

Name	Type	Description
`title`	`string`
`dealer_id`	`integer`
`id`	`integer`	Resource id.
`client_id`	`integer`
`filename`	`string`

`GET /extension/{extension_id}/sound/{sound_id}/download/`

Get sound file

Path parameters

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

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

Update call with speech to text

Path parameters

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

JSON parameters

Name	Type	Description
`action`	`string`	Required. One of 'start', 'stop'.
`url`	`string`	Url to get events with recognized text.
`direction`	`string`	Required. One of 'in', 'out'.

`POST /extension/{extension_id}/user/extension/`

Add new user extension

Path parameters

Name	Type	Description
`extension_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`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/user/extension/`

Get user extension list

Path parameters

Name	Type	Description
`extension_id`	`string`	Required.

Query parameters

Name	Type	Description
`id`	`array [integer]`
`login`	`array [string]`
`name`	`array [string]`
`email`	`array [string]`
`comment`	`array [string]`
`status`	`array [string]`
`timezone`	`array [string]`
`access`	`array [string]`

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`PUT /extension/{extension_id}/user/extension/{user_id`}

Update user extension

Path parameters

Name	Type	Description
`extension_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`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`GET /extension/{extension_id}/user/extension/{user_id`}

Get user extension

Path parameters

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

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`name`	`string`
`email`	`string`
`access`	`string`
`extension_id`	`integer`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

`DELETE /extension/{extension_id}/user/extension/{user_id`}

Delete user extension

Path parameters

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

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

Update call with valet_parking

Path parameters

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

JSON parameters

Name	Type	Description
`action`	`string`	Required. One of 'park', 'bridge', 'slots'.
`slot`	`integer`

`GET /extension/{extension_id}/voicemail/{record_uuid`}

Get voicemail message file

Path parameters

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

`GET /extension/{extension_id}/voicemail/{record_uuid}/storage_url/`

Get voicemail storage url

Path parameters

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

Page Comparison

Versions Compared

Old Version 107

New Version Current

Key

GET /extension/registration/

Query parameters

Resource fields

Resource registration

POST /extension/{extension_id}/agent/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/agent/

Path parameters

Resource fields

PUT /extension/{extension_id}/agent/{agent_id}

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/agent/{agent_id}

Path parameters

Resource fields

DELETE /extension/{extension_id}/agent/{agent_id}

Path parameters

Query parameters

GET /extension/{extension_id}/alias/

Path parameters

Query parameters

Resource fields

PUT /extension/{extension_id}/ani/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/ani/

Path parameters

Resource fields

POST /extension/{extension_id}/callback/

Path parameters

JSON parameters

Resource fields

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

Path parameters

JSON parameters

Resource fields

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

Path parameters

PUT /extension/{extension_id}/conference/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/conference/

Path parameters

Resource fields

PUT /extension/{extension_id}/conference/status/

Path parameters

JSON parameters

GET /extension/{extension_id}/conference/status/

Path parameters

Query parameters

GET /extension/{extension_id}/current_calls/

Path parameters

Resource fields

Resource call_mdl

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

Path parameters

JSON parameters

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/

Path parameters

JSON parameters

Resource fields

GET /extension/{extension_id}/event/

Path parameters

Resource fields

DELETE /extension/{extension_id}/event/

`GET /extension/registration/`

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

`GET /extension/{extension_id}/agent/`

`PUT /extension/{extension_id}/agent/{agent_id`}

`GET /extension/{extension_id}/agent/{agent_id`}

`DELETE /extension/{extension_id}/agent/{agent_id`}

`GET /extension/{extension_id}/alias/`

`PUT /extension/{extension_id}/ani/`

`GET /extension/{extension_id}/ani/`

`POST /extension/{extension_id}/callback/`

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

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

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

`GET /extension/{extension_id}/conference/`

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

`GET /extension/{extension_id}/conference/status/`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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