[Index]

Model: relation/HcsRouteListREL

Route Lists

Before You Begin

Configure route groups before performing this procedure.

Route lists are made up of route groups and are associated with route patterns. A route list associates a set of route groups with a route pattern and determines the order in which those route groups are accessed. The order controls the progress of the search for available trunk devices for outgoing calls.

A route list can contain only route groups. Each route list should have at least one route group. Each route group includes at least one device, such as a gateway, that is available. Based on device type, Cisco Unified Communications Manager (Unified CM) can choose some, or all, ports as resources in each route group. Some devices, such as digital access, only allow you to choose all ports.

You can add a route group to any number of route lists.

Use the following procedure to add route lists or to add, remove or change the order of route groups in a route list.

Procedure

  1. Log in to as provider, reseller or customer administrator.

    Note: When configuring a route list as a provider or reseller, ensure that you select a valid customer or site under your customer in the hierarchy node breadcrumb at the top of the view.

  2. Perform one of the following:

  3. Perform one of:

  4. Complete at minimum, the mandatory Route Lists Details Fields.

  5. To add a route group to this route list, click + on the right side of the Route Group Items box and complete at minimum, the mandatory Route Group Items Fields.

  6. To remove a route group from this route list, click - on the right side of its row in the Member box.

  7. To change the priority of a route group, move it up or down in the list by clicking the arrows on the right side of the Member box. Using the Up arrow, move the group higher in the list to make it a higher priority, or using the Down arrow, move the group lower in the list to make it a lower priority.

  8. To save a new or updated route list, click Save.

Route Lists Details Fields

Field Description
CUCM * Select a Unified CM for the route list. This field is mandatory.
Name *

Enter a unique name for the new route list. The name can contain up to 50 alphanumeric characters and can contain any combination of spaces, period(s), hyphens (-), and underscore characters (_). This field is mandatory.

Tip:

Use concise and descriptive names for the route list. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route list. For example, 'CiscoDallasMetro' identifies a route list for toll-free, inter-local access transport area (LATA) calls from the Cisco office in Dallas.
Description A description of the route list.
Call Manager Group Name *

Select a Unified CM Group. Default is the default field. You can choose from Default, None, or select a group. This field is mandatory.

Note: The route list registers with the first Unified CM in the group (which is the Primary Unified CM).
Route List Enabled

Select to enable the route list. This is the default.

Clear to disable the route list. When disabling a route list, calls in progress do not get affected, but the route list does not accept additional calls.
Run on Every Node Select to enable the active route list to run on every node.
Route Group Items See "Route Group Items fields".

Route Group Items Fields

Field Description
Route Group * Choose the route group. This field is mandatory.
Selection Order Indicate the order in which to prioritize multiple routes. A lower selection order indicates higher priority. This field requires an integer value. The default is no setting.
Use Calling Party's External Phone Number Mask * Choose On from the drop-down list if you want the full external phone number to be used for calling line identification (CLID) on outgoing calls. Choose Off or Default if you do not want to use the full external phone number for CLID on outgoing calls. You may also configure an External Phone Number Mask on all phone devices. This field is mandatory.
Calling Party Transformation Mask

Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); and the international escape character +.

If the Digit Discards field is blank, the Prefix Digits field is blank, the Calling Party Transformation Mask field is blank, and Use Calling Party's External Phone Number Mask is set to Off or Default, no calling party transformation takes place.
Calling Party Prefix Digits Enter prefix digits in the field. Valid entries include the digits 0 through 9, the wildcard characters asterisk (*) and octothorpe (#), and the international escape character +. Note: The appended prefix digit does not affect which directory numbers route to the assigned device.
Calling Party Number Type

Choose the format for the number type in calling party directory numbers.

Unified CM 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 Unified CM 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 type numbering plan.

Choose one of the following options:

  • Cisco CallManager - Use when the Unified CM 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 dialling a subscriber by using a shortened subscriber number.
Field Description
Calling Party Numbering Plan

Choose the format for the numbering plan in calling party directory numbers.

Unified CM sets the calling DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because Unified CM 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 CallManager - Use when the Unified CM 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.
Called Party Discard Digits Choose the discard digit instructions that you want to be associated with this called party transformation pattern.
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 this field is blank and the preceding field is not checked, no transformation takes place.
Called Party Prefix Digits Enter prefix digits in the 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.
Called Party Number Type

Choose the format for the number type in called party directory numbers.

Unified CM 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 Unified CM 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 CallManager - Use when the Unified CM 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 dialling a subscriber by using a shortened subscriber number.
Field Description
Called Party Numbering Plan

Choose the format for the numbering plan in called party directory numbers.

Unified CM 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 Unified CM 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 CallManager - Use when the Unified CM 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.

This relation wraps the default CUCM Route List element to allow for targeted network device addition.

Model Details

Title Description Details
Call Manager Group Name *
  • Field Name: callManagerGroupName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
Route List Enabled
  • Field Name: routeListEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Run On Every Node
  • Field Name: runOnEveryNode
  • Type: Boolean
  • Cardinality: [0..1]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Calling Party Number Type Default: Cisco CallManager
  • Field Name: members.member.[n].callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Use Fully Qualified Calling Party Number * Default: Default
  • Field Name: members.member.[n].useFullyQualifiedCallingPartyNumber
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Party Prefix Digits
  • Field Name: members.member.[n].callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Called Party Transformation Mask
  • Field Name: members.member.[n].calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Selection Order *
  • Field Name: members.member.[n].selectionOrder
  • Type: Integer
  • Cardinality: [1..1]
Calling Party Numbering Plan Default: Cisco CallManager
  • Field Name: members.member.[n].callingPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Digit Discard Instruction Name
  • Field Name: members.member.[n].digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Prefix Digits Out
  • Field Name: members.member.[n].prefixDigitsOut
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Called Party Number Type Default: Cisco CallManager
  • Field Name: members.member.[n].calledPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Route Group Name *
  • Field Name: members.member.[n].routeGroupName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Calling Party Transformation Mask
  • Field Name: members.member.[n].callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Called Party Numbering Plan Default: Cisco CallManager
  • Field Name: members.member.[n].calledPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Name *
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
Network Device
  • Field Name: networkDevice
  • Type: Object
Network Device Select the network device for which you would like to add this element.
  • Field Name: networkDevice.nd
  • Type: String
  • Choices: [" "]
API reference for relation/HcsRouteListREL