[Index]

Model: relation/HuntGroupRelation

Hunt Groups

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

A hunt group is a combination of the following elements:

Element Description
Hunt Pilot A hunt pilot comprises a string of digits (an address) and a set of associated digit manipulations that route calls to a hunt list. Hunt pilots provide flexibility in network design. They work in conjunction with route filters and hunt lists to direct calls to specific devices and to include, exclude, or modify specific digit patterns.
Hunt List

A hunt list displays a set of line groups in a specific order, and then associates with one or more hunt pilots, and determines the order in which those line groups are accessed. The order defines the progress of the search for available directory numbers for incoming calls. A hunt list comprises a collection of directory numbers as defined by line groups.

A hunt list can contain only line groups. Each hunt list should have at least one line group. Each line group includes at least one directory number. A single line group can appear in multiple hunt lists.
Line Groups

Hunt groups provide a business context for the lines you choose as members of line groups. You will need to choose lines belonging to line groups, or any existing line groups that must be added to the hunt list members.

A line group allows you to define the order in which directory numbers are chosen. CUCM distributes a call to idle or available members of a line group based on a call distribution algorithm and on the Ring No Answer (RNA) Reversion Timeout setting.

The hunt pilot, hunt list, and line group combination are automatically associated via unique identifiers for the following:

Searches can be performed on any of the details of the hunt pilot.

The site defaults auto-populates some values for hunt groups. To view or update the defaults, go to (default menus) Site Management > Defaults, choose a site to view its defaults, and locate the Default CUCM Hunt Pilot Partition field on the General Defaults tab. See Modify Site Defaults

Related Topics

Add a Hunt Group

This procedure adds a hunt group in VOSS Automate and Cisco Unified Call Manager (CUCM).

Note

When adding a hunt group, you will specify the parameters of the hunt pilot and the hunt list, and choose one or more new or existing line groups.

If your administrator has enabled number inventory, you can choose the hunt pilot pattern from a list of available numbers. If number inventory is disabled, you will need to specify a hunt pilot pattern, or choose from a limited selection of available numbers.

To allow the successful use of call forwarding in a hunt pilot, clear the defaults for Max Callers In Queue (32) and the default for Max Wait Time In Queue (900). To use queuing instead of call forwarding, change the default values, for example, to 33 and 901.

To add a hunt group:

  1. Log in as site administrator or higher.

  2. Choose the hierarchy (if necessary) where you want to add the hunt group.

    Note

    Hunt groups can be configured at the customer level or at site level.

  3. Go to (default menus) Subscriber Management > Hunt Groups.

  4. On the Hunt Groups list view, click Add.

  5. Choose a network device list (NDL).

    Note

    For hunt groups configured at the customer level:

    • Choose a NDL that identifies the CUCM where the hunt group is defined.
    • The system supports adding duplicate hunt groups (two hunt groups with the same hunt list name), provided multi-cluster CUCM is configured and you choose a different NDL. The second hunt group and hunt list are added to the second CUCM.

  6. On the Hunt Groups/New Record page, fill out at least the required fields.

  7. Click Save.

    A workflow is triggered to add the new hunt group:

Configure a New Hunt Group

This section describes the configuration options when adding a hunt group. You will need to configure the following sections of the Hunt Groups/New Record page:

Configure Pattern Definition

For hunt groups configured at the customer level, define a unique hunt pilot pattern. The hunt pilot pattern is added to the customer-level DN inventory and is marked as in-use and unavailable.

Field Description
Hunt Pilot Pattern

Specify a hunt pilot pattern, or choose one from the the drop-down.

A hunt pilot pattern can include numbers and wildcards (no spaces). wildcards (no spaces). For example, for NANP, enter 9.@ for typical local access, or 8XXX for a typical private network numbering plan. Valid characters include uppercase characters A, B, C, D, and + (representing the international escape character +). Ensure that the directory hunt pilot, which uses the chosen partition, route filter, and numbering plan combination, is unique.
Route Partition Choose a route partition from the list if you want to use a partition to restrict access to the hunt pilot, else, leave the field blank.
Route Filter If your hunt pilot includes the '@' wildcard, choose a route filter from the drop-down. Route filters restrict some number patterns. The numbering plan you choose determines the route filters you can choose from.
Hunt List Add the hunt list name to the Name field in the Hunt List section to auto-populate this field.
Call Pickup Group

Choose a call pickup group to associate with this hunt group.

Choose a call pickup group at the same hierarchy as this hunt group or if no call pickup groups are available at this hierarchy, choose a call pickup group at the hierarchy directly above.

Call pickup group is the number that can be dialed to answer calls to this directory number (in the partition)
Alerting Name

Specify an alerting name for the hunt pilot in UNICODE format.

This name is displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. Phone users can use this information to answer the call This name also displays on the calling phone.

If you don't enter a name, the hunt pilot DN displays on the phones.
Provide Outside Dial Tone Enable for each hunt pilot that routes the call off the local network and provides outside dial tone to the calling device. Disable if you want to route the call in the network.

Configure Forward Hunt No Answer

  1. At Forward Hunt No Answer Action, choose the hunt call treatment action setting.

    • Choosing Forward Unanswered Calls to Destination enables these fields:

      CFNA Destination Defines the directory number where calls are to be forwarded.
      CSS CFNA Applies to all devices using this directory number. The drop-down displays all CSSs in the system. The default is the default line CSS of the site.

    • Choose Use Forward Settings of Device that Forwarded to Hunt Pilot to use the call forwarding settings of the line group member.

  2. At Maximum Hunt Timer, specify the maximum time for hunting without queueing.

    Note

    Do not use the same value for this field and for the RNA Reversion Timeout field in the associated line group.

Configure Forward Hunt Busy

At Forward Hunt Busy Action, choose the hunt call treatment action setting.

Configure Queueing

At Queueing, define whether to queue calls. Selecting this checkbox disables Forward Hunt Groups, and displays additional configuration options.

Note

These mandatory fields are auto-populated with default values:

Configure Hunt List

Field Description
Name Maximum of 50 alphanumeric characters, and can contain combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each hunt list name is unique to the route plan. it is recommended that you use short, descriptive names for your hunt lists. The CompanynameLocationCalltype format provides enough detail and is short enough so you can easily identify a hunt list.
Cisco Unified Communications Manager Group Choose a CUCM group from the list. The hunt list registers to the first node in the CUCM group. Choosing a CUCM with only one node configured triggers a system warning, so choose a group with more than one node.
Enable this Hunt List Defines whether to enable your hunt list as soon as you save. No system reset is required.
For Voice Mail Usage Define whether to use this hunt list for voicemail. Enabling this setting allows the route list control process to keep a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one.

Configure Line Groups

Although you can configure an empty line group with no members (directory numbers), CUCM does not support this configuration for routing calls. If the line group contains no members, the hunt list stops hunting when the call gets routed to the empty line group. To avoid this scenario, ensure you configure at least one member in the line group.

You must define one or more directory numbers before configuring a line group. You can remove members from the line group after you configure or update the line group.

Note

For hunt groups configured at the customer-level, include lines defined at the customer level, and at any site within the customer.

Field Description
Line Group Name

The drop-down displays all line groups available at the site. You can choose a line group from the list or enter a name for the line group in the field.

Names you add can be up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each line group name is unique to the route plan.

It is recommended that you use a short, descriptive name for your line groups. The CompanynameLocationGroup format usually provides a sufficient level of detail, and is short enough to be easily identified.
RNA Reversion Timeout

Specify a time, in seconds, after which CUCM will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered, and if the following option is chosen for Hunt Options No Answer: Try next number; then try next group in Hunt List

The RNA Reversion Timeout applies at the line-group level to all members.
Hunt Options No Answer Choose a hunt option for CUCM to use if a call is distributed to a member of a line group that does not answer. This option is applied at the member level.
Automatically Logout Hunt Member on No Answer Defines whether line members are automatically logged off the hunt list. Line members can log back in using the "HLOG" softkey or PLK.
Hunt Options Busy Choose a hunt option for CUCM to use if a call is distributed to a member of a line group that is busy.
Hunt Options Not Available Choose a hunt option for CUCM to use if a call is distributed to an unavailable line group member. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in.

Configure Line Group Members

To configure line group members:

Edit a Hunt Group

It is possible to edit hunt groups, for example, to add or delete line groups, or to add or delete line group members.

When modifying a hunt group, the following workflow is executed (depending on the changes you made):

Delete a Hunt Group

When deleting a hunt group, the following workflow is executed:

Relation for Hunt Group elements (including Pilot, List)

Model Details: relation/HuntGroupRelation

Title Description Details
Pattern Definition Group Assigned by FDP
  • Field Name: Pattern Definition
  • Type: Object
Hunt Pilot Pattern * Enter the Hunt Pilot 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 +. 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 Definition.pattern
  • Type: String
  • Cardinality: [1..1]
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. All route partitions in the Unified CM are provided in the drop-down. The default value is the default line partition of the site.
  • Field Name: Pattern Definition.routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fQp2jkHXau3LGvo0%24uQ2YXY7hmybucqbYqw0E6alXiR9SUYfnFbB4Ifei3a8n45z8j5ZhMeluJPY3ZCxAMMTegI2NPhg5LSE19HAT95RRC32%2B9A5l6pwRR110hkNCCOvJWM0KuzDjps1LixHhQfGHnytJ8xWHwfC4lKevfwbGLHQaBIqBO0x0SGXNPPYOxS%2By3TmTFi1eaUVNdf1fYjpG93zUtgNBPp5dSZWTi4GB6O/KNR0hPbPPKTrXDpoSt8Xg2WrGCQ1akbyxgyE0JWAplpMNafcspPa8w4AJwMZsSy/G1gdphnXHgSu4mERT1n8xxK%2B3l8NhwSSSMQrkuOcoiF%2BMsMPoHtYPNF5DZuIw%2BSPfk%2BQugD2L8ENF9HygNF9F0u74dII/JAl/cC8KutLuzrVwSmLhTA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Pattern Definition.description
  • Type: String
  • Cardinality: [0..1]
Numbering Plan Choose a numbering plan.
  • Field Name: Pattern Definition.dialPlanName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24nYWmOWShjQIT68lU%24BmMmp%2BNyqp9jPfZfDGX41KLuE5W90GwQwoDW6785J4kGBWdHQEShkfhcR4V9k7u234J5kMqWtEXXXBt8PNj0OFX%2BZic9KsyBghuBWIExBmMuAuvoY6qGC2ISZGx7MmKmhUbXpgb7afkexZJM5ezUGPB8dzAbMAobbf%2BIVBDML5YecCE5PoU/O4oP2r98kPVbgunYjfr42KrWfHHIhdDBTyW5/K8TzAaN6yLBRfI/aYNy9WmJg%2BTCg69wJoBLhKaNmXozb7FUnFKAqxv2YuQOeuy51xT61VKt8x1F3Yu4%2BYVqYsNA%2BZ42bNh3tvYBMeRFTWOn6d2iMZ%2Byoq6mu7ocVjDP8q3aDxGFDwR6G/zvPBzolUo%2BylEqWDN1VGbUpzoCZgfuxw%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/DialPlan
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Pattern Definition.routeFilterName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RouteFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24jr0qK6AzG0nBYlvV%24im2gKxtklLawgWpMQXNdSMvgc8/qg41BzcY9AdBxEBzAfotYkivYW%2BmXVVXXLAuIghRoiqjkn4g8goismZzgLlI1D%2BVbK1BfY8RcgA4oK/urMO/4zU56sA0Ult8lqrdCJW2yX18N6%2BV3nRvVKVc4hvcrFXLE20wEwyQy1t4yx8ZGN%2BVdGthjXlQ9oZLIESOkLSAj86s4O/7v0HOjksAjocsxdsp43Vn2hNtl1wDq74JhNLAxU5ueErd9/ofPGhJ/Y9q84aRShnepQTRQV%2BoBFfk%2BLybmPHhQSKC0QOYphDPkSlzWZ25FncFcGzQqKIZG2pKdsnOU49eQHupZMHOkcmiUtLZZtSnMjqHyHRUDOy85kh3Pb/0TAmA89cnCvsHszzjnM8LtJQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RouteFilter
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Pattern Definition.patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Hunt List * The value is automatically populated with the hunt list name entered on the 'Hunt List' tab.
  • Field Name: Pattern Definition.huntListName
  • Type: String
  • Target: /api/device/cucm/HuntList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fhQVDuEw8YjVuQCN%2445hWCojveoByfeENuojBXYsqiLvlaQHcxHGAIdbhfjPSiLeg9JePUHF4PPXaodaRqsL1ubmffeovAMhFXXpXlMGLiTZyVeOFyGU/HqtkZ5a61Lnx1ChUxb7e7OQvFEzG%2Bss68yjwE31K/LLLTifCUjor0ZZNP9J7bt2Cr8unXzCdHHtJ5zM1ilSaZlOlroIUAMPEY%2B2cSnuYExGvRMRPqO%2BaeAVmsUAgA4N4Va/xlZnCeIf6zmQVLqHQCwf5Xxl1vyhQ25vZ5BE%2BwbQsmd8oJwZHwALrPD6C5aJOyZ/29Ysd9KchR5nAKmPo8%2BlM6iW7hbEu739Nf7cbRGuatIrm7s9LbjBiowIOlFATVnrMbCik6qT5VXzxPdrkD8dAWVvNvniQ2A%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/HuntList
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
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: Pattern Definition.callPickupGroupName
  • Type: String
  • Cardinality: [0..1]
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: Pattern Definition.alertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
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: Pattern Definition.asciiAlertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 32
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: Pattern Definition.blockEnable
  • Type: Boolean
  • Cardinality: [1..1]
Release Clause Replaces the 'Route this pattern' and 'Block this pattern' radio buttons in Unified CM. Default: No Error
  • Field Name: Pattern Definition.releaseClause
  • Type: String
  • Cardinality: [0..1]
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
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: Pattern Definition.provideOutsideDialtone
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
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: Pattern Definition.patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
Forward Hunt No Answer Group Assigned by FDP
  • Field Name: Forward Hunt No Answer
  • Type: Object
Forward Hunt No Answer Action
  • Field Name: Forward Hunt No Answer.cfna_action
  • Type: String
  • Choices: ["Do Not Forward Unanswered Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Unanswered Calls to Destination"]
Hf
  • Field Name: HF
  • Type: Object
Forward Hunt No Answer Action
  • Field Name: Forward Hunt No Answer.HF.cfna_action
  • Type: String
  • Choices: ["Do Not Forward Unanswered Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Unanswered Calls to Destination"]
Use Forward Settings of Device that Forwarded to Hunt Pilot Use Forward Settings of Line Group Member
  • Field Name: Forward Hunt No Answer.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
Forward Hunt No Answer
  • Field Name: forwardHuntNoAnswer
  • Type: ["Object", "Null"]
Use Forward Settings of Device that Forwarded to Hunt Pilot Use Forward Settings of Line Group Member
  • Field Name: Forward Hunt No Answer.forwardHuntNoAnswer.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CFNA Destination This setting indicates the directory number to which calls are forwarded.
  • Field Name: Forward Hunt No Answer.forwardHuntNoAnswer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFNA This drop-down lists all the CSSs on the system. The default is the default line CSS of the site.
  • Field Name: Forward Hunt No Answer.forwardHuntNoAnswer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
CFNA Destination This setting indicates the directory number to which calls are forwarded.
  • Field Name: Forward Hunt No Answer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFNA This drop-down lists all the CSSs on the system. The default is the default line CSS of the site.
  • Field Name: Forward Hunt No Answer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Maximum Hunt Timer Enter a value (in seconds) that specifies the maximum time for hunting without queuing. Valid values specify 1 to 3600. The default value specifies 1800 seconds (30 minutes).
  • Field Name: Forward Hunt No Answer.maxHuntduration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Forward Hunt Busy Group Assigned by FDP
  • Field Name: Forward Hunt Busy
  • Type: Object
Forward Hunt Busy Action
  • Field Name: Forward Hunt Busy.cfb_action
  • Type: String
  • Choices: ["Do Not Forward Busy Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Busy Calls to Destination"]
Hf
  • Field Name: HF
  • Type: Object
Forward Hunt Busy Action
  • Field Name: Forward Hunt Busy.HF.cfb_action
  • Type: String
  • Choices: ["Do Not Forward Busy Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Busy Calls to Destination"]
Use Forward Settings of Device that Forwarded to Hunt Pilot Use Forward Settings of Line Group Member
  • Field Name: Forward Hunt Busy.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
Forward Hunt Busy This drop-down lists all the CSSs on the system. The default is the default line CSS of the site.
  • Field Name: forwardHuntBusy
  • Type: ["Object", "Null"]
Use Forward Settings of Device that Forwarded to Hunt Pilot Use Forward Settings of Line Group Member
  • Field Name: Forward Hunt Busy.forwardHuntBusy.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CFB Destination This setting indicates the directory number to which calls are forwarded.
  • Field Name: Forward Hunt Busy.forwardHuntBusy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFB This drop-down lists all the CSSs on the system. The default is the default line CSS of the site.
  • Field Name: Forward Hunt Busy.forwardHuntBusy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
CFB Destination This setting indicates the directory number to which calls are forwarded.
  • Field Name: Forward Hunt Busy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFB This drop-down lists all the CSSs on the system. The default is the default line CSS of the site.
  • Field Name: Forward Hunt Busy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Queueing Group Assigned by FDP
  • Field Name: Queueing
  • Type: Object
Queue Calls
  • Field Name: Queueing.queue_calls_checkbox
  • Type: Boolean
Hf
  • Field Name: HF
  • Type: Object
Queue Calls
  • Field Name: Queueing.HF.queue_calls_checkbox
  • Type: Boolean
Network Hold MOH Source & Announcements Choose a Music On Hold (MoH) source from the drop-down list box, which will be used to play announcements and provide queue hold treatments. The default value is NULL. If nothing is selected, the default Network Hold MoH/MoH Source and Announcements configured on service parameter is used. The MoH source can be configured as unicast or multicast. Caller side's MRGL takes precedence for multicast or unicast. The MoH source announcement locale is used to determine the language used for the announcement. Only one type of language announcement can be played per hunt pilot. When any of the MoH settings are changed, the existing callers in queue are not affected. All future queued callers will listen to MoH and announcements as per the updated settings.
  • Field Name: Queueing.networkHoldMohAudioSourceID
  • Type: ["String", "Null", "Integer"]
  • Target: /api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24rBJtWcNtiBO3yOLH%24qj0EXwG4fHGBL/hrc%2Br8b8rbm6q1fGsXk16BcY3OmkUS4IqM6RSCeI2Fno6pkVVnFqDm8DlF1gRGBqIvcUDa8wreAcZ9EIKASUoslPCO/Yxwm5sKp4JxxeRTEpQDgCMPDWEFI6ys60SbuQEVjB2hcENSZoYXd4XD5YBv0%2BcD/BVJrJpubagj2gXxaTKAe6SKNBUfhpCgWyQfCP8cK38aJBkqo0orJV6NPbg3rca4db0BERguCd4ZEH7fJ7aWvyLUb3mTt7GR1G6pfAXZZmK59Dy8yvhkeTr39uzk4pnD3UAkX9Vjr2qiqlQKC9OsHIdquTJuuykusBDonFU3vrU3AKh612L5L%2BZ5FXwCF1MVHIyp1mRRlZWkQi3Kz/leDSFsytFVMzdCQ84d9GXJZ9Q%3D%24%3D%3D
  • Target attr: sourceId
  • Target Model Type: device/cucm/MohAudioSource
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Queueing Forward Hunt No Answer or Forward Hunt Busy settings are designed to move calls through the route list. Queuing, on the other hand, is used to hold callers in a route list. Therefore, if queuing is enabled, both Forward Hunt No Answer and Forward Hunt Busy are automatically disabled. Conversely, if Forward Hunt No Answer or Forward Hunt Busy are enabled, queuing is automatically disabled.
  • Field Name: queueCalls
  • Type: ["Object", "Null"]
Network Hold MOH Source & Announcements Choose a Music On Hold (MoH) source from the drop-down list box, which will be used to play announcements and provide queue hold treatments. The default value is NULL. If nothing is selected, the default Network Hold MoH/MoH Source and Announcements configured on service parameter is used. The MoH source can be configured as unicast or multicast. Caller side's MRGL takes precedence for multicast or unicast. The MoH source announcement locale is used to determine the language used for the announcement. Only one type of language announcement can be played per hunt pilot. When any of the MoH settings are changed, the existing callers in queue are not affected. All future queued callers will listen to MoH and announcements as per the updated settings.
  • Field Name: Queueing.queueCalls.networkHoldMohAudioSourceID
  • Type: ["String", "Null", "Integer"]
  • Target: /api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24rBJtWcNtiBO3yOLH%24qj0EXwG4fHGBL/hrc%2Br8b8rbm6q1fGsXk16BcY3OmkUS4IqM6RSCeI2Fno6pkVVnFqDm8DlF1gRGBqIvcUDa8wreAcZ9EIKASUoslPCO/Yxwm5sKp4JxxeRTEpQDgCMPDWEFI6ys60SbuQEVjB2hcENSZoYXd4XD5YBv0%2BcD/BVJrJpubagj2gXxaTKAe6SKNBUfhpCgWyQfCP8cK38aJBkqo0orJV6NPbg3rca4db0BERguCd4ZEH7fJ7aWvyLUb3mTt7GR1G6pfAXZZmK59Dy8yvhkeTr39uzk4pnD3UAkX9Vjr2qiqlQKC9OsHIdquTJuuykusBDonFU3vrU3AKh612L5L%2BZ5FXwCF1MVHIyp1mRRlZWkQi3Kz/leDSFsytFVMzdCQ84d9GXJZ9Q%3D%24%3D%3D
  • Target attr: sourceId
  • Target Model Type: device/cucm/MohAudioSource
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Queueing.queueCalls.maxCallersInQueue
  • Type: Integer
  • Cardinality: [1..1]
Queue Full Destination When the maximum number of callers in queue has been reached, and if subsequent calls need to be routed to a secondary destination then configure this field. Calls are disconnected if the destination field is not configured.
  • Field Name: Queueing.queueCalls.queueFullDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Full Queue Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Queue Full Destination is configured.
  • Field Name: Queueing.queueCalls.callingSearchSpacePilotQueueFull
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Queueing.queueCalls.maxWaitTimeInQueue
  • Type: Integer
  • Cardinality: [1..1]
Max Wait Time Destination When the maximum wait time in queue has been reached, and if the queued caller needs to be routed to a secondary destination configured then configure this field. Calls are disconnected if the destination field is not configured.
  • Field Name: Queueing.queueCalls.maxWaitTimeDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Max Wait Time Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Max Wait Time Destination is configured.
  • Field Name: Queueing.queueCalls.callingSearchSpaceMaxWaitTime
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
No Hunt Members Answer/Available Destination When no line members are logged in or registered at the time of an incoming call, and if that call needs to be routed to a secondary destination then configure this field.
  • Field Name: Queueing.queueCalls.noAgentDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
No Hunt Members Answer/Available Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the No Hunt Members Answer/Available Destination is configured.
  • Field Name: Queueing.queueCalls.callingSearchSpaceNoAgent
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Queueing.maxCallersInQueue
  • Type: Integer
  • Cardinality: [1..1]
Queue Full Destination When the maximum number of callers in queue has been reached, and if subsequent calls need to be routed to a secondary destination then configure this field. Calls are disconnected if the destination field is not configured.
  • Field Name: Queueing.queueFullDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Full Queue Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Queue Full Destination is configured.
  • Field Name: Queueing.callingSearchSpacePilotQueueFull
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Queueing.maxWaitTimeInQueue
  • Type: Integer
  • Cardinality: [1..1]
Max Wait Time Destination When the maximum wait time in queue has been reached, and if the queued caller needs to be routed to a secondary destination configured then configure this field. Calls are disconnected if the destination field is not configured.
  • Field Name: Queueing.maxWaitTimeDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Max Wait Time Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Max Wait Time Destination is configured.
  • Field Name: Queueing.callingSearchSpaceMaxWaitTime
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
No Hunt Members Answer/Available Destination When no line members are logged in or registered at the time of an incoming call, and if that call needs to be routed to a secondary destination then configure this field.
  • Field Name: Queueing.noAgentDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
No Hunt Members Answer/Available Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the No Hunt Members Answer/Available Destination is configured.
  • Field Name: Queueing.callingSearchSpaceNoAgent
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Park Monitoring Group Assigned by FDP
  • Field Name: Park Monitoring
  • Type: Object
Park Monitoring Forward No Retrieve 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.
  • Field Name: Park Monitoring.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Park Monitoring
  • Field Name: parkMonForwardNoRetrieve
  • Type: ["Object", "Null"]
Park Monitoring Forward No Retrieve 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.
  • Field Name: Park Monitoring.parkMonForwardNoRetrieve.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Park Monitoring Forward No Retrieve Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Park Monitoring Forward No Retrieve Destination is configured.
  • Field Name: Park Monitoring.parkMonForwardNoRetrieve.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Park Monitoring Forward No Retrieve Calling Search Space This drop-down lists all the CSSs on the system. This CSS is used when the Park Monitoring Forward No Retrieve Destination is configured.
  • Field Name: Park Monitoring.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24c5YXD8dTmAYxQrxO%24uhDmJc08jbLpI2YeTYDPG9GdWUWQEiqU0%2BuRwRAaF9QqA98mdzXTnMCQEbtteq9s54RyPiT0bekxUmd5I/b5B%2BbJnNgHsXf7fZtBj7IpZS4MqthAq96ZbVRo6/FDaYLXJqdSk7HAccKDsxcwJvgHuT9PcFWO1ze3EglRjwOX2ZW0BAhpPdf8N4sr%2B9dyPTfSldYzntdBoKei657xHnjRZ7efky%2BzodzPQCKym7K7/trUl/xnpfycXOt2FEmjxUM/Z/Okdeqtga%2BWZr3eUUKbx0ZTlc2VWjE3LhuXQc6IHmFuNAmfkmCdsxOAHdnlTFyffPsV/XaTBpeiUGB/sWFZq6x5NSIUe/DWw4EKHf0zhmJ3fRCblnlurCCMmlQ9cu0%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Calling Party Transformations Group Assigned by FDP
  • Field Name: Calling Party Transformations
  • Type: Object
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: Calling Party Transformations.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: Calling Party Transformations.callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
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: Calling Party Transformations.callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
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: Calling Party Transformations.callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
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: Calling Party Transformations.callingNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
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: Calling Party Transformations.callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
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: Calling Party Transformations.callingPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Connected Party Transformations Group Assigned by FDP
  • Field Name: Connected Party Transformations
  • Type: Object
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: Connected Party Transformations.connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
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: Connected Party Transformations.displayConnectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
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: Connected Party Transformations.connectedNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Called Party Transformations Group Assigned by FDP
  • Field Name: Called Party Transformations
  • Type: Object
Discard Digits Select the discard digits instructions that you want to associate with this hunt pilot. The discard digits that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box.
  • Field Name: Called Party Transformations.digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/DiscardDigitInstruction/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fnoM7AvwhdQeD2fB%24tLmttrG%2Bw%2B9eougpTALTYfMh6UylXr49fU3uVkRifJZXFXUcfoFdBZqQSsYkPBVhTNBlOzQ1Je4JUjdtSeFE9OMiu8amZ5QkZwv5wGPKTXET8FCtrWIzNfyj00jC/WSP/5458ywz%2BACQKDYtx7q14oifk/OrIxcCqZLmsJjZyAshfSd1Am/i6QgMKGMrTlPO246ur/LjtXOeFZrPP%2BQuSL3HmmstRrR%2BX5/fhV%2Bk6c0kJA8FDvCVRkC4V4Bv7E0sB75krdbX/cMCWA/wIMf0GIJHwBxyhwFyqMe1iXCJOVnGFxeHxPVMfDNlJPYfMVmaAGt4R5FMuJ/%2BetVDrsz%2BmZYduH1imSuyxaBSqKkx0wugLGGS1mOwWJLquT0tfkEjUdopekwopeQ7FHFBIrX/eMCMpg%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/DiscardDigitInstruction
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
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: Called Party Transformations.calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Called Party 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: Called Party Transformations.prefixDigitsOut
  • 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: Called Party Transformations.calledPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
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: Called Party Transformations.calledPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
AAR Group Settings Group Assigned by FDP
  • Field Name: AAR Group Settings
  • Type: Object
AAR Group Choose an Automated Alternate Routing (AAR) group from the drop-down list box.
  • Field Name: AAR Group Settings.aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24iIPBjmGSLXXNmhx8%24dgXvcPOamUgopfmZE5UDxEatzHRWot8/SAenFoKYxSvbgg92cacaF5fiyX/hIft3ci8qmrSmq2X8vnbsNTqtw0kQS5U2dwGI2R3H9V51uLN1IwxYV0dyy3bpcy2jeF2G8YTOfMtrT9OMAl7%2BDoQcN/iTgZtP%2BF4DE6R7P2nIEhR%2ByDCz8lmvvsunBFRyMDe4%2BCeHv98RVsxCc5VEMeWNL5z%2BMIyxwDK907hM30C5PiPzeVl6BF75nnim0k8RQknA3Lp2MO4Bd6MihgvL8S1zS2jbQU%2BeVqkqp4Sm06o3kbnRE74flA7cawpcB9Of5L4m8gO87Binzw5Mg7DuXCxmKaFvAH9u3lZRxx3CIdPYyDML3oSo1MenM9CMpeB7%2BMvTLimAkQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/AarGroup
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
External Number Mask Unified CM 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: AAR Group Settings.e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Hunt List Group Assigned by FDP
  • Field Name: Hunt List
  • Type: Object
Name * A name for the Hunt List. This name is used to populate the Hunt List Name field on the 'Hunt Pilot' tab.
  • Field Name: Hunt List.name
  • Type: String
  • Cardinality: [1..1]
Hunt List
  • Field Name: HuntList
  • Type: Object
Name * A name for the Hunt List. This name is used to populate the Hunt List Name field on the 'Hunt Pilot' tab.
  • Field Name: Hunt List.HuntList.name
  • Type: String
  • Cardinality: [1..1]
Description Enter a description to help you identify further details about the hunt list that do not fit into the name.
  • Field Name: Hunt List.HuntList.description
  • Type: String
  • Cardinality: [0..1]
Cisco Unified Communications Manager Group * The default is Default.
  • Field Name: Hunt List.HuntList.callManagerGroupName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/CallManagerGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UzSfKk11znWJp426%24Z99T0ePTxfw5/cRJ7Y%2BtgRWH7sr9DQPpA8h1UYNT9Bm33pBom220dctmlXye3sAVJXijGSjLLgGMP8KySJl4BOO13n/F%2B45%2BIBEXEA%2BgJarLbaKkbgYg9eT9iAJYJKJSwm0YTBPyUsZbBayLhGs8nwFWWz6qNnEQS6MWFK2NG4wrRDW9zCqFkP645jD2onwdLEkEINylPImqxadUK7rhZDnd3AERcTOztymfYCwC3B2RYmgC8%2BR8oLujw6cnkrQub6strYCrQd4RsCpgMuJzJkEbmuaGbSFlmA5AGfoE4ME3k5EOt7JnYE3DLX8q6HHLvmS70RSpQWyTtcV7HBjtPusndZgVTpcDughczzYZ%2BV0uY7igPxcilfNErKOet%2BNRdAO%2B%2BZ%2BF5oIN/Xc%2B%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/CallManagerGroup
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Enable this Hunt List Enabled (checked) by default.
  • Field Name: Hunt List.HuntList.routeListEnabled
  • Type: Boolean
  • Cardinality: [0..1]
For Voice Mail Usage If this hunt list is to be used for voicemail, check this check box. If you this check box, the route list control process keeps a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one.
  • Field Name: Hunt List.HuntList.voiceMailUsage
  • Type: Boolean
  • Cardinality: [0..1]
Description Enter a description to help you identify further details about the hunt list that do not fit into the name.
  • Field Name: Hunt List.description
  • Type: String
  • Cardinality: [0..1]
Cisco Unified Communications Manager Group * The default is Default.
  • Field Name: Hunt List.callManagerGroupName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/CallManagerGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UzSfKk11znWJp426%24Z99T0ePTxfw5/cRJ7Y%2BtgRWH7sr9DQPpA8h1UYNT9Bm33pBom220dctmlXye3sAVJXijGSjLLgGMP8KySJl4BOO13n/F%2B45%2BIBEXEA%2BgJarLbaKkbgYg9eT9iAJYJKJSwm0YTBPyUsZbBayLhGs8nwFWWz6qNnEQS6MWFK2NG4wrRDW9zCqFkP645jD2onwdLEkEINylPImqxadUK7rhZDnd3AERcTOztymfYCwC3B2RYmgC8%2BR8oLujw6cnkrQub6strYCrQd4RsCpgMuJzJkEbmuaGbSFlmA5AGfoE4ME3k5EOt7JnYE3DLX8q6HHLvmS70RSpQWyTtcV7HBjtPusndZgVTpcDughczzYZ%2BV0uY7igPxcilfNErKOet%2BNRdAO%2B%2BZ%2BF5oIN/Xc%2B%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/CallManagerGroup
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Enable this Hunt List Enabled (checked) by default.
  • Field Name: Hunt List.routeListEnabled
  • Type: Boolean
  • Cardinality: [0..1]
For Voice Mail Usage If this hunt list is to be used for voicemail, check this check box. If you this check box, the route list control process keeps a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one.
  • Field Name: Hunt List.voiceMailUsage
  • Type: Boolean
  • Cardinality: [0..1]
Line Groups Group Assigned by FDP
  • Field Name: Line Groups
  • Type: Object
Line Group
  • Field Name: LineGroup.[n]
  • Type: Array
Line Group Name * A name for the Line Group.
  • Field Name: Line Groups.LineGroup.[n].name
  • Type: String
  • Cardinality: [1..1]
RNA Reversion Timeout * Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, Try next member; then, try next group in Hunt List, is chosen. The RNA Reversion Timeout applies at the line-group level to all members. Default: 10
  • Field Name: Line Groups.LineGroup.[n].rnaReversionTimeOut
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 10
Distribution Algorithm * Choose a distribution algorithm, which applies at the line-group level, from the options in the drop-down list box: Top Down—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Circular—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the (n+1)th member of a route group, where the nth member is the next sequential member in the list who is either idle or busy but not "down." If the nth member is the last member of a route group, Cisco Unified Communications Manager distributes a call starting from the top of the route group. Longest Idle Time—If you choose this distribution algorithm, Cisco Unified Communications Manager only distributes a call to idle members, starting from the longest idle member to the least idle member of a line group. Broadcast—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to all idle or available members of a line group simultaneously. See the Note in the description of the Selected DN/Route Partition field for additional limitations in using the Broadcast distribution algorithm. The default value specifies Longest Idle Time. Default: Longest Idle Time
  • Field Name: Line Groups.LineGroup.[n].distributionAlgorithm
  • Type: String
  • Cardinality: [1..1]
  • Default: Longest Idle Time
  • Choices: ["Top Down", "Circular", "Longest Idle Time", "Broadcast"]
Hunt Options No Answer * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer. This option gets applied at the member level. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group when the RNA reversion timeout value elapses for the first member. Cisco Unified Communications Manager then proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first member of this line group and the member does not answer the call. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.LineGroup.[n].huntAlgorithmNoAnswer
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Automatically Logout Hunt Member on No Answer If this check box is checked, line members will be logged off the hunt list automatically. Line members can log back in using the "HLOG" softkey or PLK.
  • Field Name: Line Groups.LineGroup.[n].autoLogOffHunt
  • Type: Boolean
  • Cardinality: [0..1]
Hunt Options Busy * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering a busy member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first busy member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.LineGroup.[n].huntAlgorithmBusy
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Hunt Options Not Available * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering the first unavailable member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first unavailable member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.LineGroup.[n].huntAlgorithmNotAvailable
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Directory Number The uuid attribute is read here
  • Field Name: directoryNumber
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Directory Number * Select from the drop-down list. This list includes any patterns that are available from the associated route partition.
  • Field Name: Line Groups.LineGroup.[n].members.member.[n].directoryNumber.pattern
  • Type: String
  • Target: /api/device/cucm/Line/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Hf5Fe8KXvkTvQcjU%24Co6xYyMWixoShfLBRcQgtWLedEIyWUMBDtySUqwg53xpnvLjc/4Keauc0Fw75/Go6lwEU6jRpSyqa/NnzGTzYrV/aGCOZRt2kE%2BZkT8JbzAklZkSTx69gZQxUXtbBNAlKxx3KZ0UTiYV20bIv7dc89NTQ6YUuZ3//2rv6LPqFFqeC2TTrp3uH4XXWjB1ui6i7MAOWNZas1Ju3mrxDNZOr0yMTP7hOE/IWovDgBuTxr7y7q/70lC%2BxX4CUD%2Bu1WtOoxWtSnSBxUmnGNxZkdioryPiTl/9TUu/LBHCvK3/9flrabUID9dkk2H0/4IXIyZqLKs4CW61civbQ2VMBhrHeqy4i4kDopbGD/v0pW3hmwbp5xXO0DlqmOsjV4a6TeV8fnSh%24%3D%3D
  • Target attr: pattern
  • Target Model Type: device/cucm/Line
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Partition * Select from the drop-down list. The drop-down list includes any route partitions to which the associated pattern belongs, and must match the route partition name for the directory number when it was originally created.
  • Field Name: Line Groups.LineGroup.[n].members.member.[n].directoryNumber.routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fQp2jkHXau3LGvo0%24uQ2YXY7hmybucqbYqw0E6alXiR9SUYfnFbB4Ifei3a8n45z8j5ZhMeluJPY3ZCxAMMTegI2NPhg5LSE19HAT95RRC32%2B9A5l6pwRR110hkNCCOvJWM0KuzDjps1LixHhQfGHnytJ8xWHwfC4lKevfwbGLHQaBIqBO0x0SGXNPPYOxS%2By3TmTFi1eaUVNdf1fYjpG93zUtgNBPp5dSZWTi4GB6O/KNR0hPbPPKTrXDpoSt8Xg2WrGCQ1akbyxgyE0JWAplpMNafcspPa8w4AJwMZsSy/G1gdphnXHgSu4mERT1n8xxK%2B3l8NhwSSSMQrkuOcoiF%2BMsMPoHtYPNF5DZuIw%2BSPfk%2BQugD2L8ENF9HygNF9F0u74dII/JAl/cC8KutLuzrVwSmLhTA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Position
  • Field Name: Line Groups.LineGroup.[n].members.member.[n].lineSelectionOrder
  • Type: Integer
  • Cardinality: [1..1]
Hunt List
  • Field Name: HuntList
  • Type: Object
Line Group
  • Field Name: LineGroup.[n]
  • Type: Array
Line Group Name * A name for the Line Group.
  • Field Name: Line Groups.HuntList.LineGroup.[n].name
  • Type: String
  • Cardinality: [1..1]
RNA Reversion Timeout * Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, Try next member; then, try next group in Hunt List, is chosen. The RNA Reversion Timeout applies at the line-group level to all members. Default: 10
  • Field Name: Line Groups.HuntList.LineGroup.[n].rnaReversionTimeOut
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 10
Distribution Algorithm * Choose a distribution algorithm, which applies at the line-group level, from the options in the drop-down list box: Top Down—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Circular—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the (n+1)th member of a route group, where the nth member is the next sequential member in the list who is either idle or busy but not "down." If the nth member is the last member of a route group, Cisco Unified Communications Manager distributes a call starting from the top of the route group. Longest Idle Time—If you choose this distribution algorithm, Cisco Unified Communications Manager only distributes a call to idle members, starting from the longest idle member to the least idle member of a line group. Broadcast—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to all idle or available members of a line group simultaneously. See the Note in the description of the Selected DN/Route Partition field for additional limitations in using the Broadcast distribution algorithm. The default value specifies Longest Idle Time. Default: Longest Idle Time
  • Field Name: Line Groups.HuntList.LineGroup.[n].distributionAlgorithm
  • Type: String
  • Cardinality: [1..1]
  • Default: Longest Idle Time
  • Choices: ["Top Down", "Circular", "Longest Idle Time", "Broadcast"]
Hunt Options No Answer * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer. This option gets applied at the member level. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group when the RNA reversion timeout value elapses for the first member. Cisco Unified Communications Manager then proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first member of this line group and the member does not answer the call. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.HuntList.LineGroup.[n].huntAlgorithmNoAnswer
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Automatically Logout Hunt Member on No Answer If this check box is checked, line members will be logged off the hunt list automatically. Line members can log back in using the "HLOG" softkey or PLK.
  • Field Name: Line Groups.HuntList.LineGroup.[n].autoLogOffHunt
  • Type: Boolean
  • Cardinality: [0..1]
Hunt Options Busy * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering a busy member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first busy member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.HuntList.LineGroup.[n].huntAlgorithmBusy
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Hunt Options Not Available * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering the first unavailable member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first unavailable member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: Line Groups.HuntList.LineGroup.[n].huntAlgorithmNotAvailable
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Directory Number The uuid attribute is read here
  • Field Name: directoryNumber
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Directory Number * Select from the drop-down list. This list includes any patterns that are available from the associated route partition.
  • Field Name: Line Groups.HuntList.LineGroup.[n].members.member.[n].directoryNumber.pattern
  • Type: String
  • Target: /api/device/cucm/Line/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Hf5Fe8KXvkTvQcjU%24Co6xYyMWixoShfLBRcQgtWLedEIyWUMBDtySUqwg53xpnvLjc/4Keauc0Fw75/Go6lwEU6jRpSyqa/NnzGTzYrV/aGCOZRt2kE%2BZkT8JbzAklZkSTx69gZQxUXtbBNAlKxx3KZ0UTiYV20bIv7dc89NTQ6YUuZ3//2rv6LPqFFqeC2TTrp3uH4XXWjB1ui6i7MAOWNZas1Ju3mrxDNZOr0yMTP7hOE/IWovDgBuTxr7y7q/70lC%2BxX4CUD%2Bu1WtOoxWtSnSBxUmnGNxZkdioryPiTl/9TUu/LBHCvK3/9flrabUID9dkk2H0/4IXIyZqLKs4CW61civbQ2VMBhrHeqy4i4kDopbGD/v0pW3hmwbp5xXO0DlqmOsjV4a6TeV8fnSh%24%3D%3D
  • Target attr: pattern
  • Target Model Type: device/cucm/Line
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Partition * Select from the drop-down list. The drop-down list includes any route partitions to which the associated pattern belongs, and must match the route partition name for the directory number when it was originally created.
  • Field Name: Line Groups.HuntList.LineGroup.[n].members.member.[n].directoryNumber.routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fQp2jkHXau3LGvo0%24uQ2YXY7hmybucqbYqw0E6alXiR9SUYfnFbB4Ifei3a8n45z8j5ZhMeluJPY3ZCxAMMTegI2NPhg5LSE19HAT95RRC32%2B9A5l6pwRR110hkNCCOvJWM0KuzDjps1LixHhQfGHnytJ8xWHwfC4lKevfwbGLHQaBIqBO0x0SGXNPPYOxS%2By3TmTFi1eaUVNdf1fYjpG93zUtgNBPp5dSZWTi4GB6O/KNR0hPbPPKTrXDpoSt8Xg2WrGCQ1akbyxgyE0JWAplpMNafcspPa8w4AJwMZsSy/G1gdphnXHgSu4mERT1n8xxK%2B3l8NhwSSSMQrkuOcoiF%2BMsMPoHtYPNF5DZuIw%2BSPfk%2BQugD2L8ENF9HygNF9F0u74dII/JAl/cC8KutLuzrVwSmLhTA%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Position
  • Field Name: Line Groups.HuntList.LineGroup.[n].members.member.[n].lineSelectionOrder
  • Type: Integer
  • Cardinality: [1..1]