[Index]

Model: relation/HcsDpSipRoutePatternREL

SIP Route Pattern

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

Site short codes work the same for deployments that use shared lines across sites as they do for "real site" deployments. That is, short codes can be added to a site to allow shorter, convenient numbers to be dialed that are transformed into longer directory numbers. Normally, short codes are added to real sites that contain devices in order to allow users of those devices to dial shorter numbers to reach exiting directory numbers.

Because the inventory site doesn't contain devices, but only line inventory, site codes don't need to be added to the inventory site. Short code translation patterns are created on a site's Allow Internal (AInt) route partition.

Model Details: relation/HcsDpSipRoutePatternREL

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}$
Use Caller Css
  • Field Name: useCallerCss
  • Type: Boolean
  • Cardinality: [0..1]
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%24cLEsfxQrrHgXEzJl%248Nf9%2BJRimjZrPBlCDbsif6lR7I841u55dHms750V1Ly4tZmDK8y2zVRAIzk9O37b8bcPG2NVI22H5pApxT4vJSrjTHLDIabL6qoxqVDfbGwZIeJ48dnvvlr5UWK6B4Dy/WcWAxK6%2BG9yQr/Fqs7wfVoH%2BPMz3QAY5Ro2ePF9P3g/MDBaHmSYv6FjPyox4QpHInNRkzdfrYU6YsPk0Woms2JpeR1PT6KAKJf56/%2BTlGxbSlFrhmA4Yp08Fr63ejMqCsW2cfOD32mTETcTKEb7MXTb/LnNVDvBsiSBowLl3oMDj9uBpsuIq1NROnazKe4z3ixBo/wqb8GUbD7EsDUEGIN/soDOStv4Ezu8aq8aqRe0l8O0hOUcZ9mgsxNcJeeu0Cox7zwMkKa40A%3D%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]
Route On User Part
  • Field Name: routeOnUserPart
  • Type: Boolean
  • Cardinality: [0..1]
Connected Line Presentation Bit Default: Default
  • Field Name: connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Line Presentation Bit Default: Default
  • Field Name: callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
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%24H5SoUvOtwgims2JO%242BFVAvH0TTcel/z%2Bq0tyC7MEU6Kzi1JTzYuJ26I1R3LIJ9U2wS21QSKtr7lyNGc2t%2BtOjp7m8dyxuhIWIHcFFE3e%2Bupx5Rgj4JPeJTbjw9nYT6U6CN/7Jca0bkCF6kPKWSYHP4OpQ5C93SYWrovkkUMLeCq5XZBskQy%2B3AtV3dn3iV/%2Bc3Pw825la7NcuJ2WH/1iX3H%2B8%2BF%2B5iAamOBsW%2BDWFxaPAW1KpKHHnn%2BTHc%2Bpwcz5xon%2BsIBfsbVhyQpC/XIm4SlBhJKxTZ/f1e9LM7somYXNx3TG4NbW13hX1NSffyHjRP/%2B8rUXJCZTgFkN6Er5Nkme79e9VB399UjNrb3wj3MfrGrn9rimNOkKH3wdL2X7RQzMVc1VmcfVkil7GKISUtI%3D%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%24Ituo65y8sLGJoPm1%24we9oZuyq1FLxe61Pjy5hzi5rFsi/D3uxcHHs4QDdgWlc2Et0F6gGTodzv6%2B/I797K785yPaEuqvfA2EtuIoifWc6gpB90J8zYxeUq7/bZJFf4Dvw6aIrbXBZlYH6bU0Xsrp9VmAInoITqUJQH5hZdrFCvKZ9ZA5HQ2%2B3WaRiu6IuTVRvUmWciclskabDNjTRWaQoj8DBp4DYanpUwTOCLoxEAAk%2B2gGFNUu2cCY1qs610iiMwpUR4ZqQVf3zDXqKeg4NcMgBO8BnfLHP%2B30mbdI8YNnTgSBXsbQnH2CM448hoeADwOuT3Ee44IjbgphqWuHuydaXczDOppWJlCrevGkrBYmIySiiLqIkxQSsiej%2Br4EjA8dHgeZjmbeOOwOerPKMpOa/yoxcwmk%2Bacxzkg%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Calling Party Transformation Mask
  • Field Name: callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
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