[Index]

Model: relation/HcsSipRoutePatternREL

SIP Route Patterns

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

Overview

Cisco Unified Communications Manager (CUCM) uses SIP route patterns to route or block both internal and external calls.

The domain name or IP address provides the basis for routing. The administrator can add domains, IP addresses, and IP network (subnet) addresses and associate them to SIP trunks (only). This method allows requests that are destined for these domains to be routed through particular SIP trunk interfaces.

Configure SIP Route Patterns

This procedure configures a SIP route pattern.

Prerequisites

Perform these steps

  1. Log in as Provider, Reseller, or Customer administrator.
  2. Ensure that the hierarchy path is set to a customer or site level.
  3. If prompted, choose the NDL that contains the CUCM which you are configuring the SIP Route Pattern.
  4. Choose an option, depending on your login:
  5. Click Add.
  6. On the Pattern Definition tab, complete the Pattern Definition Fields.
  7. On the Calling Party Transformations tab, complete the Calling Party Transformations Fields.
  8. On the Connected Party Transformations tab, complete the Connected Party Transformations Fields.
  9. Click Save.

Pattern Definition Tab

Field Description
Pattern Usage From the drop-down list, choose either Domain Routing or IP Address Routing. This field is mandatory.
IPv4 Pattern

Enter the domain, subdomain, IPv4 address, or IP subnetwork address. This field is mandatory.

For Domain Routing pattern usage, enter a domain name IPv4 Pattern field that can resolve to an IPv4 address. The domain name can contain the following characters: -, ., 0-9, A-Z, a-z, *, ], and [.

For IP Address Routing pattern usage, enter an IPv4 address with the format X.X.X.X, where X represents a number between 0 and 255.

For the IP subnetwork address, in classless interdomain routing (CIDR) notation, X.X.X.X/Y; where Y is the network prefix that denotes the number of bits in the network address.

Tip:

If the SIP trunk supports IPv6 or both IPv4 and IPv6 (dual-stack mode), configure the IPv6 Pattern in addition to the IPv4 pattern.
IPv6 Pattern

Unified CM uses SIP route patterns to route or block both internal and external calls. The IPv6 address in this field provides the basis for routing internal and external calls to SIP trunks that support IPv6.

Tip:

If the SIP trunk supports IPv6 or both IPv4 and IPv6 (dual-stack mode), configure the IPv4 Pattern in addition to the IPv6 pattern.
Description Enter a description of the SIP Route Pattern. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).
Route Partition If you want to use a partition to restrict access to the SIP route pattern, choose the desired partition from the drop-down list box. If you do not want to restrict access to the SIP route pattern, leave the Route Partition value empty.
SIP Trunk/Route List Choose the SIP trunk or route list to which the SIP route pattern is associated. This field is mandatory.
Block Pattern Select this check box if you want this pattern to be used for blocking calls.

Calling Party Transformations Tab

Field Description
Use Calling Party's External Phone Mask Select On if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. Select Default to use the default External Phone Number Mask. This field is mandatory.
Calling Party Transformation Mask Enter a transformation mask value. Valid entries include the digits 0 to 9 and the wildcard characters X, asterisk (*), and octothorpe (#). If this field is blank and the preceding field is not selected, no calling party transformation takes place.
Prefix Digits (Outgoing Calls) Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 to 9 and the wildcard characters asterisk (*) and octothorpe (#). Note: The appended prefix digit does not affect which directory numbers route to the assigned device.
Calling Line ID Presentation

Calling line ID presentation (CLIP/CLIR) is a supplementary service that allows or restricts the originating caller phone number on a call-by-call basis.

Choose whether you want to allow or restrict the display of the calling party phone number on the called party phone display for this SIP route pattern.

Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want to allow the display of the calling number. Choose Restricted if you want to block the display of the calling number.
Calling Line Name Presentation

Calling line name presentation (CNIP/CNIR) is a supplementary service that allows or restricts the originating caller name on a call-by-call basis.

Choose whether you want to allow or restrict the display of the calling party name on the called party phone display for this SIP route pattern.

Choose Default if you do not want to change calling name presentation. Choose Allowed if you want to allow the display of the caller name. Choose Restricted if you want to block the display of the caller name.

Connected Party Transformations Tab

Field Description
Connected Line ID Presentation

Connected line ID presentation (COLP/COLR) is a supplementary service that allows or restricts the called party phone number on a call-by-call basis.

Choose whether you want to allow or restrict the display of the connected party phone number on the calling party phone display for this SIP route pattern.

Choose Default if you do not want to change the connected line ID presentation. Choose Allowed if you want to display the connected party phone number. Choose Restricted if you want to block the display of the connected party phone number.

If a call originating from an IP phone on Unified CM 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.
Connected Line Name Presentation

Connected name presentation (CONP/CONR) is a supplementary service that allows or restricts the called party name on a call-by-call basis.

Choose whether you want to allow or restrict the display of the connected party name on the calling party phone display for this SIP route pattern.

Choose Default if you do not want to change the connected name presentation. Choose Allowed if you want to display the connected party name. Choose Restricted if you want to block the display of the connected party name.

This relation wraps the device/cucm/SipRoutePattern element.

Model Details: relation/HcsSipRoutePatternREL

Title Description Details
Connected Name Presentation Bit Default: Default
  • Field Name: connectedNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Calling Party Prefix Digits
  • Field Name: callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+]{0,50}$
Calling Line Presentation Bit Default: Default
  • Field Name: callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: callingNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Pattern *
  • Field Name: pattern
  • Type: String
  • Cardinality: [1..1]
Sip Trunk Name *
  • Field Name: sipTrunkName
  • Type: String
  • Target: /api/device/cucm/SipTrunk/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24hjuhmniAzeyHNiAf%24mmRk8CtKA4yx1QxqLoKTrE5j388OzLOLpa5CT3PdxK6xPY28wbCXvNJJ94mqaw9t6rBF7w3BuOoiO4BXygBZoVkseTJCFt0ocbj10Wj8FnN0slfuQW2no%2B0w4BAS5eOA82T7zLTWKUeq7Dlpp/wfMkzdZgyJs7mq3bHkYJmppJZnPnYfFJiCGV2eN51SnA9SdoN3i4r8WpTRK0VXq6Adfp/Zc7MIRbBu3NRoSPEJkOa/rMrYGZFPUELUEXBytg%2BC%2BzPzm20M8zBdK69c18M3v%2Bbb65/VohDLYEkJfHMyNLm8hYV4QMhcSBltxnc7xyOeWPbFCDwiJtVCyW0XhTyUN04cllzzXOkzUzWk/cuwuz4m0mKZWAFs5E%2B7ufU%2B3ONMa0h5vxdtclc%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/SipTrunk
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Dn Or Pattern Ipv6
  • Field Name: dnOrPatternIpv6
  • Type: String
  • Cardinality: [0..1]
Calling Party Transformation Mask
  • Field Name: callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Connected Line Presentation Bit Default: Default
  • Field Name: connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Use Caller Css
  • Field Name: useCallerCss
  • Type: Boolean
  • Cardinality: [0..1]
Domain Routing Css Name
  • Field Name: domainRoutingCssName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ka1Osr10wpMzw689%24psnObv//mzDFwKLZGp5ZpYJZLmOv9YiBCRBQTA0NoFI8SXcldqQqtzaLY1EHZZb5RdYnrCBcLL8U7RSJvwzR6uC5dz46jqLm5vnRr1Wgamp8eRRGrMQjuI5gfSH7eUD6CPvuG%2BO%2B8v8jTwnPFirl10wJFsBhyyeqlo8SEAYgKRxl3CIA086BIG04YwmijrjxClDR3tyBsiHwGOZiluQ2dmNio28KFzDVy8uXE6Fq9aUrO41D2nUmabJLWAQEDRFOvFP04sQ0m81aiNi/ZeQmrpdE/eQ4JQQM1GwwC78sJnZVkPJelWLpPg7KS%2BS2ZCGV8Pz8wSiLcSRGHArb/hGcP/MSv0ckrrEo7eo/fD2o1SlgaIXZjPwY%2B7IMqNZZJIQtdPsj%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Usage * For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
  • Field Name: usage
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["CallPark", "Conference", "Device", "Translation", "Call Pick Up Group", "Route", "Message Waiting", "Hunt Pilot", "Voice Mail Port", "Domain Routing", "IPAddress Routing", "Device template", "Directed Call Park", "Device Intercom", "Translation Intercom", "Translation Calling Party Number", "Mobility Handoff", "Mobility Enterprise Feature Access", "Mobility IVR", "Device Intercom Template", "Called Party Number Transformation", "Call Control Discovery Learned Pattern", "Uri Routing", "ILS Learned Enterprise Number", "ILS Learned E164 Number", "ILS Learned Enterprise Numeric Pattern", "ILS Learned E164 Numeric Pattern", "Alternate Number", "ILS Learned URI", "ILS Learned PSTN Failover Rule", "ILS Imported E164 Number", "Centralized Conference Number", "Emergency Location ID Number"]
Use Calling Party Phone Mask * Default: Default
  • Field Name: useCallingPartyPhoneMask
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Route Partition Name *
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249yN5E0OuY9PQ7urr%24F41jySlSLSPmtQ8kPuHfhzVKYmxEQD5UNhtxG%2Bpwx5nvik/IVUV8BaZZyIJEsdeAZ8u2ebdemvbNrpnjh3fy7T%2BGTU8aJLTUaByyoazLPxWswuZgrlXF%2BX%2B7EdVZhudsxJZ3RNZtVK/nhikjhfslpfY3JjqH0Jpcpo0Gy3eDnk9kyzwqq9zhFzjFQtc2ohuMid7QPTTHlyAPl7iQnAF7Pe7IsP4NecMXbyrWY3r9QNWX9lYzerbvy/CtN%2BEBnfct2cjmXG79C0O1rcGF5X6MYC1eaYi6vK5PM/bblaC9H4m2xqcPeqt86pjtVTJqjfTD2OCUdnWnAVE%2Bri9w2L5BEzOxPur4JUWf7AnmA3wTmKGRCwUx0yw/ZiFNHFOUEk3/2r2PHRwKAddfkZVPWQg%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Route On User Part
  • Field Name: routeOnUserPart
  • Type: Boolean
  • Cardinality: [0..1]
Block Enable
  • Field Name: blockEnable
  • Type: Boolean
  • Cardinality: [0..1]
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024