Admin

`PUT /admin/admin_global_access_list/`

Update access list

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
`network_address`	`string`
`description`	`string`
`id`	`integer`	Resource id.

`GET /admin/admin_global_access_list/`

Get access list

Resource fields

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

`POST /admin/alias/`

Add alias

JSON parameters

Name	Type	Description
`comment`	`string`
`domain`	`string`
`dealer_id`	`integer`
`name`	`string`	Required.
`extension_id`	`integer`
`client_id`	`integer`
`address`	`string`	Required.

Resource fields

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

`GET /admin/alias/`

Get alias list

Query parameters

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

Resource fields

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

`GET /admin/alias/search/`

Alias search

Query parameters

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

Resource fields

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

Resource alias

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

`PUT /admin/alias/{alias_id`}

Update alias

Path parameters

Name	Type	Description
`alias_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`domain`	`string`
`dealer_id`	`integer`
`name`	`string`
`extension_id`	`integer`
`client_id`	`integer`
`address`	`string`

Resource fields

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

`GET /admin/alias/{alias_id`}

Get alias

Path parameters

Name	Type	Description
`alias_id`	`integer`	Required.

Resource fields

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

`DELETE /admin/alias/{alias_id`}

Delete alias

Path parameters

Name	Type	Description
`alias_id`	`integer`	Required.

`POST /admin/application/`

Add application

JSON parameters

Name	Type	Description
`redirect_uris`	`string`
`disable_confirmation`	`boolean`	Default: False
`name`	`string`	Required.
`disable_rate_limit`	`boolean`	Default: False
`password_restore_redirect_url`	`string`
`access`	`string`	One of 'call_api', 'all'. Default: call_api
`user_id`	`integer`
`type`	`string`	One of 'public', 'trusted', 'password_credentials'. Default: public

Resource fields

Name	Type	Description
`user_id`	`integer`
`redirect_uris`	`string`
`disable_confirmation`	`boolean`
`name`	`string`
`disable_rate_limit`	`boolean`
`password_restore_redirect_url`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`create_date`	`string`
`type`	`string`
`id`	`string`	Resource id.

`GET /admin/application/`

Get applications list with filter by id

Query parameters

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

Resource fields

Name	Type	Description
`user_id`	`integer`
`redirect_uris`	`string`
`disable_confirmation`	`boolean`
`name`	`string`
`disable_rate_limit`	`boolean`
`password_restore_redirect_url`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`create_date`	`string`
`type`	`string`
`id`	`string`	Resource id.

`GET /admin/application/search/`

Application search

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.
`user_id`	`array [string]`

Resource fields

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

Resource application

Name	Type	Description
`redirect_uris`	`string`
`create_date`	`string`
`name`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`user_id`	`integer`
`type`	`string`
`id`	`string`	Resource id.

`POST /admin/application/{application_id}/rate_limit/`

Add application rate limit

Path parameters

Name	Type	Description
`application_id`	`string`	Required.

JSON parameters

Name	Type	Description
`limit_value`	`integer`	Required.
`limit_name`	`string`	Required. One of 'default', 'stats'.

Resource fields

Name	Type	Description
`limit_value`	`integer`
`id`	`integer`	Resource id.
`limit_name`	`string`

`GET /admin/application/{application_id}/rate_limit/`

Get application rate limit list

Path parameters

Name	Type	Description
`application_id`	`string`	Required.

Resource fields

Name	Type	Description
`limit_value`	`integer`
`id`	`integer`	Resource id.
`limit_name`	`string`

`PUT /admin/application/{application_id}/rate_limit/{limit_id`}

Update application rate limit value

Path parameters

Name	Type	Description
`application_id`	`string`	Required.
`limit_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`limit_value`	`integer`	Required.

Resource fields

Name	Type	Description
`limit_value`	`integer`
`id`	`integer`	Resource id.
`limit_name`	`string`

`GET /admin/application/{application_id}/rate_limit/{limit_id`}

Get application rate limit by id

Path parameters

Name	Type	Description
`application_id`	`string`	Required.
`limit_id`	`integer`	Required.

Resource fields

Name	Type	Description
`limit_value`	`integer`
`id`	`integer`	Resource id.
`limit_name`	`string`

`DELETE /admin/application/{application_id}/rate_limit/{limit_id`}

Delete application rate limit

Path parameters

Name	Type	Description
`application_id`	`string`	Required.
`limit_id`	`integer`	Required.

`PUT /admin/application/{id`}

Update application

Path parameters

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

JSON parameters

Name	Type	Description
`redirect_uris`	`string`
`disable_confirmation`	`boolean`
`name`	`string`
`disable_rate_limit`	`boolean`
`password_restore_redirect_url`	`string`
`access`	`string`	One of 'call_api', 'all'.
`type`	`string`	One of 'public', 'trusted', 'password_credentials'.

Resource fields

Name	Type	Description
`user_id`	`integer`
`redirect_uris`	`string`
`disable_confirmation`	`boolean`
`name`	`string`
`disable_rate_limit`	`boolean`
`password_restore_redirect_url`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`create_date`	`string`
`type`	`string`
`id`	`string`	Resource id.

`GET /admin/application/{id`}

Get application by id

Path parameters

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

Resource fields

Name	Type	Description
`user_id`	`integer`
`redirect_uris`	`string`
`disable_confirmation`	`boolean`
`name`	`string`
`disable_rate_limit`	`boolean`
`password_restore_redirect_url`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`create_date`	`string`
`type`	`string`
`id`	`string`	Resource id.

`DELETE /admin/application/{id`}

Delete application

Path parameters

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

`PUT /admin/application/{id}/reset_secret/`

Reset application secret

Path parameters

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

Resource fields

Name	Type	Description
`redirect_uris`	`string`
`create_date`	`string`
`name`	`string`
`created_by`	`string`
`access`	`string`
`secret`	`string`	Default: visible_only_when_creating_or_resetting
`user_id`	`integer`
`type`	`string`
`id`	`string`	Resource id.

`GET /admin/call_leg_count/`

Get count of active call legs

Resource fields

Name	Type	Description
`call_leg_count`	`integer`

`POST /admin/client/`

Add client

JSON parameters

Name	Type	Description
`hidden_comment`	`string`
`forced_prefix`	`string`
`hold_music`	`integer`	Music on hold sound id.
`presence`	`string`	One of 'yes', 'no'.
`speech_to_text`	`boolean`
`record_stereo`	`boolean`	Default: False
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`extension_group_limit`	`integer`
`ivr_option_limit`	`integer`
`call_interactive_method`	`string`	Call interactive method. One of 'GET', 'POST'. Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`	Required.
`reg_limit`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`	Default: 3
`dealer_id`	`integer`	Required.
`reg_status_log`	`boolean`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`name`	`string`	Required.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`	One of 'J', 'F'.
`email`	`string`	Required.
`status`	`string`	One of 'active', 'blocked'.
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`user_client_limit`	`integer`
`exclude_codecs`	`string`	Comma-separated list of codecs without spaces.
`call_interactive_url`	`string`	Call interactive url.
`outg_call_VR_on_fail`	`boolean`
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dial_rule_limit`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`	One of 'default', 'from', 'diversion'.
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`	One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'.
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	One of 'mp3', 'wav'. Default: mp3
`short_local_caller_id`	`string`	One of 'yes', 'no'.
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`	Music for outg_call_vr_on_fail param.
`call_interactive_timeout`	`integer`	Call interactive timout.

Resource fields

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`speech_to_text`	`boolean`	Default: False
`reg_limit`	`integer`	Default: 0
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`prefix`	`string`
`extension_group_limit`	`integer`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`
`dial_rule_limit`	`integer`
`reg_status_log`	`boolean`
`name`	`string`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`id`	`integer`	Resource id.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`status`	`string`
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`
`call_interactive_url`	`string`
`outg_call_VR_on_fail`	`boolean`	Default: False
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dealer_id`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`
`call_interactive_timeout`	`integer`
`user_client_limit`	`integer`

`GET /admin/client/`

Get client list

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`name`	`array [string]`
`id`	`array [integer]`
`domain_id`	`array [integer]`
`dealer_id`	`array [integer]`
`routing_list_id`	`array [integer]`
`prefix`	`array [string]`
`type`	`array [string]`
`extension_len`	`array [integer]`
`order_by`	`string`	One of 'name', 'prefix', 'domain_id', 'status'.
`order`	`string`	One of 'desc', 'asc'. Default: asc

Resource fields

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`speech_to_text`	`boolean`	Default: False
`reg_limit`	`integer`	Default: 0
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`prefix`	`string`
`extension_group_limit`	`integer`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`
`dial_rule_limit`	`integer`
`reg_status_log`	`boolean`
`name`	`string`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`id`	`integer`	Resource id.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`status`	`string`
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`
`call_interactive_url`	`string`
`outg_call_VR_on_fail`	`boolean`	Default: False
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dealer_id`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`
`call_interactive_timeout`	`integer`
`user_client_limit`	`integer`

`GET /admin/client/search/`

Client search

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`q`	`string`	Required.
`order_by`	`string`	One of 'name', 'prefix', 'domain_id', 'status'.
`order`	`string`	One of 'desc', 'asc'. Default: asc
`dealer_id`	`integer`

Resource fields

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

Resource client_search

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`speech_to_text`	`boolean`	Default: False
`reg_limit`	`integer`	Default: 0
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`prefix`	`string`
`extension_group_limit`	`integer`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`
`dial_rule_limit`	`integer`
`reg_status_log`	`boolean`
`name`	`string`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`id`	`integer`	Resource id.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`status`	`string`
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`
`call_interactive_url`	`string`
`outg_call_VR_on_fail`	`boolean`	Default: False
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dealer_id`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`
`call_interactive_timeout`	`integer`
`user_client_limit`	`integer`

`PUT /admin/client/{client_id`}

Update client

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`hold_music`	`integer`	Music on hold sound id.
`presence`	`string`	One of 'yes', 'no'.
`speech_to_text`	`boolean`
`reg_limit`	`integer`
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`call_interactive_method`	`string`	Call interactive method. One of 'GET', 'POST'. Default: GET
`extension_group_limit`	`integer`
`record_stereo`	`boolean`
`extension_limit`	`integer`
`ambassadors`	`string`
`user_extension_limit`	`integer`
`user_extension_group_limit`	`integer`
`outg_call_VR_on_fail`	`boolean`
`dealer_id`	`integer`
`reg_status_log`	`boolean`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`name`	`string`
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`	One of 'J', 'F'.
`email`	`string`
`status`	`string`	One of 'active', 'blocked'.
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`	Comma-separated list of codecs without spaces.
`call_interactive_url`	`string`	Call interactive url.
`disk_quota`	`integer`
`event_limit`	`integer`
`dial_rule_limit`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`	One of 'default', 'from', 'diversion'.
`timezone`	`string`
`jur_address`	`string`
`language`	`string`	One of 'None', 'ab', 'aa', 'af', 'ak', 'sq', 'am', 'ar', 'an', 'hy', 'as', 'av', 'ae', 'ay', 'az', 'bm', 'ba', 'eu', 'be', 'bn', 'bh', 'bi', 'bs', 'br', 'bg', 'my', 'ca', 'ch', 'ce', 'ny', 'zh', 'cv', 'kw', 'co', 'cr', 'hr', 'cs', 'da', 'dv', 'nl', 'dz', 'en', 'eo', 'et', 'ee', 'fo', 'fj', 'fi', 'fr', 'ff', 'gl', 'ka', 'de', 'el', 'gn', 'gu', 'ht', 'ha', 'he', 'hz', 'hi', 'ho', 'hu', 'ia', 'id', 'ie', 'ga', 'ig', 'ik', 'io', 'is', 'it', 'iu', 'ja', 'jv', 'kl', 'kn', 'kr', 'ks', 'kk', 'km', 'ki', 'rw', 'ky', 'kv', 'kg', 'ko', 'ku', 'kj', 'la', 'lb', 'lg', 'li', 'ln', 'lo', 'lt', 'lu', 'lv', 'gv', 'mk', 'mg', 'ms', 'ml', 'mt', 'mi', 'mr', 'mh', 'mn', 'na', 'nv', 'nd', 'ne', 'ng', 'nb', 'nn', 'no', 'ii', 'nr', 'oc', 'oj', 'cu', 'om', 'or', 'os', 'pa', 'pi', 'fa', 'pl', 'ps', 'pt', 'qu', 'rm', 'rn', 'ro', 'ru', 'sa', 'sc', 'sd', 'se', 'sm', 'sg', 'sr', 'gd', 'sn', 'si', 'sk', 'sl', 'so', 'st', 'es', 'su', 'sw', 'ss', 'sv', 'ta', 'te', 'tg', 'th', 'ti', 'bo', 'tk', 'tl', 'tn', 'to', 'tr', 'ts', 'tt', 'tw', 'ty', 'ug', 'uk', 'ur', 'uz', 've', 'vi', 'vo', 'wa', 'cy', 'wo', 'fy', 'xh', 'yi', 'yo', 'za', 'zu'.
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	One of 'mp3', 'wav'.
`short_local_caller_id`	`string`	One of 'yes', 'no'.
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`	Music for outg_call_vr_on_fail param.
`call_interactive_timeout`	`integer`	Call interactive timout.
`user_client_limit`	`integer`

Resource fields

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`speech_to_text`	`boolean`	Default: False
`reg_limit`	`integer`	Default: 0
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`prefix`	`string`
`extension_group_limit`	`integer`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`
`dial_rule_limit`	`integer`
`reg_status_log`	`boolean`
`name`	`string`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`id`	`integer`	Resource id.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`status`	`string`
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`
`call_interactive_url`	`string`
`outg_call_VR_on_fail`	`boolean`	Default: False
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dealer_id`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`
`call_interactive_timeout`	`integer`
`user_client_limit`	`integer`

`GET /admin/client/{client_id`}

Get client

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

Resource fields

Name	Type	Description
`hidden_comment`	`string`
`ivr_option_limit`	`integer`
`create_date`	`string`
`hold_music`	`integer`
`presence`	`string`
`speech_to_text`	`boolean`	Default: False
`reg_limit`	`integer`	Default: 0
`routing_list_id`	`integer`
`hidden_json`	`string`
`network_permission_limit`	`integer`
`extension_limit`	`integer`
`prefix`	`string`
`extension_group_limit`	`integer`
`record_stereo`	`boolean`	Default: False
`call_interactive_method`	`string`	Default: GET
`ambassadors`	`string`
`user_extension_limit`	`integer`
`domain_id`	`integer`
`user_extension_group_limit`	`integer`
`extension_len`	`integer`
`dial_rule_limit`	`integer`
`reg_status_log`	`boolean`
`name`	`string`
`sound_limit`	`integer`
`application_limit`	`integer`
`contact_phones`	`string`
`id`	`integer`	Resource id.
`calls_limit`	`integer`
`remote_agent_limit`	`integer`
`interval_limit`	`integer`
`outg_call_VR_code_list`	`string`
`dial_rule_id`	`integer`
`type`	`string`
`email`	`string`
`status`	`string`
`ivr_rule_limit`	`integer`
`extra_params`	`string`
`fact_address`	`string`
`extension_agent_limit`	`integer`
`sip_network_permission_id`	`integer`
`exclude_codecs`	`string`
`call_interactive_url`	`string`
`outg_call_VR_on_fail`	`boolean`	Default: False
`disk_quota`	`integer`	Default: 0
`event_limit`	`integer`
`dealer_id`	`integer`
`geo_list`	`string`
`did_as_transfer_caller_id`	`string`
`timezone`	`string`	Default: Europe/Moscow
`jur_address`	`string`
`language`	`string`
`ivr_context_limit`	`integer`
`call_interactive_out_call`	`boolean`	Default: False
`record_format`	`string`	Default: mp3
`short_local_caller_id`	`string`
`disk_space_notify_email`	`string`
`disk_space_notify_threshold`	`integer`
`incom_rule_limit`	`integer`
`VR_sound`	`integer`
`call_interactive_timeout`	`integer`
`user_client_limit`	`integer`

`DELETE /admin/client/{client_id`}

Delete client

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

Query parameters

Name	Type	Description
`delete_dids`	`boolean`

`PUT /admin/client/{client_id}/allowed_applications/`

Update client allowed applications

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

JSON parameters

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

Resource fields

Name	Type	Description
`allowed_applications`	`array [string]`

`GET /admin/client/{client_id}/allowed_applications/`

Get client allowed applications

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

Resource fields

Name	Type	Description
`allowed_applications`	`array [string]`

`GET /admin/client/{client_id}/media_server/`

Get client current media server address

Path parameters

Name	Type	Description
`client_id`	`integer`	Required.

Resource fields

Name	Type	Description
`media_server_id`	`integer`

`POST /admin/dealer/`

Add dealer

JSON parameters

Name	Type	Description
`dial_rule_limit`	`integer`
`jur_address`	`string`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`	Comma-separated list of codecs without spaces.
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`ambassadors`	`string`
`dial_rule_id`	`integer`
`type`	`string`	One of 'J', 'F'.
`geo_list`	`string`
`name`	`string`	Required.

Resource fields

Name	Type	Description
`create_date`	`string`
`jur_address`	`string`
`dial_rule_limit`	`integer`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`dial_rule_id`	`integer`
`ambassadors`	`string`
`type`	`string`
`id`	`integer`	Resource id.
`geo_list`	`string`
`name`	`string`

`GET /admin/dealer/`

Get dealer list

Query parameters

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

Resource fields

Name	Type	Description
`create_date`	`string`
`jur_address`	`string`
`dial_rule_limit`	`integer`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`dial_rule_id`	`integer`
`ambassadors`	`string`
`type`	`string`
`id`	`integer`	Resource id.
`geo_list`	`string`
`name`	`string`

`PUT /admin/dealer/{dealer_id`}

Update dealer

Path parameters

Name	Type	Description
`dealer_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`dial_rule_limit`	`integer`
`jur_address`	`string`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`	Comma-separated list of codecs without spaces.
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`ambassadors`	`string`
`dial_rule_id`	`integer`
`type`	`string`	One of 'J', 'F'.
`geo_list`	`string`
`name`	`string`

Resource fields

Name	Type	Description
`create_date`	`string`
`jur_address`	`string`
`dial_rule_limit`	`integer`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`dial_rule_id`	`integer`
`ambassadors`	`string`
`type`	`string`
`id`	`integer`	Resource id.
`geo_list`	`string`
`name`	`string`

`GET /admin/dealer/{dealer_id`}

Get dealer

Path parameters

Name	Type	Description
`dealer_id`	`integer`	Required.

Resource fields

Name	Type	Description
`create_date`	`string`
`jur_address`	`string`
`dial_rule_limit`	`integer`
`fact_address`	`string`
`client_calls_limit`	`integer`
`exclude_codecs`	`string`
`routing_list_id`	`integer`
`contact_phones`	`string`
`fax_out_greeting`	`integer`
`dispatcher_list_id`	`integer`
`client_day_limit`	`integer`
`contact_emails`	`string`
`dial_rule_id`	`integer`
`ambassadors`	`string`
`type`	`string`
`id`	`integer`	Resource id.
`geo_list`	`string`
`name`	`string`

`DELETE /admin/dealer/{dealer_id`}

Delete dealer

Path parameters

Name	Type	Description
`dealer_id`	`integer`	Required.

`PUT /admin/dealer/{dealer_id}/allowed_domains/`

Update dealer allowed domains

Path parameters

Name	Type	Description
`dealer_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`allowed_domains`	`array [integer]`	Required.

Resource fields

Name	Type	Description
`allowed_domains`	`array [integer]`

`GET /admin/dealer/{dealer_id}/allowed_domains/`

Get dealer allowed domains

Path parameters

Name	Type	Description
`dealer_id`	`integer`	Required.

Resource fields

Name	Type	Description
`allowed_domains`	`array [integer]`

`PUT /admin/dealer_global_access_list/`

Update access list

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
`network_address`	`string`
`description`	`string`
`id`	`integer`	Resource id.

`GET /admin/dealer_global_access_list/`

Get access list

Resource fields

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

`GET /admin/defaults/`

Get default values list

Query parameters

Name	Type	Description
`id`	`array [integer]`
`name`	`array [string]`
`value`	`array [string]`

Resource fields

Name	Type	Description
`value`	`integer`
`description`	`string`
`name`	`string`
`id`	`integer`	Resource id.

`PUT /admin/defaults/{id`}

Update default value

Path parameters

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

JSON parameters

Name	Type	Description
`value`	`string`

Resource fields

Name	Type	Description
`value`	`integer`
`description`	`string`
`name`	`string`
`id`	`integer`	Resource id.

`GET /admin/defaults/{id`}

Get default value by id

Path parameters

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

Resource fields

Name	Type	Description
`value`	`integer`
`description`	`string`
`name`	`string`
`id`	`integer`	Resource id.

`POST /admin/dial_rule/`

Add global dial rule list

JSON parameters

Name	Type	Description
`dial_rules`	`array [dial_rule]`	Required.
`type`	`string`	One of 'dial', 'trunk_a'. Default: dial
`name`	`string`	Required.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`name`	`string`
`client_id`	`integer`
`type`	`string`
`id`	`integer`	Resource id.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`GET /admin/dial_rule/`

Get global dial rule lists list

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`name`	`string`
`client_id`	`integer`
`type`	`string`
`id`	`integer`	Resource id.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`PUT /admin/dial_rule/{dial_rules_id`}

Update global dial rule list

Path parameters

Name	Type	Description
`dial_rules_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`name`	`string`

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`name`	`string`
`client_id`	`integer`
`type`	`string`
`id`	`integer`	Resource id.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`GET /admin/dial_rule/{dial_rules_id`}

Get global dial rule list

Path parameters

Name	Type	Description
`dial_rules_id`	`integer`	Required.

Resource fields

Name	Type	Description
`dial_rules`	`array [dial_rule]`
`dealer_id`	`integer`
`name`	`string`
`client_id`	`integer`
`type`	`string`
`id`	`integer`	Resource id.

Resource dial_rule

Name	Type	Description
`comment`	`string`
`repl_exp`	`string`	Required.
`match_exp`	`string`	Required.

`DELETE /admin/dial_rule/{dial_rules_id`}

Delete global dial rule list

Path parameters

Name	Type	Description
`dial_rules_id`	`integer`	Required.

`POST /admin/did/`

Add did

JSON parameters

Name	Type	Description
`comment`	`string`
`domain`	`string`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`trunk_id`	`integer`	Required.
`allow_message`	`boolean`
`name`	`string`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`registration`	`boolean`	Default: False
`create_date`	`string`
`trunk_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`GET /admin/did/`

Get did list

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [integer]`
`name`	`array [string]`
`domain`	`array [string]`
`trunk_id`	`array [integer]`
`dealer_id`	`array [integer]`
`client_id`	`array [integer]`
`extension_id`	`array [integer]`
`message_extension_id`	`array [integer]`
`order_by`	`string`	One of 'name', 'id'. Default: name
`order_type`	`string`	One of 'desc', 'asc'. Default: asc

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`registration`	`boolean`	Default: False
`create_date`	`string`
`trunk_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`GET /admin/did/search/`

Did search

Query parameters

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

Resource fields

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

Resource did_search

Name	Type	Description
`comment`	`string`
`domain`	`object`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`registration`	`boolean`	Default: False
`create_date`	`string`
`trunk_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`PUT /admin/did/{did_id`}

Update did

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`domain`	`string`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`trunk_id`	`integer`
`allow_message`	`boolean`
`name`	`string`

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`registration`	`boolean`	Default: False
`create_date`	`string`
`trunk_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`GET /admin/did/{did_id`}

Get did

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`domain`	`object`
`dealer_id`	`integer`
`message_extension_id`	`integer`
`local_did`	`boolean`
`extension_id`	`integer`
`client_id`	`integer`
`registration`	`boolean`	Default: False
`create_date`	`string`
`trunk_id`	`integer`
`id`	`integer`	Resource id.
`allow_message`	`boolean`
`name`	`string`

`DELETE /admin/did/{did_id`}

Delete did

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

`PUT /admin/did/{did_id}/registration/`

Update did registration information

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`auth_password`	`string`
`enabled`	`boolean`
`auth_proxy`	`string`
`expires`	`integer`

Resource fields

Name	Type	Description
`username`	`string`
`domain`	`string`
`realm`	`string`
`auth_proxy`	`object`
`expires`	`integer`
`enabled`	`object`
`auth_password`	`string`
`auth_username`	`string`

`POST /admin/did/{did_id}/registration/`

Add did registration information

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`username`	`string`	Required.
`domain`	`string`	Required.
`realm`	`string`	Required.
`auth_proxy`	`string`	Required.
`expires`	`integer`	Required.
`enabled`	`boolean`	Required.
`auth_password`	`string`	Required.
`auth_username`	`string`	Required.

Resource fields

Name	Type	Description
`username`	`string`
`domain`	`string`
`realm`	`string`
`auth_proxy`	`object`
`expires`	`integer`
`enabled`	`object`
`auth_password`	`string`
`auth_username`	`string`

`GET /admin/did/{did_id}/registration/`

Get did registration information

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

Resource fields

Name	Type	Description
`username`	`string`
`domain`	`string`
`realm`	`string`
`auth_proxy`	`object`
`expires`	`integer`
`enabled`	`object`
`auth_password`	`string`
`auth_username`	`string`

`DELETE /admin/did/{did_id}/registration/`

Delete did registration information

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

`GET /admin/did/{did_id}/registration/status/`

Get did registration status

Path parameters

Name	Type	Description
`did_id`	`integer`	Required.

Resource fields

Name	Type	Description
`registered`	`boolean`	Default: False
`expires`	`integer`

`POST /admin/dispatcher/`

Add dispatcher

JSON parameters

Name	Type	Description
`description`	`string`	Required.
`weight`	`integer`	Required.
`destination`	`string`	Required.
`enabled`	`boolean`	Required.
`local_hostname`	`string`	Required.
`list_id`	`integer`	Required.
`force_dial`	`string`	Required.

Resource fields

Name	Type	Description
`description`	`string`
`weight`	`object`
`destination`	`string`
`enabled`	`object`
`local_hostname`	`object`
`list_id`	`integer`
`force_dial`	`string`
`id`	`integer`	Resource id.

`GET /admin/dispatcher/`

Get dispatcher list

Resource fields

Name	Type	Description
`description`	`string`
`weight`	`object`
`destination`	`string`
`enabled`	`object`
`local_hostname`	`object`
`list_id`	`integer`
`force_dial`	`string`
`id`	`integer`	Resource id.

`PUT /admin/dispatcher/{dispatcher_id`}

Update dispatcher

Path parameters

Name	Type	Description
`dispatcher_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`description`	`string`
`weight`	`integer`
`destination`	`string`
`enabled`	`boolean`
`local_hostname`	`string`
`list_id`	`integer`
`force_dial`	`string`

Resource fields

Name	Type	Description
`description`	`string`
`weight`	`object`
`destination`	`string`
`enabled`	`object`
`local_hostname`	`object`
`list_id`	`integer`
`force_dial`	`string`
`id`	`integer`	Resource id.

`GET /admin/dispatcher/{dispatcher_id`}

Get dispatcher

Path parameters

Name	Type	Description
`dispatcher_id`	`integer`	Required.

Resource fields

Name	Type	Description
`description`	`string`
`weight`	`object`
`destination`	`string`
`enabled`	`object`
`local_hostname`	`object`
`list_id`	`integer`
`force_dial`	`string`
`id`	`integer`	Resource id.

`DELETE /admin/dispatcher/{dispatcher_id`}

Delete dispatcher

Path parameters

Name	Type	Description
`dispatcher_id`	`integer`	Required.

`POST /admin/dispatcher_list/`

Add dispatcher list

JSON parameters

Name	Type	Description
`name`	`string`	Required.

Resource fields

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

`GET /admin/dispatcher_list/`

Get dispatcher lists

Resource fields

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

`PUT /admin/dispatcher_list/{list_id`}

Update dispatcher list

Path parameters

Name	Type	Description
`list_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`name`	`string`

Resource fields

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

`GET /admin/dispatcher_list/{list_id`}

Get dispatcher list

Path parameters

Name	Type	Description
`list_id`	`integer`	Required.

Resource fields

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

`DELETE /admin/dispatcher_list/{list_id`}

Delete dispatcher list

Path parameters

Name	Type	Description
`list_id`	`integer`	Required.

`POST /admin/domain/`

Add domain

JSON parameters

Name	Type	Description
`comment`	`string`	Domain comment.
`domain_prefix`	`string`	Required. Domain prefix. 5-character string.
`name`	`string`	Required. Domain name.

Resource fields

Name	Type	Description
`comment`	`string`
`domain_prefix`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`GET /admin/domain/`

Get domain list

Query parameters

Name	Type	Description
`id`	`array [integer]`
`name`	`array [string]`
`domain_prefix`	`array [string]`
`comment`	`array [string]`

Resource fields

Name	Type	Description
`comment`	`string`
`domain_prefix`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`PUT /admin/domain/{domain_id`}

Update domain

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`

Resource fields

Name	Type	Description
`comment`	`string`
`domain_prefix`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`GET /admin/domain/{domain_id`}

Get domain

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`domain_prefix`	`string`
`id`	`integer`	Resource id.
`name`	`string`

`DELETE /admin/domain/{domain_id`}

Delete domain

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

`POST /admin/domain/{domain_id}/alias/`

Add domain alias

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`name`	`string`	Required.

Resource fields

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

`GET /admin/domain/{domain_id}/alias/`

Get domain aliases list

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

Resource fields

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

`PUT /admin/domain/{domain_id}/alias/{id`}

Update domain alias by id

Path parameters

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

JSON parameters

Name	Type	Description
`comment`	`string`
`name`	`string`

Resource fields

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

`GET /admin/domain/{domain_id}/alias/{id`}

Get domain alias by id

Path parameters

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

Resource fields

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

`DELETE /admin/domain/{domain_id}/alias/{id`}

Delete domain alias

Path parameters

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

`POST /admin/domain/{domain_id}/force_dst/`

Add domain force dst

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`ip`	`string`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`GET /admin/domain/{domain_id}/force_dst/`

Get domain force dst list

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`PUT /admin/domain/{domain_id}/force_dst/{id`}

Update domain force dst by id

Path parameters

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

JSON parameters

Name	Type	Description
`comment`	`string`

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`GET /admin/domain/{domain_id}/force_dst/{id`}

Get domain force dst by id

Path parameters

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

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`DELETE /admin/domain/{domain_id}/force_dst/{id`}

Delete domain force dst

Path parameters

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

`POST /admin/domain/{domain_id}/force_src/`

Add domain force src

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

JSON parameters

Name	Type	Description
`comment`	`string`
`ip`	`string`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`GET /admin/domain/{domain_id}/force_src/`

Get domain force src list

Path parameters

Name	Type	Description
`domain_id`	`integer`	Required.

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`PUT /admin/domain/{domain_id}/force_src/{id`}

Update domain force src by id

Path parameters

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

JSON parameters

Name	Type	Description
`comment`	`string`

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`GET /admin/domain/{domain_id}/force_src/{id`}

Get domain force src by id

Path parameters

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

Resource fields

Name	Type	Description
`comment`	`string`
`ip`	`string`
`id`	`integer`	Resource id.

`DELETE /admin/domain/{domain_id}/force_src/{id`}

Delete domain force src

Path parameters

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

`POST /admin/extension/`

Add extension

JSON parameters

Name	Type	Description
`status`	`string`	One of 'active', 'blocked'. Default: blocked
`dial_rule_limit`	`integer`
`from_public_caller_id_number`	`boolean`
`name`	`string`	Required.
`rfc_public_caller_id_number`	`boolean`
`extra_params`	`string`
`public_caller_id_number`	`string`
`label`	`string`
`caller_id_name`	`string`
`client_id`	`integer`	Required.
`extension_group_id`	`integer`
`message_did`	`string`
`dial_rule_id`	`integer`
`ani_rfc3325`	`boolean`
`type`	`string`	Required. One of 'phone', 'queue', 'ivr', 'fax', 'conference'.
`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/`

Get extension list

Query parameters

Name	Type	Description
`page`	`integer`	Default: 1
`per_page`	`integer`
`id`	`array [string]`
`name`	`array [string]`
`type`	`array [string]`
`status`	`array [string]`
`client_id`	`array [integer]`
`extension_group_id`	`array [integer]`

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

Extension search

Query parameters

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

Resource extension_search

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

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

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.
`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.
`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.
`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
`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
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`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 /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
`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
`static_reg_host`	`object`
`vm_profile`	`string`	Default: default
`static_reg_address`	`string`
`geo_list`	`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 /admin/extension/{extension_id}/sip_auth_info/`

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`

`POST /admin/force_balancing/`

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 /admin/force_balancing/{extension_id`}

Get extension force balancing

Path parameters

Name	Type	Description
`extension_id`	`integer`	Required.

Resource fields

Name	Type	Description
`extension_id`	`integer`

`DELETE /admin/force_balancing/{extension_id`}

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.

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

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

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

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

Delete interval

Path parameters

Name	Type	Description
`interval_id`	`integer`	Required.

`POST /admin/license/`

Load new license

Form parameters

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

`POST /admin/network_permission/`

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

Get admin network permission group list

Query parameters

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.

`GET /admin/network_permission/search/`

Network permission search

Query parameters

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

Resource network_permission

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.

`PUT /admin/network_permission/{group_id`}

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 /admin/network_permission/{group_id`}

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 /admin/network_permission/{group_id`}

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

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.

Resource routing_rule

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`

Resource routing_rule

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

`GET /admin/routing/`

Get routing list

Resource fields

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

Resource routing_rule

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

Resource routing_rule

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`

Resource routing_rule

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

Resource routing_rule

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

`DELETE /admin/routing/{id`}

Delete routing list

Path parameters

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

`POST /admin/sound/`

Add sound

Form parameters

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`

`GET /admin/sound/`

Get sound list

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

Common sounds search

Query parameters

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.

`GET /admin/status/`

Get pbx status

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

`GET /admin/trunk/`

Get trunk list

Query parameters

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`

`GET /admin/trunk/search/`

Trunk search

Query parameters

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

Resource trunk_search

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`

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

`GET /admin/user/admin/`

Get admin user list

Query parameters

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.

`GET /admin/users/`

Get user list

Query parameters

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`

`GET /admin/users/search/`

User search

Query parameters

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

Resource user_search

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`

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

`PUT /admin/users/{user_id}/access_list/`

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 /admin/users/{user_id}/access_list/`

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 /admin/voicemail/{record_uuid}/full_path/`

Get voicemail storage url

Path parameters

Name	Type	Description
`record_uuid`	`string`	Required.

Admin

PUT /admin/admin_global_access_list/

JSON parameters

Resource fields

GET /admin/admin_global_access_list/

Resource fields

POST /admin/alias/

JSON parameters

Resource fields

GET /admin/alias/

Query parameters

Resource fields

GET /admin/alias/search/

Query parameters

Resource fields

Resource alias

PUT /admin/alias/{alias_id}

Path parameters

JSON parameters

Resource fields

GET /admin/alias/{alias_id}

Path parameters

Resource fields

DELETE /admin/alias/{alias_id}

Path parameters

POST /admin/application/

JSON parameters

Resource fields

GET /admin/application/

Query parameters

Resource fields

GET /admin/application/search/

Query parameters

Resource fields

Resource application

POST /admin/application/{application_id}/rate_limit/

Path parameters

JSON parameters

Resource fields

GET /admin/application/{application_id}/rate_limit/

Path parameters

Resource fields

PUT /admin/application/{application_id}/rate_limit/{limit_id}

Path parameters

JSON parameters

Resource fields

GET /admin/application/{application_id}/rate_limit/{limit_id}

Path parameters

Resource fields

DELETE /admin/application/{application_id}/rate_limit/{limit_id}

Path parameters

PUT /admin/application/{id}

Path parameters

JSON parameters

Resource fields

GET /admin/application/{id}

Path parameters

Resource fields

DELETE /admin/application/{id}

Path parameters

PUT /admin/application/{id}/reset_secret/

Path parameters

Resource fields

GET /admin/call_leg_count/

Resource fields

POST /admin/client/

JSON parameters

Resource fields

GET /admin/client/

Query parameters

Resource fields

GET /admin/client/search/

Query parameters

Resource fields

Resource client_search

PUT /admin/client/{client_id}

Path parameters

JSON parameters

Resource fields

GET /admin/client/{client_id}

`PUT /admin/admin_global_access_list/`

`GET /admin/admin_global_access_list/`

`POST /admin/alias/`

`GET /admin/alias/`

`GET /admin/alias/search/`

`PUT /admin/alias/{alias_id`}

`GET /admin/alias/{alias_id`}

`DELETE /admin/alias/{alias_id`}

`POST /admin/application/`

`GET /admin/application/`

`GET /admin/application/search/`

`POST /admin/application/{application_id}/rate_limit/`

`GET /admin/application/{application_id}/rate_limit/`

`PUT /admin/application/{application_id}/rate_limit/{limit_id`}

`GET /admin/application/{application_id}/rate_limit/{limit_id`}

`DELETE /admin/application/{application_id}/rate_limit/{limit_id`}

`PUT /admin/application/{id`}

`GET /admin/application/{id`}

`DELETE /admin/application/{id`}

`PUT /admin/application/{id}/reset_secret/`

`GET /admin/call_leg_count/`

`POST /admin/client/`

`GET /admin/client/`

`GET /admin/client/search/`

`PUT /admin/client/{client_id`}

`GET /admin/client/{client_id`}

`DELETE /admin/client/{client_id`}

`PUT /admin/client/{client_id}/allowed_applications/`

`GET /admin/client/{client_id}/allowed_applications/`

`GET /admin/client/{client_id}/media_server/`

`POST /admin/dealer/`

`GET /admin/dealer/`

`PUT /admin/dealer/{dealer_id`}

`GET /admin/dealer/{dealer_id`}

`DELETE /admin/dealer/{dealer_id`}

`PUT /admin/dealer/{dealer_id}/allowed_domains/`

`GET /admin/dealer/{dealer_id}/allowed_domains/`

`PUT /admin/dealer_global_access_list/`

`GET /admin/dealer_global_access_list/`

`GET /admin/defaults/`

`PUT /admin/defaults/{id`}

`GET /admin/defaults/{id`}

`POST /admin/dial_rule/`

`GET /admin/dial_rule/`

`PUT /admin/dial_rule/{dial_rules_id`}

`GET /admin/dial_rule/{dial_rules_id`}