Page Comparison

...

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_sound_upon_incoming_call``integer``caller_name`	`boolean`	Default: False
`label`	`string`
`vm_greeting`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`intercom`	`integer`
`conferenceannounce_sound_announceupon_callerincoming_name`	`boolean`	Default: False`call`	`integer`
`announce_sound_upon_outgoing_call`	`integer`
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`bundle_id`	`integer`
`static_reg_address`	`string`
`geo_list`	`string`
`bundle_list`	`array [integer]`
`call_screening_enabled`	`boolean`	Default: False
`ringback_sound`	`integer`
`record_format`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

...

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_sound_upon_incoming_call``integer``caller_name`	`boolean`	Default: False
`label`	`string`
`vm_greeting`	`integer`
`record_enabled`	`boolean`	Default: False
`vm_attach_file`	`boolean`	Default: True
`intercom`	`integer`
`conferenceannounce_sound_announceupon_callerincoming_name`	`boolean`	Default: False`call`	`integer`
`announce_sound_upon_outgoing_call`	`integer`
`transfer_caller_id_number`	`string`
`ignore_early_media`	`boolean`	Default: False
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`bundle_id`	`integer`
`static_reg_address`	`string`
`geo_list`	`string`
`bundle_list`	`array [integer]`
`call_screening_enabled`	`boolean`	Default: False
`ringback_sound`	`integer`
`record_format`	`string`
`record_transfer`	`boolean`	Default: False
`external_number`	`string`

...

Name	Type	Description
`extension_id`	`integer`	Required.

...

`GET /admin/globals/`

Get global parameters

Resource fields

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

`GET /admin/helpers/resource_fields/{resource_name`}

Get admin helper

Path parameters

Name	Type	Description
`resource_name`	`string`	Required.

Resource fields

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

`GET /admin/helpers/resources`

Get admin helper

Query parameters

Name	Type	Description
`name`	`array [string]`	Required.

Resource fields

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

`PUT /admin/helpers/{resource_name`}

Put admin helper

Path parameters

Name	Type	Description
`resource_name`	`string`	Required.

JSON parameters

...

Name

...

Type

...

Description

...

resource_description

...

string

...

field_name

...

string

...

field_description

...

`/globals/`

Get global parameters

Resource fields

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

...

Get admin network permission group list

Query parameters

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

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.

...

Network permission search

Query parameters

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

Resource fields

Name	Type	Description
`total_count`	`integer`
`result`	`array [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.

...

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

...

`GET /admin/restapi_logs/`

Get restapi logs

Query parameters

Name	Type	Description
`start_datetime`	`string`	Required.
`method`	`array [string]`
`end_datetime`	`string`	Required.
`client_id`	`array [integer]`
`per_page`	`integer`
`page`	`integer`	Default: 1
`resource_type`	`array [string]`
`extension_id`	`array [integer]`

Resource fields

Name	Type	Description
`application_id`	`string`
`description`	`string`
`url`	`string`
`response_code`	`string`
`id`	`integer`	Resource id.
`method`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`dt`	`string`
`ip_address`	`string`
`auth_id`	`integer`
`resource_type`	`string`

...

`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.
`description`	`string`
`trunk_ids`	`array [trunk_id]`
`integer``description`	Required. `string`

Resource fields

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

...

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

`GET /admin/routing/`

Get routing list

Resource fields

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

...

Name	Type	Description
`prefix`	`string`	Required.
`description`	`string`
`trunk_ids`	`array [trunk_id]`
`integer``description`	Required. `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.
`description`	`string`
`trunk_ids`	`array [trunk_id]`
`integer``description`	Required. `string`

Resource fields

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

...

Name	Type	Description
`prefix`	`string`	Required.
`description`	`string`
`trunk_ids`	`array [trunk_id]`
`integer``description`	Required. `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`

...

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

`DELETE /admin/routing/{id`}

Delete routing list

Path parameters

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

...

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

Resource fields

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

`GET /admin/sound/`

Get sound list

Query parameters

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

Resource fields

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

...

`GET /admin/sound/search/`

Common sounds search

Query parameters

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

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`
`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.
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`status_out`	`string`	One of 'active', 'blocked'.

Resource fields

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]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`
`src_address`	`string`
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id``integer``_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`status_out`	`string`

`GET /admin/trunk/`

Get trunk list

Query parameters

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

Resource fields

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]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`
`src_address`	`string`
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`status_out`	`string`

...

`GET /admin/trunk/search/`

Trunk search

Query parameters

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

Resource fields

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

...

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]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`
`src_address`	`string`
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`status_out`	`string`

...

`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`
`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.
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`status_out`	`string`	One of 'active', 'blocked'.

Resource fields

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]`	Default: []
`any_extension`	`string`
`strip`	`integer`
`any_did`	`string`
`id`	`integer`	Resource id.
`pri_prefix`	`string`
`from_username`	`string`
`auth_pass`	`string`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`
`src_address`	`string`
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`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
`from_domain`	`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`
`channel_limit`	`integer`	Default: 0
`call_interactive_fields`	`string`
`direction`	`string`
`src_address`	`string`
`status_in`	`string`
`rfc_2543_in`	`string`
`address`	`string`
`insert_internal_user`	`string`
`auth_username`	`string`
`name`	`string`
`out_anumber_rule_id`	`integer`
`in_anumber_rule_id`	`integer`
`non_backup_errors_regexp`	`string`
`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.

`GET /admin/user/admin/`

Get admin user list

Query parameters

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

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.

...

`GET /admin/users/`

Get user list

Query parameters

Name	Type	Description
`admin`	`boolean`
`id`	`array [integer]`
`sha256pass`	`array [string]`
`per_page`	`integer`
`login`	`array [string]`
`page`	`integer`	Default: 1

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

User search

Query parameters

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

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.

...

`PUT /admin/{client_id}/phone_event/{id`}

Update client event

Path parameters

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

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', '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 /admin/{client_id}/phone_event/{id`}

Get client event

Path parameters

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

Resource fields

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

`DELETE /admin/{client_id}/phone_event/{id`}

Delete client event

Path parameters

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

...

`POST /admin/{client_id}/phone_events/`

Add client phone event

Path parameters

Name	Type	Description
`client_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', '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 /admin/{client_id}/phone_events/`

Get client event list

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

Resource fields

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

`DELETE /admin/{client_id}/phone_events/`

Delete all client events

Path parameters

Name	Type	Description
`client_id`	`string`	Required.

...

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

GET /admin/globals/

Resource fields

GET /admin/helpers/resource_fields/{resource_name}

Path parameters

Resource fields

GET /admin/helpers/resources

Query parameters

Resource fields

PUT /admin/helpers/{resource_name}

Path parameters

JSON parameters

/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

Query parameters

Resource fields

Query parameters

Resource fields

Path parameters

JSON parameters

Resource fields

Path parameters

Resource fields

Path parameters

GET /admin/rate_limit/

Resource fields

PUT /admin/rate_limit/{limit_id}

Path parameters

JSON parameters

Resource fields

GET /admin/rate_limit/{limit_id}

Path parameters

Resource fields

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

Path parameters

Resource fields

GET /admin/restapi_logs/

Query parameters

Resource fields

POST /admin/routing/

JSON parameters

Resource fields

GET /admin/routing/

Resource fields

PUT /admin/routing/{id}

Path parameters

JSON parameters

Resource fields

GET /admin/routing/{id}

Path parameters

Resource fields

DELETE /admin/routing/{id}

Path parameters

Resource fields

GET /admin/sound/

Query parameters

Resource fields

`GET /admin/globals/`

`GET /admin/helpers/resource_fields/{resource_name`}

`GET /admin/helpers/resources`

`PUT /admin/helpers/{resource_name`}

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

`GET /admin/rate_limit/`

`PUT /admin/rate_limit/{limit_id`}

`GET /admin/rate_limit/{limit_id`}

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

`GET /admin/restapi_logs/`

`POST /admin/routing/`

`GET /admin/routing/`

`PUT /admin/routing/{id`}

`GET /admin/routing/{id`}

`DELETE /admin/routing/{id`}

`GET /admin/sound/`

`GET /admin/sound/search/`

`PUT /admin/sound/{sound_id`}

`GET /admin/sound/{sound_id`}

`DELETE /admin/sound/{sound_id`}

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

`POST /admin/trunk/`

`GET /admin/trunk/`

`GET /admin/trunk/search/`

`PUT /admin/trunk/{id`}

`GET /admin/trunk/{id`}

`DELETE /admin/trunk/{id`}

`POST /admin/user/admin/`

`GET /admin/user/admin/`

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

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

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

`GET /admin/users/`

`GET /admin/users/search/`

`PUT /admin/users/{user_id`}

`GET /admin/users/{user_id`}

`DELETE /admin/users/{user_id`}

`PUT /admin/{client_id}/phone_event/{id`}