[Index]
HCS Contact Center Service Relation
Model ref.: relation/HcsCCSvcREL
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": {
"ccSvcName": {
"is_password": false,
"description": "Contact Center Service name to distinguish each instance",
"format": "regex",
"pattern": "^(\\S)+$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 512,
"title": "Contact Center Service Name",
"type": "string"
},
"description": {
"is_password": false,
"description": "Contact Center Service description",
"title": "description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 512,
"type": "string"
},
"ccServerName": {
"is_password": false,
"description": "Contact Center Server name",
"format": "uri",
"required": true,
"displayable": false,
"target_attr": "name",
"readonly": false,
"target": "/api/data/HcsCCServerDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxLength": 512,
"title": "Associated Contact Center Server Name",
"type": "string",
"target_model_type": "data/HcsCCServerDAT",
"choices": []
},
"patternArray": {
"is_password": false,
"title": "Internal Service Numbers",
"minItems": 0,
"items": {
"is_password": false,
"type": "object",
"properties": {
"pattern": {
"is_password": false,
"description": "Service Number Pattern (Route Pattern)",
"title": "Service Number Pattern",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"pattern": {
"title": "Pattern",
"type": "array",
"items": {
"type": "object",
"properties": {
"destination": {
"title": "Destination",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "object",
"properties": {
"routeListName": {
"description": " Choose the gateway or route list for which you are adding a route pattern. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If the gateway is included in a Route Group, this drop-down list box does not display the gateway. When a gateway is chosen in the drop-down list box, \n Cisco Unified Communications Manager uses all the ports in the gateway to route/block this route pattern. This action does not apply for MGCP gateways. \n \n \n ",
"title": "Gateway/Route List",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RouteList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"name": "routeListName",
"target_model_type": "device/cucm/RouteList",
"choices": []
},
"gatewayName": {
"name": "gatewayName",
"title": "Gateway Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "domainName",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/Gateway/choices/?field=domainName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Gateway",
"choices": []
}
}
},
"clientCodeRequired": {
"description": " If you want to use client matter codes with this route pattern, check this check box. The CMC feature does not support overlap sending because the \n Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Allow Overlap Sending check box, the Require Client Matter Code check box become disabled. ",
"title": "Require Client Matter Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"callingPartyPrefixDigits": {
"description": " Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries for the National Numbering Plan include the digits 0 through 9, the wildcard characters asterisk (*) and octothorpe (#), the international escape character +, and blank. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The appended prefix digit does not affect which directory numbers route to the assigned device. \n \n \n ",
"title": "Prefix Digits (Outgoing Calls)",
"minItems": 0,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"prefixDigitsOut": {
"description": " Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries for the National Numbering Plan include the digits 0 through 9, the wildcard characters asterisk (*) and octothorpe (#), the international escape character +, and blank. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The appended prefix digit does not affect which directory numbers route to the assigned device. \n \n \n ",
"title": "Prefix Digits (Outgoing Calls)",
"minItems": 1,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"callingPartyNumberingPlan": {
"description": " Choose the format for the numbering plan in calling party directory numbers. \n Cisco Unified Communications Manager sets the calling DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non national type number. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014Use when the \n Cisco Unified Communications Manager sets the Numbering Plan in the directory number. \n \n ISDN\u2014Use when you are dialing outside the dialing plan for your country. \n \n National Standard\u2014Use when you are dialing within the dialing plan for your country. \n \n Private\u2014Use when you are dialing within a private network. \n \n Unknown\u2014Use when the dialing plan is unknown. \n ",
"title": "Calling Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"connectedLinePresentationBit": {
"description": " \n Cisco Unified Communications Manager uses connected line ID presentation (COLP/COLR) as a supplementary service to allow or restrict the called party phone number on a call-by-call basis. Choose whether you want \n Cisco Unified Communications Manager to allow or restrict the display of the connected party phone number on the calling party phone display for this route pattern. Choose Default if you do not want to change the connected line ID presentation. Choose Allowed if you want to display the connected party phone number. Choose Restricted if you want \n Cisco Unified Communications Manager to block the display of the connected party phone number. If a call that originates from an IP phone on Cisco Unified Communications Manager encounters a device, such as a trunk, gateway, or route pattern, that has the Connected Line ID Presentation set to Default, the presentation value is automatically set to Allowed. ",
"title": "Connected Line ID Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"description": " If you want to use a partition to restrict access to the route pattern, choose the desired partition from the drop-down list box. If you do not want to restrict access to the route pattern, choose <None> for the partition. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Make sure that the combination of route pattern, route filter, and partition is unique within the \n Cisco Unified Communications Manager cluster. \n \n \n ",
"title": "Route Partition",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"releaseClause": {
"description": " The Route Option designation indicates whether you want this route pattern to be used for routing calls (such as 9.@ or 8[2-9]XX) or for blocking calls. Choose the Route this pattern or Block this pattern radio button. If you choose the Block this pattern radio button, you must choose the reason for which you want this route pattern to block calls. Choose a value from the drop-down list box: \n \n \n \n No Error \n \n Unallocated Number \n \n Call Rejected \n \n Number Changed \n \n Invalid Number Format \n \n Precedence Level Exceeded \n ",
"title": "Block this pattern",
"minItems": 0,
"required": false,
"choices": [
{
"value": "No Error",
"title": "No Error"
},
{
"value": "Unallocated Number",
"title": "Unallocated Number"
},
{
"value": "Call Rejected",
"title": "Call Rejected"
},
{
"value": "Number Changed",
"title": "Number Changed"
},
{
"value": "Invalid Number Format",
"title": "Invalid Number Format"
},
{
"value": "Precedence Level Exceeded",
"title": "Precedence Level Exceeded"
}
],
"default": "No Error",
"maxItems": 1,
"type": "string"
},
"blockEnable": {
"title": "Block Enable",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"callingPartyNumberType": {
"description": " Choose the format for the number type in calling party directory numbers. \n Cisco Unified Communications Manager sets the calling directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the calling directory number to be encoded to a non-national numbering plan type. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014The \n Cisco Unified Communications Manager sets the directory number type. \n \n Unknown\u2014Use when the dialing plan is unknown. \n \n National\u2014Use when you are dialing within the dialing plan for your country. \n \n International\u2014Use when you are dialing outside the dialing plan for your country. \n \n Subscriber\u2014Use when you are dialing a subscriber by using a shortened subscriber number. \n ",
"title": "Calling Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"externalCallControl": {
"description": "In \n Cisco Unified Communications Manager, you enable external call control by assigning an external call control profile to a route pattern. If the route pattern has an external call control profile assigned to it, when a call occurs that matches the route pattern, \n Cisco Unified Communications Manager immediately sends a call-routing query to an adjunct route server, and the adjunct route server directs \n Cisco Unified Communications Manager on how to handle the call. From the drop-down list box, choose the external call profile that you want to assign to the route pattern. ",
"title": "External Call Control",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/ExternalCallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/ExternalCallControlProfile",
"choices": []
},
"provideOutsideDialtone": {
"description": " Check this check box to provide outside dial tone. To route the call in the network, leave the check box unchecked. ",
"title": "Provide Outside Dial Tone",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"calledPartyTransformationMask": {
"description": " Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If the field is blank, no transformation takes place. \n Cisco Unified Communications Manager sends the dialed digits exactly as dialed. ",
"title": "Called Party Transform Mask",
"minItems": 0,
"pattern": "^[0-9*#+X]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"pattern": {
"description": " Enter the route pattern, including numbers and wildcards (do not use spaces); for example, for NANP, enter 9.@ for typical local access or 8XXX for a typical private network numbering plan. Valid characters include the uppercase characters A, B, C, and D and \\+, which represents the international escape character +. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the directory route pattern, which uses the chosen partition, route filter, and numbering plan combination, is unique. Check the route pattern, translation pattern, directory number, call park number, call pickup number, message waiting on/off, or meet me number if you receive an error that indicates duplicate entries. You can also check the route plan report. \n \n \n ",
"title": "Route Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"patternPrecedence": {
"description": " Choose an MLPP precedence setting for this route pattern from the drop-down list box: \n \n \n \n Executive Override\u2014Highest precedence setting for MLPP calls. \n \n Flash Override\u2014Second highest precedence setting for MLPP calls. \n \n Flash\u2014Third highest precedence setting for MLPP calls. \n \n Immediate\u2014Fourth highest precedence setting for MLPP calls. \n \n Priority\u2014Fifth highest precedence setting for MLPP calls. \n \n Routine\u2014Lowest precedence setting for MLPP calls. \n \n Default\u2014Does not override the incoming precedence level but rather lets it pass unchanged. \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n You cannot configure the Multilevel Precedence Preemption (MLPP) level on the Route Pattern page to flash, flash override, or executive override levels if you want to enable the DCC feature. You must set the MLPP level to these levels at the translation pattern instead. \n \n \n ",
"title": "MLPP Precedence",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Flash Override",
"title": "Flash Override"
},
{
"value": "Flash",
"title": "Flash"
},
{
"value": "Immediate",
"title": "Immediate"
},
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Routine",
"title": "Routine"
},
{
"value": "Default",
"title": "Default"
},
{
"value": "Executive Override",
"title": "Executive Override"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"blockedCallPercentage": {
"description": "This tag is only valid when value of enabledccenforcement is true",
"title": "Blocked Call Percentage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"callingLinePresentationBit": {
"description": " \n Cisco Unified Communications Manager uses calling line ID presentation (CLIP/CLIR) as a supplementary service to allow or restrict the originating caller phone number on a call-by-call basis. Choose whether you want the \n Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this route pattern. Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want \n Cisco Unified Communications Manager to allow the display of the calling number. Choose Restricted if you want \n Cisco Unified Communications Manager to block the display of the calling number. ",
"title": "Calling Line ID Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"calledPartyNumberingPlan": {
"description": " Choose the format for the numbering plan in called party directory numbers. \n Cisco Unified Communications Manager sets the called DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non national type number. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014Use when the \n Cisco Unified Communications Manager sets the Numbering Plan in the directory number. \n \n ISDN\u2014Use when you are dialing outside the dialing plan for your country. \n \n National Standard\u2014Use when you are dialing within the dialing plan for your country. \n \n Private\u2014Use when you are dialing within a private network. \n \n Unknown\u2014Use when the dialing plan is unknown. \n ",
"title": "Called Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"connectedNamePresentationBit": {
"description": " \n Cisco Unified Communications Manager uses connected name presentation (CONP/CONR) as a supplementary service to allow or restrict the called party name on a call-by-call basis. Choose whether you want \n Cisco Unified Communications Manager to allow or restrict the display of the connected party name on the calling party phone display for this route pattern. Choose Default if you do not want to change the connected name presentation. Choose Allowed if you want to display the connected party name. Choose Restricted if you want \n Cisco Unified Communications Manager to block the display of the connected party name. ",
"title": "Connected Name Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"description": {
"description": " Enter a description of the route pattern. The description can include up to 50 characters in any language, but it cannot include double-quotes (\"), percentage sign (%), ampersand (&), or angle brackets (<>). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"routeClass": {
"description": " Choose a route class setting for this translation pattern from the drop-down list box: \n \n \n \n Default \n \n Voice \n \n Data \n \n Satellite Avoidance \n \n Hotline voice \n \n Hotline data \n The route class is a DSN code that identifies the class of traffic for a call. The route class informs downstream devices about special routing or termination requirements. The Default setting uses the existing route class of the incoming call. You can use non-default route class settings to translate an inbound T1 CAS route class digit into a \n Cisco Unified Communications Manager route class value (and strip off the digit). You should not need to assign a non-default route class setting to any other inbound calls that use pattern configuration. If the route pattern points to a SIP trunk supporting G.Clear, then specify Data or Hotline as the Route Class. ",
"title": "Route Class",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Voice",
"title": "Voice"
},
{
"value": "Data",
"title": "Data"
},
{
"value": "Satellite Avoidance",
"title": "Satellite Avoidance"
},
{
"value": "Hotline Voice",
"title": "Hotline Voice"
},
{
"value": "Hotline Data",
"title": "Hotline Data"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingNamePresentationBit": {
"description": " \n Cisco Unified Communications Manager uses calling name presentation (CNIP/CNIR) as a supplementary service to allow or restrict the originating caller name on a call-by-call basis. Choose whether you want the \n Cisco Unified Communications Manager to allow or restrict the display of the calling party name on the called party phone display for this route pattern. Choose Default if you do not want to change calling name presentation. Choose Allowed if you want \n Cisco Unified Communications Manager to display the calling name information. Choose Restricted if you want \n Cisco Unified Communications Manager to block the display of the calling name information. ",
"title": "Calling Name Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"dialPlanName": {
"description": " Choose a numbering plan. ",
"title": "Numbering Plan",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/DialPlan",
"choices": []
},
"authorizationLevelRequired": {
"description": " Enter the authorization level for the route pattern. The number that you specify in this field determines the minimum authorization level that is needed to successfully route a call through this route pattern. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n To activate the authorization code, you must check the Require Forced Authorization Code. If you do not check the check box, a message displays when you insert the route pattern that indicates that the authorization code cannot be activated. To activate the code, click Cancel, check the Require Forced Authorization Code check box, and click Insert. To activate the code at a later time, click OK. \n \n \n ",
"title": "Authorization Level",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"digitDiscardInstructionName": {
"description": " From the Discard Digits drop-down list box, choose the discard digits instructions that you want to associate with this route pattern. The discard digits that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The called party transformation settings that are assigned to the route groups in a route list override any called party transformation settings that are assigned to a route pattern that is associated with that route list. \n \n \n ",
"title": "Discard Digits",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"resourcePriorityNamespaceName": {
"description": " Choose a Resource Priority Namespace Network Domain from the drop-down list box. To configure the Resource Priority Namespace Network Domains, choose System > MLPP > Namespace > Resource Priority Namespace Network Domain. ",
"title": "Resource Priority Namespace Network Domain",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "namespace",
"maxItems": 1,
"target": "/api/device/cucm/ResourcePriorityNamespace/choices/?field=namespace&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/ResourcePriorityNamespace",
"choices": []
},
"enableDccEnforcement": {
"description": " Check this check box to enable the Destination Code Control (DCC) feature. By enabling DCC, all calls other than flash and higher precedence calls made to the destination are filtered and allowed or disallowed based on the Call Blocking Percentage quota set for the destination. Flash and higher precedence calls are allowed at all times. DCC is disabled by default. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Apply Call Blocking Percentage field gets enabled only if the MLPP level is immediate, priority, routine or default. \n \n \n ",
"title": "Apply Call Blocking Percentage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"useCallingPartyPhoneMask": {
"description": " Check the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. You may also configure an External Phone Number Mask on all phone devices. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The calling party transformation settings that are assigned to the route groups in a route list override any calling party transformation settings that are assigned to a route pattern that is associated with that route list. \n \n \n ",
"title": "Use Calling Party's External Phone Number Mask",
"minItems": 1,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingPartyTransformationMask": {
"description": " Enter a transformation mask value. Valid entries for the National Numbering Plan include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place. ",
"title": "Calling Party Transform Mask",
"minItems": 0,
"pattern": "^[0-9*#+X]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"calledPartyNumberType": {
"description": " Choose the format for the number type in called party directory numbers. \n Cisco Unified Communications Manager sets the called directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the called directory number to be encoded to a non-national type numbering plan. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014Use when the \n Cisco Unified Communications Manager sets the directory number type. \n \n Unknown\u2014Use when the dialing plan is unknown. \n \n National\u2014Use when you are dialing within the dialing plan for your country. \n \n International\u2014Use when you are dialing outside the dialing plan for your country. \n \n Subscriber\u2014Use when you are dialing a subscriber by using a shortened subscriber number. \n ",
"title": "Called Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"authorizationCodeRequired": {
"description": " If you want to use forced authorization codes with this route pattern, check this check box. The FAC feature does not support overlap sending because the \n Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Allow Overlap Sending check box, the system disables the Require Forced Authorization Code check box. ",
"title": "Require Forced Authorization Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"routeFilterName": {
"description": " If your route pattern includes the @ wildcard, you may choose a route filter. The optional act of choosing a route filter restricts certain number patterns. The route filters that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. You can configure the number of items that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more route filters exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Route Filters window, then find and choose a route filter name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. \n \n \n ",
"title": "Route Filter",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"patternUrgency": {
"description": " If the dial plan contains overlapping route patterns, \n Cisco Unified Communications Manager does not route the call until the interdigit timer expires (even if dialing a sequence of digits to choose a current match is possible). Check this check box to interrupt interdigit timing when \n Cisco Unified Communications Manager must route a call immediately. ",
"title": "Urgent Priority",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"allowDeviceOverride": {
"description": " This check box remains unchecked by default. When the check box is checked, the system uses the Call Classification setting that is configured on the associated gateway or trunk to consider the outgoing call as OffNet or OnNet. ",
"title": "Allow Device Override",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"isEmergencyServiceNumber": {
"description": "Enable this route pattern to be used for Emergency Call handling. Emergency Call Handler helps you to manage emergency calls in your telephony network while following local ordinances and regulations. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This setting applies only to the Emergency Call Handler feature, and not to other external emergency calling solutions such as Cisco Emergency Responder. \n \n \n ",
"title": "Is Emergency Service Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"networkLocation": {
"title": "Call Classification",
"minItems": 1,
"required": true,
"choices": [
{
"value": "OnNet",
"title": "OnNet"
},
{
"value": "OffNet",
"title": "OffNet"
},
{
"value": "Use System Default",
"title": "Use System Default"
}
],
"default": "OnNet",
"maxItems": 1,
"type": "string"
},
"isdnNsfInfoElement": {
"title": "Isdn Nsf Info Element",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"cic": {
"description": " Enter the appropriate carrier identification code (0, 3, or 4 digits) in the Carrier Identification Code field. Carrier identification codes allow customers to reach the services of interexchange carriers. The following list shows examples of commonly used carrier identification codes: \n \n \n \n ATT\u20140288 \n \n Sprint\u20140333 \n \n WorldCom/MCI\u20140222 \n For a complete list of NANP carrier identification codes, visit the NANPA website. ",
"title": "Carrier Identification Code",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "cic"
},
"networkServiceProtocol": {
"description": " From the Network Service Protocol drop-down list box, choose the PRI protocol that matches the protocol of the terminating gateway. ",
"title": "Network Service Protocol",
"minItems": 1,
"required": true,
"choices": [
{
"value": "PRI 4ESS",
"title": "PRI 4ESS"
},
{
"value": "PRI 5E8",
"title": "PRI 5E8"
},
{
"value": "PRI 5E8 TELEOS",
"title": "PRI 5E8 TELEOS"
},
{
"value": "PRI 5E8 INTECOME",
"title": "PRI 5E8 INTECOME"
},
{
"value": "PRI 5E9",
"title": "PRI 5E9"
},
{
"value": "PRI DMS-100",
"title": "PRI DMS-100"
},
{
"value": "PRI DMS-250",
"title": "PRI DMS-250"
},
{
"value": "PRI EURO",
"title": "PRI EURO"
},
{
"value": "PRI NI2",
"title": "PRI NI2"
},
{
"value": "PRI AUSTRALIAN",
"title": "PRI AUSTRALIAN"
},
{
"value": "PRI 5E8 CUSTOM",
"title": "PRI 5E8 CUSTOM"
},
{
"value": "PRI ETSI SC",
"title": "PRI ETSI SC"
},
{
"value": "PRI NTT",
"title": "PRI NTT"
},
{
"value": "PRI ISO QSIG T1",
"title": "PRI ISO QSIG T1"
},
{
"value": "PRI ISO QSIG E1",
"title": "PRI ISO QSIG E1"
}
],
"maxItems": 1,
"type": "string",
"name": "networkServiceProtocol"
},
"paramValue": {
"description": " Enter the appropriate service parameter value. Valid entries include the digits 0 through 9. If a service parameter does not exist for the network service, \n Cisco Unified Communications Manager Administration disables this field. ",
"title": "Service Parameter Value",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "paramValue"
},
"networkService": {
"description": " From the Network Service Protocol drop-down list box, choose the PRI protocol that matches the protocol of the terminating gateway. ",
"title": "Network Service",
"minItems": 0,
"required": false,
"choices": [
{
"value": "ACCUNET Switched Digital Service",
"title": "ACCUNET Switched Digital Service"
},
{
"value": "Billing Number Only",
"title": "Billing Number Only"
},
{
"value": "Billing Number Preferred",
"title": "Billing Number Preferred"
},
{
"value": "Calling Party Number Only",
"title": "Calling Party Number Only"
},
{
"value": "Calling Party Number Preferred",
"title": "Calling Party Number Preferred"
},
{
"value": "Foreign Exchange",
"title": "Foreign Exchange"
},
{
"value": "Foreign Exchange Selection",
"title": "Foreign Exchange Selection"
},
{
"value": "International Long Distance Service",
"title": "International Long Distance Service"
},
{
"value": "InterLATAOUTWATS",
"title": "InterLATAOUTWATS"
},
{
"value": "IntraLATAOUTWATS",
"title": "IntraLATAOUTWATS"
},
{
"value": "Long Distance Service",
"title": "Long Distance Service"
},
{
"value": "MEGACOM Telecom Service",
"title": "MEGACOM Telecom Service"
},
{
"value": "National ISDN Banded OUTWATS",
"title": "National ISDN Banded OUTWATS"
},
{
"value": "National ISDN Unbanded OUTWATS",
"title": "National ISDN Unbanded OUTWATS"
},
{
"value": "OUTWATS Selection",
"title": "OUTWATS Selection"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Private Selection",
"title": "Private Selection"
},
{
"value": "Software Defined Network",
"title": "Software Defined Network"
},
{
"value": "Tie Trunk (Cut-through)",
"title": "Tie Trunk (Cut-through)"
},
{
"value": "Tie Trunk (Senderized)",
"title": "Tie Trunk (Senderized)"
},
{
"value": "Tie Trunk Selection (Cut-through)",
"title": "Tie Trunk Selection (Cut-through)"
},
{
"value": "Tie Trunk Selection (Senderized)",
"title": "Tie Trunk Selection (Senderized)"
},
{
"value": "WATS Band Selection",
"title": "WATS Band Selection"
},
{
"value": "WATS Maximal Subscribed Band",
"title": "WATS Maximal Subscribed Band"
}
],
"maxItems": 1,
"type": "string",
"name": "networkService"
}
}
},
"supportOverlapSending": {
"description": " With overlap sending enabled, when \n Cisco Unified Communications Manager passes a call to the PSTN, it relies on overlap sending in the PSTN to determine how many digits to collect and where to route the call. Check this check box for each route pattern that you consider to be assigned to a gateway or route list that routes the calls to a PSTN that supports overlap sending. The CMC and FAC features do not support overlap sending because the \n Cisco Unified Communications Manager cannot determine when to prompt the user for the code. If you check the Require Forced Authorization Code or the Require Client Matter Code check box, the system disables the Allow Overlap Sending check box. ",
"title": "Allow Overlap Sending",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
}
}
},
"minItems": 1
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsCCSvcREL/add/ |
|
The GUI Add form of relation/HcsCCSvcREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/HcsCCSvcREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsCCSvcREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsCCSvcREL/[pkid1]", "/api/relation/HcsCCSvcREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsCCSvcREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsCCSvcREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsCCSvcREL/export/ |
|
{ "hrefs":["/api/relation/HcsCCSvcREL/[pkid1]", "/api/relation/HcsCCSvcREL/[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 relation/HcsCCSvcREL and the JSON format can be used to import instances of relation/HcsCCSvcREL.
GET http://[host-proxy]/api/relation/HcsCCSvcREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsCCSvcREL | POST | /api/relation/HcsCCSvcREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsCCSvcREL/ |
|
The relation/HcsCCSvcREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsCCSvcREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "ccSvcName",
"direction": "asc",
"current": "/api/relation/HcsCCSvcREL/?skip=0&limit=3&order_by=ccSvcName&direction=asc&traversal=down"
},
"operations": [
"bulk_update",
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "relation/HcsCCSvcREL",
"summary_attrs": [
{
"name": "ccSvcName",
"title": "Contact Center Service Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsCCSvcREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsCCSvcREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsCCSvcREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsCCSvcREL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HcsCCSvcREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsCCSvcREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsCCSvcREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsCCSvcREL. | GET | /api/relation/HcsCCSvcREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsCCSvcREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsCCSvcREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsCCSvcREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsCCSvcREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsCCSvcREL/[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 relation/HcsCCSvcREL and the JSON format can be used to import instances of relation/HcsCCSvcREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsCCSvcREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsCCSvcREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsCCSvcREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsCCSvcREL. |