[Index]
Model ref.: device/skypeforbusiness/CsVoicePolicy
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "VoiceDeploymentMode": { "__type_requested": "", "required": false, "description": "Allowed values are:\nOnPrem\nOnline\nOnlineBasic\nOnPremOnlineHybrid\nThe default value is OnPrem.", "title": "VoiceDeploymentMode", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "VoiceDeploymentMode" }, "AllowPSTNReRouting": { "__type_requested": "$true | $false", "required": false, "description": "When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable.\nDefault: True", "title": "AllowPSTNReRouting", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowPSTNReRouting" }, "ScopeClass": { "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", "required": false, "name": "ScopeClass", "title": "ScopeClass", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AllowSimulRing": { "__type_requested": "$true | $false", "required": false, "description": "Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. Setting this parameter to True enables this feature. If this parameter is set to False, simultaneous ring cannot be configured for any user to which this policy is assigned.\nDefault: True", "title": "AllowSimulRing", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowSimulRing" }, "EnableCallPark": { "__type_requested": "$true | $false", "required": false, "description": "The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables the application. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number.\nDefault: False", "title": "EnableCallPark", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableCallPark" }, "EnableBWPolicyOverride": { "__type_requested": "$true | $false", "required": false, "description": "Policies can be set to manage network configuration, including limiting bandwidth. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True, no bandwidth checks will be made and calls will go through regardless of the call admission control (CAC) settings.\nDefault: False", "title": "EnableBWPolicyOverride", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableBWPolicyOverride" }, "Description": { "__type_requested": "String", "required": false, "description": "A description of the voice policy.\nMaximum length: 1040 characters.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "EnableDelegation": { "__type_requested": "$true | $false", "required": false, "description": "Call delegation allows a user to answer calls for another user or make calls on the other user's behalf. For example, a manager can set up call delegation so that all incoming calls ring both the manager's phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. Setting this parameter to False disables call delegation.\nDefault: True", "title": "EnableDelegation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableDelegation" }, "EnableTeamCall": { "__type_requested": "$true | $false", "required": false, "description": "Team Call allows a user to designate a group of other users whose phones will ring when that user's number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature.\nDefault: True", "title": "EnableTeamCall", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableTeamCall" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new voice policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", "title": "Tenant", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Tenant" }, "Name": { "__type_requested": "String", "required": false, "description": "A displayable name describing this policy.\nDefault: DefaultPolicy", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "PreventPSTNTollBypass": { "__type_requested": "$true | $false", "required": false, "description": "PSTN tolls are more commonly known as long-distance charges. Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect by using network calls. Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls.\nDefault: False", "title": "PreventPSTNTollBypass", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "PreventPSTNTollBypass" }, "EnableCallTransfer": { "__type_requested": "$true | $false", "required": false, "description": "Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred.\nDefault: True", "title": "EnableCallTransfer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableCallTransfer" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "CustomCallForwardingSimulRingUsages": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "description": "Custom PSTN usage used to manage call forwarding and simultaneous ringing. To add a custom usage to voice policy use syntax similar to this:\n-CustomCallForwardingSimulRingUsages @{Add=\"RedmondPstnUsage\"}\nTo remove a custom usage, use this syntax:\n-CustomCallForwardingSimulRingUsages @{Remove=\"RedmondPstnUsage\"}\nNote that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter.", "title": "CustomCallForwardingSimulRingUsages", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "CustomCallForwardingSimulRingUsages" }, "Anchor": { "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", "required": false, "name": "Anchor", "title": "Anchor", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PstnUsages": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "description": "A list of PSTN usages available to this policy. The PSTN usage ties a voice policy to a phone route.\nAny string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. (Duplicate strings are not allowed; all strings must be unique.) The list of PSTN usages can be retrieved by calling the Get-CsPstnUsage cmdlet.\nBy default this list is empty. If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls.", "title": "PstnUsages", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "PstnUsages" }, "EnableVoicemailEscapeTimer": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. If a call is answered \"too soon\" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail.\nThe default value is False.", "title": "EnableVoicemailEscapeTimer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableVoicemailEscapeTimer" }, "CallForwardingSimulRingUsageType": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Voice.CallForwardingSimulRingUsageType", "required": false, "description": "Provides a way for administrators to manage call forwarding and simultaneous ringing. Allowed values are:\nVoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value.\nInternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another.\nCustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter.", "title": "CallForwardingSimulRingUsageType", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "CallForwardingSimulRingUsageType" }, "Identity": { "__type_requested": "string", "required": true, "description": "A unique identifier specifying the scope or the name of the policy. Valid values for this cmdlet are site:<site name> (where <site name> is the name of the Skype for Business Server 2015 site to which this policy applies, such as site:Redmond), and a string designating a per-user policy, such as RedmondVoicePolicy. A global policy exists by default.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "PSTNVoicemailEscapeTimer": { "__type_requested": "Int64", "required": false, "description": "Amount of time (in milliseconds) used to determine whether or not a call has been answered \"too soon.\" If a response is received within this time interval Skype for Business Server 2015 will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed. The default value is 1500 milliseconds.", "title": "PSTNVoicemailEscapeTimer", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "PSTNVoicemailEscapeTimer" }, "AllowCallForwarding": { "__type_requested": "$true | $false", "required": false, "description": "If this parameter is set to True, calls can be forwarded. If this parameter is set to False, calls cannot be forwarded.\nDefault: True", "title": "AllowCallForwarding", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowCallForwarding" }, "EnableMaliciousCallTracing": { "__type_requested": "$true | $false", "required": false, "description": "Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities, not the user. Setting this property to True enables the ability to set a trace on malicious calls.\nDefault: False", "title": "EnableMaliciousCallTracing", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableMaliciousCallTracing" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsVoicePolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsVoicePolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsVoicePolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsVoicePolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsVoicePolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsVoicePolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsVoicePolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsVoicePolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsVoicePolicy/[pkid1]", "/api/device/skypeforbusiness/CsVoicePolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsVoicePolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsVoicePolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsVoicePolicy/[pkid1]", "/api/device/skypeforbusiness/CsVoicePolicy/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/skypeforbusiness/CsVoicePolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsVoicePolicy.
GET http://[host-proxy]/api/device/skypeforbusiness/CsVoicePolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsVoicePolicy | POST | /api/device/skypeforbusiness/CsVoicePolicy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/skypeforbusiness/CsVoicePolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsVoicePolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsVoicePolicy/ |
|
The device/skypeforbusiness/CsVoicePolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsVoicePolicy instances)
{ "operations": [ "cs_voice_policy", "move" ], "pagination": { "direction": "asc", "order_by": "Identity", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsVoicePolicy/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1150", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsVoicePolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/skypeforbusiness/CsVoicePolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsVoicePolicy/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/skypeforbusiness/CsVoicePolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsVoicePolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsVoicePolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsVoicePolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsVoicePolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "cs_voice_policy": { "support_async": true, "class": "custom", "href": "/api/device/skypeforbusiness/CsVoicePolicy/+cs_voice_policy/?hierarchy=[hierarchy]", "method": "POST", "title": "Cs Voice Policy" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsVoicePolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsVoicePolicy", "model_specific_actions": [ "list", "get", "cs_voice_policy", "powershell_disable", "powershell_enable", "powershell_move", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Identity", "title": "Identity" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsVoicePolicy. | GET | /api/device/skypeforbusiness/CsVoicePolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsVoicePolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsVoicePolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsVoicePolicy | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/skypeforbusiness/CsVoicePolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/skypeforbusiness/CsVoicePolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsVoicePolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsVoicePolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsVoicePolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsVoicePolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |