[Index]

Model: device/cucm/HuntPilot

Model Details

Title Description Details
Park Mon Forward No Retrieve
  • Field Name: parkMonForwardNoRetrieve
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Destination
  • Field Name: parkMonForwardNoRetrieve.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Use Personal Preferences
  • Field Name: parkMonForwardNoRetrieve.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
Calling Search Space No Retrieve External
  • Field Name: parkMonForwardNoRetrieve.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Transform Mask Enter a transformation mask value. Valid entries 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. Cisco Unified Communications Manager sends the dialed digits exactly as dialed.
  • Field Name: calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
ASCII Alerting Name Enter an alerting name for the hunt pilot in ASCII format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones.
  • Field Name: asciiAlertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 32
Prefix Digits Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. Note    The appended prefix digit does not affect which directory numbers route to the assigned device.
  • Field Name: callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Urgent Priority If the dial plan contains overlapping hunt lists, Cisco Unified Communications Manager would not route the call until the interdigit timer expires (even if it is possible to dial a sequence of digits to choose a current match). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately.
  • Field Name: patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
Connected Line ID Presentation 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 Cisco Unified Communications Manager to allow or restrict the display of the connected party phone number on the calling party phone display for this hunt pilot. 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 Cisco Unified Communications Manager to block the display of the connected party phone number. If a call that originates from an IP phone on your system 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. Default: Default
  • Field Name: connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Route Partition If you want to use a partition to restrict access to the hunt pilot, choose the desired partition from the drop-down list box. If you do not want to restrict access to the hunt pilot, 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. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters. Note    Make sure that the combination of hunt pilot, route filter, and partition is unique within the Cisco Unified Communications Manager cluster.
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Block this pattern Default: No Error
  • Field Name: releaseClause
  • Type: String
  • Cardinality: [0..1]
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Display Line Group Member DN as Connected Party Check this check box to display the directory number of the answering phone as the connected party when a call is routed through a hunt list. Uncheck this check box to display the hunt pilot number as the connected party when a call is routed through a hunt list.
  • Field Name: displayConnectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Description Enter a description of the hunt pilot. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
Calling Party Number Type Choose the format for the number type in calling party directory numbers. 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 your system 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: Cisco Unified Communications Manager—The Cisco Unified Communications Manager sets the directory number type. Unknown—The dialing plan is unknown. National—Use when you are dialing within the dialing plan for your country. International—Use when you are dialing outside the dialing plan for your country. Subscriber—Use when you are dialing a subscriber by using a shortened subscriber number. Default: Cisco CallManager
  • Field Name: callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Provide Outside Dial Tone Provide Outside Dial Tone indicates that Cisco Unified Communications Manager routes the calls off the local network. Check this check box for each hunt pilot that routes the call off the local network and provides outside dial tone to the calling device. To route the call in the network, leave the check box unchecked. Default: True
  • Field Name: provideOutsideDialtone
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Pickup Group Choose the number that can be dialed to answer calls to this directory number (in the specified partition). Note    The Call Pickup Group setting has been moved to this section from the Forward settings section.
  • Field Name: callPickupGroupName
  • Type: String
  • Cardinality: [0..1]
Hunt Pilot * Enter the hunt pilot, 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 +. Note    Ensure that the directory hunt pilot, which uses the chosen partition, route filter, and numbering plan combination, is unique. Check the hunt pilot, 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.
  • Field Name: pattern
  • Type: String
  • Cardinality: [1..1]
MLPP Precedence Choose an MLPP precedence setting for this hunt pilot from the drop-down list box: Executive Override—Highest precedence setting for MLPP calls. Flash Override—Second highest precedence setting for MLPP calls. Flash—Third highest precedence setting for MLPP calls. Immediate—Fourth highest precedence setting for MLPP calls. Priority—Fifth highest precedence setting for MLPP calls. Routine—Lowest precedence setting for MLPP calls. Default—Does not override the incoming precedence level but rather lets it pass unchanged. Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Prefix Digits Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. Note    The appended prefix digit does not affect which directory numbers route to the assigned device.
  • Field Name: prefixDigitsOut
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Maximum Hunt Timer Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
  • Field Name: maxHuntduration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Called Party Numbering Plan Choose the format for the numbering plan in called party directory numbers. 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 your system 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: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number. ISDN—Use when you are dialing outside the dialing plan for your country. National Standard—Use when you are dialing within the dialing plan for your country. Private—Use when you are dialing within a private network. Unknown—Use when the dialing plan is unknown. Default: Cisco CallManager
  • Field Name: calledPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Numbering Plan Choose a numbering plan.
  • Field Name: dialPlanName
  • Type: ["String", "Null"]
  • Target: device/cucm/DialPlan
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Alerting Name Enter an alerting name for the hunt pilot in UNICODE format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones.
  • Field Name: alertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Connected Name Presentation 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 your system to allow or restrict the display of the connected party name on the calling party phone display for this hunt pilot. 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 your system to block the display of the connected party name. Default: Default
  • Field Name: connectedNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Block this pattern If the checkbox is checked, then block this pattern. Also choose the required Release Clause. If the checkbox is unchecked, then Route this pattern.
  • Field Name: blockEnable
  • Type: Boolean
  • Cardinality: [1..1]
Calling Name Presentation 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 your system to allow or restrict the display of the calling party name on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling name presentation. Choose Allowed if you want your system to display the calling name information. Choose Restricted if you want your system to block the display of the calling name information. Default: Default
  • Field Name: callingNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Hunt List * Choose the hunt list for which you are adding a hunt pilot from the drop-down list box. After you choose a hunt list, click the Edit link to the right to edit the hunt list.
  • Field Name: huntListName
  • Type: String
  • Target: device/cucm/HuntList
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
External Number Mask Enter an external number mask value for the hunt pilot. Cisco Unified Communications Manager uses this mask to format calling line identification for external (outbound) calls. When AAR initiates a reroute, the system applies this external number mask to the hunt pilot number to form a fully qualified DN of the called party, which allows AAR to reroute properly in out-of-bandwidth conditions.
  • Field Name: e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Digit Discard Instruction Name
  • Field Name: digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Target: device/cucm/DiscardDigitInstruction
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Calling Party's External Phone Number Mask * 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. Note    The calling party transformation settings that are assigned to the line groups in a hunt list override any calling party transformation settings that are assigned to a hunt pilot that is associated with that hunt list. Default: Default
  • Field Name: useCallingPartyPhoneMask
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Party Transform Mask Enter a transformation mask value. Valid entries include the digits 0 through 9, the wildcard character 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.
  • Field Name: callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Called Party Number Type Choose the format for the number type in called party directory numbers. 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 your system 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: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the directory number type. Unknown—Use when the dialing plan is unknown. National—Use when you are dialing within the dialing plan for your country. International—Use when you are dialing outside the dialing plan for your country. Subscriber—Use when you are dialing a subscriber by using a shortened subscriber number. Default: Cisco CallManager
  • Field Name: calledPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Queue Calls
  • Field Name: queueCalls
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Maximum Number of Callers Allowed in Queue * Enter an integer value for the number of callers allowed in the queue for this hunt pilot. The default value is 32. The field range is from 1 to 100. When the maximum number of callers in queue has been reached, and if subsequent calls need to be disconnected, select the “Disconnect the call” radio button. When the maximum number of callers in queue has been reached, and if subsequent calls need to be routed to a secondary destination, select the “Route the call to this destination” radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the “Full Queue Calling Search Space” from the drop-down list (optional).
  • Field Name: queueCalls.maxCallersInQueue
  • Type: Integer
  • Cardinality: [1..1]
Full Queue Calling Search Space
  • Field Name: queueCalls.callingSearchSpacePilotQueueFull
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Hold MOH Source & Announcements
  • Field Name: queueCalls.networkHoldMohAudioSourceID
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
No Agent Destination
  • Field Name: queueCalls.noAgentDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
No hunt members logged in or registered Calling Search Space
  • Field Name: queueCalls.callingSearchSpaceNoAgent
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Queue Full Destination
  • Field Name: queueCalls.queueFullDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Maximum Wait Time Calling Search Space
  • Field Name: queueCalls.callingSearchSpaceMaxWaitTime
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Maximum Wait Time in Queue * Enter an integer value to set the maximum wait time, in seconds, in a queue. The default value is 900 seconds. The field range is from 10 to 3600 seconds. When the maximum wait time in queue has been reached, and if the queued caller needs to be disconnected, select the “Disconnect the call” radio button. When the maximum wait time in queue has been reached, and if the queued caller needs to be routed to a secondary destination, select the “Route the call to this destination” radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the “Maximum Wait Time Calling Search Space” from the drop-down list (optional).
  • Field Name: queueCalls.maxWaitTimeInQueue
  • Type: Integer
  • Cardinality: [1..1]
Max Wait Time Destination
  • Field Name: queueCalls.maxWaitTimeDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Route Filter If your hunt pilot 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. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters.
  • Field Name: routeFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/RouteFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Forward Hunt No Answer
  • Field Name: forwardHuntNoAnswer
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
CFNA Destination When a call that was routed via the hunt list is parked, the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter value is used (unless it is blank) to forward the parked call when the service parameter Park Monitoring Forward No Retrieve Timer expires. If the parameter value of the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter is blank, then the call will be forwarded to the destination configured in the Directory Number Configuration window when the Park Monitoring Forward No Retrieve Timer expires. Specify the following values: Destination—This setting specifies the directory number to which a parked call is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: forwardHuntNoAnswer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Personal Preferences
  • Field Name: forwardHuntNoAnswer.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CSS CFNA
  • Field Name: forwardHuntNoAnswer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Numbering Plan Choose the format for the numbering plan in calling party directory numbers. Cisco Unified Communications Manager sets the calling DN numbering plan. We recommend 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 your system 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: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number. ISDN—Use when you are dialing outside the dialing plan for your country. National Standard—Use when you are dialing within the dialing plan for your country. Private—Use when you are dialing within a private network. Unknown—Use when the dialing plan is unknown. Default: Cisco CallManager
  • Field Name: callingPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
AAR Group Choose an Automated Alternate Routing (AAR) group from the drop-down list box.
  • Field Name: aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Forward Hunt Busy
  • Field Name: forwardHuntBusy
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
CFB Destination
  • Field Name: forwardHuntBusy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Personal Preferences
  • Field Name: forwardHuntBusy.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CSS CFB
  • Field Name: forwardHuntBusy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Line ID Presentation 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 Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want your system to allow the display of the calling number. Choose Restricted if you want your system to block the display of the calling number. Default: Default
  • Field Name: callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
API reference for device/cucm/HuntPilot