Page Comparison

...

Name	Type	Description
`status`	`string`
`domain`	`string`
`dial_rule_limit`	`integer`
`from_public_caller_id_number`	`boolean`	Default: False
`extra_params`	`string`
`name`	`string`
`rfc_public_caller_id_number`	`boolean`	Default: False
`extension_group_id`	`integer`
`public_caller_id_number`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_id`	`integer`
`message_did`	`string`
`create_date`	`string`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

...

`PUT /admin/extension/call_property/{mnemo`}

Update call extension property

Path parameters

Name	Type	Description
`mnemo`	`string`	Required.

JSON parameters

Name	Type	Description
`description`	`string`
`name`	`string`

Resource fields

Name	Type	Description
`description`	`string`
`name`	`string`
`mnemo`	`string`

...

`GET /admin/extension/search/`

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.

Resource fields

Name	Type	Description
`total_count`	`integer`
`result`	`array [extension_search]`

...

`PUT /admin/extension/{extension_id`}

Update extension

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`status`	`string`	One of 'active', 'blocked'.
`dial_rule_limit`	`integer`
`rfc_public_caller_id_number`	`boolean`
`extra_params`	`string`
`public_caller_id_number`	`string`
`label`	`string`
`caller_id_name`	`string`
`from_public_caller_id_number`	`boolean`
`extension_group_id`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`did_as_transfer_caller_id`	`string`	One of 'None', 'default', 'from', 'diversion'.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`dial_rule_limit`	`integer`
`from_public_caller_id_number`	`boolean`	Default: False
`extra_params`	`string`
`name`	`string`
`rfc_public_caller_id_number`	`boolean`	Default: False
`extension_group_id`	`integer`
`public_caller_id_number`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_id`	`integer`
`message_did`	`string`
`create_date`	`string`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

`GET /admin/extension/{extension_id`}

Get extension

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`status`	`string`
`domain`	`string`
`dial_rule_limit`	`integer`
`from_public_caller_id_number`	`boolean`	Default: False
`extra_params`	`string`
`name`	`string`
`rfc_public_caller_id_number`	`boolean`	Default: False
`extension_group_id`	`integer`
`public_caller_id_number`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`
`dial_rule_id`	`integer`
`message_did`	`string`
`create_date`	`string`
`ani_rfc3325`	`boolean`
`type`	`string`
`id`	`integer`	Resource id.
`did_as_transfer_caller_id`	`string`

`DELETE /admin/extension/{extension_id`}

Delete extension

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

...

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

Change ivr configuration

Path parameters

Name	Type	Description
`extension_id`	`integer`	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.
`inband_dtmf`	`boolean`
`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`
`inband_dtmf`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`lifetime`	`integer`
`vm_attach_file`	`boolean`	Default: True
`sleep_time`	`integer`
`vm_mailto`	`string`

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

Get ivr configuration

Path parameters

Name	Type	Description
`extension_id`	`integer`	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`
`inband_dtmf`	`boolean`	Default: False
`vm_profile`	`string`	Default: default
`lifetime`	`integer`
`vm_attach_file`	`boolean`	Default: True
`sleep_time`	`integer`
`vm_mailto`	`string`

...

Change phone configuration

Path parameters

Name	Type	Description
`extension_id`	`integer`	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.
`keep_alive`	`boolean`
`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.
`static_reg_user`	`string`	Static registration user.
`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. `announce_sound_upon_outgoing_call`	`integer`
`vm_attach_file`	`boolean`	Attach voicemail message to notification email.	`intercom`	`integer`
`announce_sound_upon_incoming_call`	`integer`	`announce_sound_upon_outgoing_call`
`integer``intercom`	`integer`
`record_enabled`	`boolean`	Call record enabled.
`transfer_caller_id_number`	`string`	Transfer caller id number.
`ignore_early_media`	`boolean`	Ignore early media.
`static_reg_host`	`string`	Static registration host.
`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.
`call_status_id`	`integer`
`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`
`keep_alive`	`boolean`
`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`
`static_reg_user`	`object`
`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
`announce_sound_upon_outgoing_call`	`integer`
`vm_attach_file`	`boolean`	Default: True`intercom`
`integer`	`announce_sound_upon_incoming_call`	`integer`
`intercom`	`integer`	`announce_sound_upon_outgoing_call`
`integer``record_enabled`	`boolean`	Default: False
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`string`
`call_screening_enabled`	`boolean`	Default: False
`call_status_id`	`integer`
`ringback_sound`	`integer`
`record_format`	`string`
`replace_pin`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

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

Get phone configuration

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`auth_type`	`string`
`vm_enabled`	`boolean`	Default: False
`hold_music`	`integer`
`keep_alive`	`boolean`
`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`
`static_reg_user`	`object`
`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
`announce_sound_upon_outgoing_call`	`integer`
`vm_attach_file`	`boolean`	Default: True	`intercom`	`integer`
`announce_sound_upon_incoming_call`	`integer`
`intercom`	`integer`	`announce_sound_upon_outgoing_call`
`integer``record_enabled`	`boolean`	Default: False
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`string`
`call_screening_enabled`	`boolean`	Default: False
`call_status_id`	`integer`
`ringback_sound`	`integer`
`record_format`	`string`
`replace_pin`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

...

Get extension sip authentication information

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`username`	`string`
`password`	`object`
`realm`	`string`

...

Add extension to force balancing

JSON parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`extension_id`	`integer`

`GET /admin/force_balancing/`

Get force balancing list

Resource fields

Name	Type	Description
`extension_id`	`integer`

...

Get extension force balancing

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`extension_id`	`integer`

...

Delete extension force balancing

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

...

`GET /admin/globals/`

Get global parameters

Resource fields

Name	Type	Description
`value`	`string`
`key`	`string`

...

`POST /admin/interval/`

Add interval

JSON parameters

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

...

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

Get interval list

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.

...

`PUT /admin/interval/{interval_id`}

Update interval

Path parameters

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

...

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

Get interval

Path parameters

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

...

`DELETE /admin/interval/{interval_id`}

Delete interval

Path parameters

Name	Type	Description
`interval_id`	`integer`	Required.

...

Name	Type	Description
`file`	`file`	Required.

Resource fields

Name	Type	Description
`client_name`	`string`
`expiry_date`	`string`
`valid`	`boolean`	Default: False

`GET /admin/license/`

Get current license info

Resource fields

Name	Type	Description
`client_name`	`string`
`expiry_date`	`string`
`valid`	`boolean`	Default: False

...

Add admin network permission group

JSON parameters

Name	Type	Description
`network_address`	`array [string]`	Network_address/mask list.
`name`	`string`	Required.

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.

Resource fields

Name	Type	Description
`total_count`	`integer`
`result`	`array [network_permission]`

...

Update network permission group

Path parameters

Name	Type	Description
`group_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`network_address`	`array [string]`	Network_address/mask list.
`name`	`string`

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

...

Get network permission group

Path parameters

Name	Type	Description
`group_id`	`integer`	Required.

Resource fields

Name	Type	Description
`network_count`	`integer`	Network permission count. Default: 0
`network_address`	`array [string]`	Network addresses list.
`id`	`integer`	Network permission id.
`client_id`	`integer`	Client id.
`name`	`string`	Network permission name.

...

Delete network permission group

Path parameters

Name	Type	Description
`group_id`	`integer`	Required.

...

`POST /admin/notify_extension/`

Notify extensions

JSON parameters

Name	Type	Description
`extension_ids`	`array [integer]`	Extension id for notification.
`need_reboot`	`boolean`	Need to reboot extensions. Default: False

Resource fields

Name	Type	Description
`notify_status`	`string`

...

`GET /admin/rate_limit/`

Get rate limit list

Resource fields

Name	Type	Description
`limit`	`integer`
`id`	`integer`	Resource id.
`name`	`string`

...

`PUT /admin/rate_limit/{limit_id`}

Update rate limit value

Path parameters

Name	Type	Description
`limit_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`limit`	`integer`	Required.

Resource fields

Name	Type	Description
`limit`	`integer`
`id`	`integer`	Resource id.
`name`	`string`

`GET /admin/rate_limit/{limit_id`}

Get rate limit by id

Path parameters

Name	Type	Description
`limit_id`	`integer`	Required.

Resource fields

Name	Type	Description
`limit`	`integer`
`id`	`integer`	Resource id.
`name`	`string`

...

`GET /admin/record/{record_uuid}/full_path/`

Get record storage url

Path parameters

Name	Type	Description
`record_uuid`	`string`	Required.

...

Get count of registered extensions

Resource fields

Name	Type	Description
`registration_count`	`integer`

...

`POST /admin/routing/`

Add routing list

JSON parameters

Name	Type	Description
`routing_rules`	`array [routing_rule]`	Required. Routing rules list.
`name`	`string`	Required. Routing list name.

...

Name	Type	Description
`prefix`	`string`	Required.
`trunk_ids`	`array [trunk_id]`
`description`	`string`

Resource fields

Name	Type	Description
`routing_rules`	`array [routing_rule]`
`id`	`integer`	Resource id.
`name`	`string`

...

`GET /admin/routing/`

Get routing list

Resource fields

Name	Type	Description
`routing_rules`	`array [routing_rule]`
`id`	`integer`	Resource id.
`name`	`string`

...

`PUT /admin/routing/{id`}

Update routing list

Path parameters

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

JSON parameters

Name	Type	Description
`routing_rules`	`array [routing_rule]`	Routing rules list.
`name`	`string`	Routing list name.

...

Name	Type	Description
`prefix`	`string`	Required.
`trunk_ids`	`array [trunk_id]`
`description`	`string`

Resource fields

Name	Type	Description
`routing_rules`	`array [routing_rule]`
`id`	`integer`	Resource id.
`name`	`string`

...

`GET /admin/routing/{id`}

Get routing list by id

Path parameters

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

Resource fields

Name	Type	Description
`routing_rules`	`array [routing_rule]`
`id`	`integer`	Resource id.
`name`	`string`

...

`DELETE /admin/routing/{id`}

Delete routing list

Path parameters

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

...

Name	Type	Description
`title`	`string`	Required. Sound title.
`file`	`file`	Required.

Resource fields

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

...

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`

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.

Resource fields

Name	Type	Description
`total_count`	`integer`

...

`PUT /admin/sound/{sound_id`}

Update sound

Path parameters

Name	Type	Description
`sound_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`title`	`string`	Sound title.

Resource fields

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

`GET /admin/sound/{sound_id`}

Get sound

Path parameters

Name	Type	Description
`sound_id`	`integer`	Required.

Resource fields

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

`DELETE /admin/sound/{sound_id`}

Delete sound

Path parameters

Name	Type	Description
`sound_id`	`integer`	Required.

...

`GET /admin/sound/{sound_id}/download/`

Get sound file

Path parameters

Name	Type	Description
`sound_id`	`integer`	Required.

...

`POST /admin/trunk/`

Add trunk

JSON parameters

Name	Type	Description
`from_domain`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`
`any_extension`	`string`	One of 'yes', 'no'. Default: no
`strip`	`integer`
`any_did`	`string`	One of 'yes', 'no'. Default: no
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`	Required. One of 'in', 'out', 'all'.
`src_address`	`string`
`history_info`	`boolean`	Default: False
`status_in`	`string`	One of 'active', 'blocked'.
`rfc_2543_in`	`string`	One of 'yes', 'no'.
`address`	`string`
`insert_internal_user`	`string`	One of 'yes', 'no'.
`auth_username`	`string`
`name`	`string`	Required.
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`	One of 'active', 'blocked'.

Resource fields

Name	Type	Description
`src_address`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`from_domain`	`string`
`call_interactive_fields`	`string`
`direction`	`string`
`channel_limit`	`integer`	Default: 0
`history_info`	`boolean`	Default: False
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`

...

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

Resource fields

Name	Type	Description
`src_address`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`from_domain`	`string`
`call_interactive_fields`	`string`
`direction`	`string`
`channel_limit`	`integer`	Default: 0
`history_info`	`boolean`	Default: False
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.

Resource fields

Name	Type	Description
`total_count`	`integer`
`result`	`array [trunk_search]`

...

`PUT /admin/trunk/{id`}

Update by id

Path parameters

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

JSON parameters

Name	Type	Description
`from_domain`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`
`any_extension`	`string`	One of 'yes', 'no'. Default: no
`strip`	`integer`
`any_did`	`string`	One of 'yes', 'no'. Default: no
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`	Required. One of 'in', 'out', 'all'.
`src_address`	`string`
`history_info`	`boolean`	Default: False
`status_in`	`string`	One of 'active', 'blocked'.
`rfc_2543_in`	`string`	One of 'yes', 'no'.
`address`	`string`
`insert_internal_user`	`string`	One of 'yes', 'no'.
`auth_username`	`string`
`name`	`string`	Required.
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`	One of 'active', 'blocked'.

Resource fields

Name	Type	Description
`src_address`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`from_domain`	`string`
`call_interactive_fields`	`string`
`direction`	`string`
`channel_limit`	`integer`	Default: 0
`history_info`	`boolean`	Default: False
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`

`GET /admin/trunk/{id`}

Get trunk by id

Path parameters

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

Resource fields

Name	Type	Description
`src_address`	`string`
`backup_errors_regexp`	`string`
`rfc_3325_out_uri`	`string`
`network_permission_group_id`	`integer`
`super_trunk_ip`	`array [string]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`from_domain`	`string`
`call_interactive_fields`	`string`
`direction`	`string`
`channel_limit`	`integer`	Default: 0
`history_info`	`boolean`	Default: False
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`in_anumber_rule_id`	`integer`
`out_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`use_dns_srv`	`boolean`	Default: False
`status_out`	`string`

`DELETE /admin/trunk/{id`}

Delete trunk

Path parameters

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

...

`POST /admin/user/admin/`

Add admin user

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`
`extra_params`	`string`
`timezone`	`string`
`login`	`string`
`id`	`integer`	Resource id.

...

Name	Type	Description
`id`	`array [integer]`
`login`	`array [string]`

Resource fields

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

...

`PUT /admin/user/admin/{user_id`}

Update admin user

Path parameters

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

`GET /admin/user/admin/{user_id`}

Get admin user

Path parameters

Name	Type	Description
`user_id`	`integer`	Required.

Resource fields

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

`DELETE /admin/user/admin/{user_id`}

Delete admin user

Path parameters

Name	Type	Description
`user_id`	`integer`	Required.

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`login`	`array [string]`
`sha256pass`	`array [string]`
`admin`	`boolean`
`status`	`string`	One of 'active', 'blocked'.
`access`	`string`	One of 'full', 'read_only'.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`dealer_id`	`integer`	Id of dealer resource.
`name`	`string`
`admin`	`boolean`	User is admin. Default: False
`extra_params`	`string`
`id`	`integer`	Resource id.
`access`	`string`
`extension_id`	`integer`	Id of extension resource.
`client_id`	`integer`	Id of client resource.
`extension_group_id`	`integer`	Id of extension_group resource.
`timezone`	`string`
`login`	`string`
`email`	`string`

...

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.
`admin`	`boolean`
`status`	`string`	One of 'active', 'blocked'.
`access`	`string`	One of 'full', 'read_only'.

Resource fields

Name	Type	Description
`total_count`	`integer`
`result`	`array [user_search]`

...

`PUT /admin/users/{user_id`}

Update user

Path parameters

Name	Type	Description
`user_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`	User email.
`status`	`string`	User status. One of 'active', 'blocked'.
`name`	`string`	User name.
`access`	`string`	User access type. One of 'full', 'read_only'.
`extra_params`	`string`	User extra params.
`timezone`	`string`	User timezone.
`password`	`string`	User password.
`email`	`string`	User email.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`dealer_id`	`integer`	Id of dealer resource.
`name`	`string`
`admin`	`boolean`	User is admin. Default: False
`extra_params`	`string`
`id`	`integer`	Resource id.
`access`	`string`
`extension_id`	`integer`	Id of extension resource.
`client_id`	`integer`	Id of client resource.
`extension_group_id`	`integer`	Id of extension_group resource.
`timezone`	`string`
`login`	`string`
`email`	`string`

`GET /admin/users/{user_id`}

Get user

Path parameters

Name	Type	Description
`user_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`status`	`string`
`dealer_id`	`integer`	Id of dealer resource.
`name`	`string`
`admin`	`boolean`	User is admin. Default: False
`extra_params`	`string`
`id`	`integer`	Resource id.
`access`	`string`
`extension_id`	`integer`	Id of extension resource.
`client_id`	`integer`	Id of client resource.
`extension_group_id`	`integer`	Id of extension_group resource.
`timezone`	`string`
`login`	`string`
`email`	`string`

`DELETE /admin/users/{user_id`}

Delete user

Path parameters

Name	Type	Description
`user_id`	`integer`	Required.

...

Update access list elements by user_id

Path parameters

Name	Type	Description
`user_id`	`string`	Required.

JSON parameters

Name	Type	Description
`network_address`	`array [string]`	Network_address/mask list.
`description`	`array [string]`	Network_address/mask list.

Resource fields

Name	Type	Description
`user_id`	`integer`
`network_address`	`string`
`description`	`string`
`id`	`integer`	Resource id.

...

Get access list by user_id

Path parameters

Name	Type	Description
`user_id`	`string`	Required.

Resource fields

Name	Type	Description
`user_id`	`integer`
`network_address`	`string`
`description`	`string`
`id`	`integer`	Resource id.

...

Get voicemail storage url

Path parameters

Name	Type	Description
`record_uuid`	`string`	Required.

...

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

PUT /admin/extension/call_property/{mnemo}

Path parameters

JSON parameters

Resource fields

GET /admin/extension/search/

Resource fields

PUT /admin/extension/{extension_id}

Path parameters

JSON parameters

Resource fields

GET /admin/extension/{extension_id}

Path parameters

Resource fields

DELETE /admin/extension/{extension_id}

Path parameters

PUT /admin/extension/{extension_id}/ivr/

Path parameters

JSON parameters

Resource fields

GET /admin/extension/{extension_id}/ivr/

Path parameters

Resource fields

Path parameters

JSON parameters

Resource fields

GET /admin/extension/{extension_id}/phone/

Path parameters

Resource fields

Path parameters

Resource fields

JSON parameters

Resource fields

GET /admin/force_balancing/

Resource fields

Path parameters

Resource fields

Path parameters

GET /admin/globals/

Resource fields

POST /admin/interval/

JSON parameters

Resource fields

GET /admin/interval/

Resource fields

PUT /admin/interval/{interval_id}

Path parameters

JSON parameters

Resource fields

GET /admin/interval/{interval_id}

Path parameters

Resource fields

DELETE /admin/interval/{interval_id}

Path parameters

Resource fields

GET /admin/license/

Resource fields

JSON parameters

Resource fields

Resource fields

Resource fields

Path parameters

JSON parameters

Resource fields

Path parameters

Resource fields

Path parameters

POST /admin/notify_extension/

JSON parameters

Resource fields

GET /admin/rate_limit/

Resource fields

PUT /admin/rate_limit/{limit_id}

Path parameters

JSON parameters

Resource fields

`PUT /admin/extension/call_property/{mnemo`}

`GET /admin/extension/search/`

`PUT /admin/extension/{extension_id`}

`GET /admin/extension/{extension_id`}

`DELETE /admin/extension/{extension_id`}

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

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

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

`GET /admin/force_balancing/`

`GET /admin/globals/`

`POST /admin/interval/`

`GET /admin/interval/`

`PUT /admin/interval/{interval_id`}

`GET /admin/interval/{interval_id`}

`DELETE /admin/interval/{interval_id`}

`GET /admin/license/`

`POST /admin/notify_extension/`

`GET /admin/rate_limit/`

`PUT /admin/rate_limit/{limit_id`}

`GET /admin/rate_limit/{limit_id`}

`GET /admin/record/{record_uuid}/full_path/`

`POST /admin/routing/`

`GET /admin/routing/`

`PUT /admin/routing/{id`}

`GET /admin/routing/{id`}

`DELETE /admin/routing/{id`}

`PUT /admin/sound/{sound_id`}

`GET /admin/sound/{sound_id`}

`DELETE /admin/sound/{sound_id`}

`GET /admin/sound/{sound_id}/download/`

`POST /admin/trunk/`

`PUT /admin/trunk/{id`}

`GET /admin/trunk/{id`}

`DELETE /admin/trunk/{id`}

`POST /admin/user/admin/`

`PUT /admin/user/admin/{user_id`}

`GET /admin/user/admin/{user_id`}

`DELETE /admin/user/admin/{user_id`}

`PUT /admin/users/{user_id`}

`GET /admin/users/{user_id`}