[Index]

Model: data/HcsDpDialPlanSchemaDAT

Dial Plan Schema

Full HTML Help

This procedure configures a customized group of related dial plan elements in Cisco Unified Communications Manager (CUCM), including time periods, time schedules, partitions, calling search spaces, translation patterns, calling and called party transformations, CTI route points, route lists, route patterns, and SIP route patterns.

Note

When configuring a dial plan schema using this procedure, the elements are only available on the CUCM after the dial plan schema is placed in a Dial Plan Schema group (refer to Create Schema Groups), and once the group is associated with a customer (refer to Associate Custom Schemas to Customers).

It is strongly recommended that all dial plan entries in a dial plan should be unique.

Perform these steps:

  1. Log in to VOSS Automate as a Provider or Reseller Administrator.

  2. Go to (default menus) Dial Plan Management > Advanced Configuration > Dial Plan Schema.

  3. To add a new custom schema, click Add.

  4. On the General tab, enter a unique name for the schema, and (optionally) add a description.

  5. On the Time Periods tab, click the Plus icon (+) to open the form for time period information, and fill out required details:

  6. On the Time Schedules tab, click the Plus icon (+) to open the form to add time schedule information, and fill out details for the schema:

  7. On the Partitions tab, click the Plus icon (+) to open the form for adding partition details, then enter a partition name and description, and provide the time schedule.

    Note

    You can use macros to add partition information. For more information on using macros as part of the Partition Names, Descriptions, or Time Schedules, see Macros.

  8. On the Calling Search Spaces tab, click the Plus icon (+), then fill out CSS details for the schema:

    Note

    You can use macros to add calling search space (CSS) details.

  9. On each of the following tabs, click the Plus icon (+) to open the editing form, and fill out the relevant details for the schema.

  10. Click Save to create the new dial plan schema.

Next Steps

Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node

Full HTML Help

All existing dial plan schema and schema groups are cloned automatically from the System Administration level in VOSS Automate 10.x/11.5(x) to the Provider hierarchy node when the following events occur:

New dial plan schema files and schema groups are also cloned automatically to existing Provider hierarchy nodes when the following events occur:

The cloned version at the Provider level has the same name and is an exact replica of the dial plan schema or schema group at the System Admin level except that the Description field in the General tab of the schema indicates that it is the Cloned instance version.

Note

The auto-cloning mechanism does not clone a schema or schema group to the Provider level if there is already one at the Provider level with the same name.

Auto-cloning of the dial plan schema and schema groups to the Provider level ensures that any dial plan schema and schema group changes you make to existing Cisco templates are not lost when a Cisco template upgrade is introduced. As a Provider, you can also add your own schemas and schema groups at the Sys Admin level and be confident that these will be cloned down to the Provider level and not be overwritten by upgraded Cisco templates.

Your dial plan schema changes are retained because when you deploy new customers and sites, the system searches up the hierarchy node tree to find the first instance of a particular template name to use for the deployment.

For example, when deploying the Customer Call Screening feature schema for a customer, the system searches up the hierarchy node tree for the first instance of the CustomerCallScreening-Feature-V1-SCH. It will find two instances of CustomerCallScreening-Feature-V1-SCH:

  1. CustomerCallScreening-Feature-V1-SCH (at the Provider level - e.g. sys.hcs.p1)
  2. CustomerCallScreening-Feature-V1-SCH (at the System Administration level - e.g. sys-hcs)

Because the schema names are identical and the Provider hierarchy node is found first, the Provider level CustomerCallScreening-Feature-V1-SCH schema is used to deploy the customer. Any customizations you made to the CustomerCallScreening-Feature-V1-SCH schema at the Provider level are retained if the template at the System Administration level gets updated by an upgrade.

Clone Dial Plan Schemas

Full HTML Help

Use this procedure to copy one of the default dial plan schemas (or a previously customized schema) to use as a starting point when creating a new dial plan schema.

  1. Log in to VOSS Automate as the Provider or Reseller Administrator.

  2. Select Dial Plan Management > Advanced Configuration > Dial Plan Schema.

  3. From the list of dial plan schemas, choose the one to be cloned, by clicking on its box in the leftmost column. For more information on the default dial plan schemas, refer to Default Dial Plan Schemas.

    Note

    There may be duplicate dial plan schemas in the list because some of the dial plan schemas may have been auto-cloned to the Provider hierarchy node. For more information, see Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node.

  4. Click Action > Clone.

  5. From the General tab, enter a new unique name for the cloned dial plan in the Dial Plan Name field.

  6. If desired, add a description of the new cloned dial plan schema in the Description field.

  7. Modify or add time periods, time schedules, partitions, calling search spaces, translation patterns, calling party transformation patterns, called party transformation patterns, CTI route points, route lists, route patterns, and SIP route patterns as desired by clicking on the appropriate tab.

  8. Click Save. The new dial plan schema appears in the list of Dial Plan Schemas.

This data model encapsulates the information needed to deploy a dial plan schema.

Model Details: data/HcsDpDialPlanSchemaDAT

Title Description Details
Dial Plan Name * Dial plan schema name.
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description A description for this dial plan schema.
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Time Periods Time Periods for this dial plan schema.
  • Field Name: timePeriodArray.[n]
  • Type: Array
Time Period Name * The name for this time period.
  • Field Name: timePeriodArray.[n].name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this time period.
  • Field Name: timePeriodArray.[n].description
  • Type: String
  • MaxLength: 1024
Time of Day Start * The start time for this period. Default: No Office Hours
  • Field Name: timePeriodArray.[n].startTime
  • Type: String
  • Default: No Office Hours
  • MaxLength: 1024
  • Choices: ["No Office Hours"]
Time of Day End * The end time for this period. Default: No Office Hours
  • Field Name: timePeriodArray.[n].endTime
  • Type: String
  • Default: No Office Hours
  • MaxLength: 1024
  • Choices: ["No Office Hours"]
Start Day Optional start day for this period. Default: None
  • Field Name: timePeriodArray.[n].startDay
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None"]
End Day Optional end day for this period. Default: None
  • Field Name: timePeriodArray.[n].endDay
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None"]
Start Month Optional start month for this period. Default: None
  • Field Name: timePeriodArray.[n].startMonth
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None"]
Start Day of Month Optional start day of month for this period. Default: 0
  • Field Name: timePeriodArray.[n].startDayOfMonth
  • Type: String
  • Default: 0
  • MaxLength: 1024
  • Pattern: ^([0-9]|[12][0-9]|[3][01])$
End Month Optional end month for this period. Default: None
  • Field Name: timePeriodArray.[n].endMonth
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None"]
End Day of Month Optional end day of month for this period. Default: 0
  • Field Name: timePeriodArray.[n].endDayOfMonth
  • Type: String
  • Default: 0
  • MaxLength: 1024
  • Pattern: ^([0-9]|[12][0-9]|[3][01])$
Time Schedules Time Schedules for this dial plan schema.
  • Field Name: timeScheduleArray.[n]
  • Type: Array
Time Schedule Name * The name for this time schedule.
  • Field Name: timeScheduleArray.[n].name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this time schedule.
  • Field Name: timeScheduleArray.[n].description
  • Type: String
  • MaxLength: 1024
Time Periods
  • Field Name: timeScheduleMembers.[n]
  • Type: Array
Time Period Name A time period that is part of this time schedule.
  • Field Name: timeScheduleArray.[n].timeScheduleMembers.[n].timePeriodName
  • Type: String
  • MaxLength: 1024
Partitions Partitions for this dial plan schema.
  • Field Name: partitionArray.[n]
  • Type: Array
Partition Name * The name for this partition.
  • Field Name: partitionArray.[n].name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this partition.
  • Field Name: partitionArray.[n].description
  • Type: String
  • MaxLength: 1024
Time Schedule The time schedule to use for this partition. Default: NULL
  • Field Name: partitionArray.[n].timeSchedule
  • Type: String
  • Default: NULL
  • MaxLength: 1024
Calling Search Spaces Calling Search Spaces for this dial plan schema.
  • Field Name: cssArray.[n]
  • Type: Array
CSS Name * The name of the calling search space.
  • Field Name: cssArray.[n].name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this calling search space.
  • Field Name: cssArray.[n].description
  • Type: String
  • MaxLength: 1024
Partition Usage Default: General
  • Field Name: cssArray.[n].usage
  • Type: String
  • Default: General
  • MaxLength: 1024
Class of Service CSS If enabled, indicates that this CSS is a class of service.
  • Field Name: cssArray.[n].isClassOfService
  • Type: Boolean
Partitions The array of default partitions associated with this calling search space.
  • Field Name: partitionMembers.[n]
  • Type: Array
Route Partition Name * The name of the partition.
  • Field Name: cssArray.[n].partitionMembers.[n].partition
  • Type: String
  • MaxLength: 1024
Index * The index for this route partition.
  • Field Name: cssArray.[n].partitionMembers.[n].index
  • Type: String
  • MaxLength: 1024
  • Pattern: ^[0-9]*
Translation Patterns Translation patterns for this dial plan schema.
  • Field Name: translationPatternArray.[n]
  • Type: Array
For Each If a list is specific, create a translation pattern for each item in the list.
  • Field Name: translationPatternArray.[n].forEach
  • Type: String
  • MaxLength: 1024
Translation Pattern * The translation pattern.
  • Field Name: translationPatternArray.[n].pattern
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this translation pattern.
  • Field Name: translationPatternArray.[n].description
  • Type: String
  • MaxLength: 1024
Partition * The route partition to which this pattern belongs.
  • Field Name: translationPatternArray.[n].routePartition
  • Type: String
  • MaxLength: 1024
CSS
  • Field Name: translationPatternArray.[n].css
  • Type: String
  • MaxLength: 1024
Use Originator's Calling Search Space
  • Field Name: translationPatternArray.[n].useOrigCss
  • Type: Boolean
Route Option Default: Route this pattern
  • Field Name: translationPatternArray.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • MaxLength: 1024
  • Choices: ["Route this pattern", "Block this pattern"]
Release Clause If this is a blocking pattern, select the release clause when the call is blocked. Default: No Error
  • Field Name: translationPatternArray.[n].releaseClause
  • Type: String
  • Default: No Error
  • MaxLength: 1024
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Provide Outside Dial Tone
  • Field Name: translationPatternArray.[n].provideOutsideDialTone
  • Type: Boolean
Urgent Priority
  • Field Name: translationPatternArray.[n].urgentPriority
  • Type: Boolean
Do Not Wait For Interdigit Timeout On Subsequent Hops
  • Field Name: translationPatternArray.[n].noWaitInterdigitTimeoutSubseqHops
  • Type: Boolean
Route Next Hop By Calling Party Number
  • Field Name: translationPatternArray.[n].nextHopByCallingPtyNum
  • Type: Boolean
Use Calling Party's External Phone Number Mask
  • Field Name: translationPatternArray.[n].useCallingPartyExternalPhoneNumMask
  • Type: Boolean
Calling Party Transform Mask
  • Field Name: translationPatternArray.[n].callingPartyTransformMask
  • Type: String
  • MaxLength: 1024
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: translationPatternArray.[n].callingPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Called Party Discard Digits Default: None
  • Field Name: translationPatternArray.[n].calledPartyDiscardDigits
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Called Party Transform Mask
  • Field Name: translationPatternArray.[n].calledPartyTransformMask
  • Type: String
  • MaxLength: 1024
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: translationPatternArray.[n].calledPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Calling Line Presentation Bit Default: Default
  • Field Name: translationPatternArray.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: translationPatternArray.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: translationPatternArray.[n].connLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: translationPatternArray.[n].connNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Party Transformation Patterns Calling party transformation patterns for this dial plan schema.
  • Field Name: callingPartyTransPatternArray.[n]
  • Type: Array
Pattern * The pattern for this calling party transformation.
  • Field Name: callingPartyTransPatternArray.[n].pattern
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this calling party transformation pattern.
  • Field Name: callingPartyTransPatternArray.[n].description
  • Type: String
  • MaxLength: 1024
Partition The route partition to which this calling party transformation belongs.
  • Field Name: callingPartyTransPatternArray.[n].partition
  • Type: String
  • MaxLength: 1024
Use Calling Party's External Phone Number Mask
  • Field Name: callingPartyTransPatternArray.[n].useCallingPartyExternalPhoneNumMask
  • Type: Boolean
Calling Party Discard Digits Default: None
  • Field Name: callingPartyTransPatternArray.[n].discardDigits
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None", "PreDot"]
Calling Party Transform Mask
  • Field Name: callingPartyTransPatternArray.[n].transformMask
  • Type: String
  • MaxLength: 1024
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: callingPartyTransPatternArray.[n].prefixDigits
  • Type: String
  • MaxLength: 1024
Calling Line ID Presentation * Default: Default
  • Field Name: callingPartyTransPatternArray.[n].cgLineIdPres
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Party Number Type * Default: Cisco CallManager
  • Field Name: callingPartyTransPatternArray.[n].cgPtyNumType
  • Type: String
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Calling Party Numbering Plan * Default: Cisco CallManager
  • Field Name: callingPartyTransPatternArray.[n].cgPtyNumPlan
  • Type: String
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Called Party Transformation Patterns Called party transformation patterns for this dial plan schema.
  • Field Name: calledPartyTransPatternArray.[n]
  • Type: Array
Pattern * The pattern for this called party transformation.
  • Field Name: calledPartyTransPatternArray.[n].pattern
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this called party transformation pattern.
  • Field Name: calledPartyTransPatternArray.[n].description
  • Type: String
  • MaxLength: 1024
Route Partition The route partition to which this calling party transformation belongs.
  • Field Name: calledPartyTransPatternArray.[n].partition
  • Type: String
  • MaxLength: 1024
Discard Digits Default: None
  • Field Name: calledPartyTransPatternArray.[n].discardDigits
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Called Party Transformation Mask
  • Field Name: calledPartyTransPatternArray.[n].transformMask
  • Type: String
  • MaxLength: 1024
Called Party Prefix Digits
  • Field Name: calledPartyTransPatternArray.[n].prefixDigits
  • Type: String
  • MaxLength: 1024
Called Party Number Type * Default: Cisco CallManager
  • Field Name: calledPartyTransPatternArray.[n].numType
  • Type: String
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Called Party Numbering Plan * Default: Cisco CallManager
  • Field Name: calledPartyTransPatternArray.[n].numPlan
  • Type: String
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Route Lists Route list items for this dial plan schema.
  • Field Name: routeListArray.[n]
  • Type: Array
Name * The name for this route list.
  • Field Name: routeListArray.[n].name
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this route list.
  • Field Name: routeListArray.[n].description
  • Type: String
  • MaxLength: 1024
Call Manager Group Name
  • Field Name: routeListArray.[n].callManagerGroup
  • Type: String
  • MaxLength: 1024
Route List Enabled
  • Field Name: routeListArray.[n].routeListEnabled
  • Type: Boolean
Run On Every Node
  • Field Name: routeListArray.[n].runOnEveryNode
  • Type: Boolean
Members
  • Field Name: members.[n]
  • Type: Array
Route Group Name *
  • Field Name: routeListArray.[n].members.[n].routeGroupName
  • Type: String
  • MaxLength: 1024
Selection Order *
  • Field Name: routeListArray.[n].members.[n].selectionOrder
  • Type: String
  • MaxLength: 1024
Use Calling Party's External Phone Number Mask Default: Default
  • Field Name: routeListArray.[n].members.[n].useCallingPartyExternalPhoneNumMask
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "On", "Off"]
Calling Party Transform Mask
  • Field Name: routeListArray.[n].members.[n].callingPartyTransformMask
  • Type: String
  • MaxLength: 1024
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: routeListArray.[n].members.[n].callingPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Called Party Discard Digits Default: None
  • Field Name: routeListArray.[n].members.[n].calledPartyDiscardDigits
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None"]
Called Party Transform Mask
  • Field Name: routeListArray.[n].members.[n].calledPartyTransformMask
  • Type: String
  • MaxLength: 1024
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: routeListArray.[n].members.[n].calledPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Route Patterns Route pattern list for this dial plan schema.
  • Field Name: routePatternArray.[n]
  • Type: Array
Route Pattern * The route pattern.
  • Field Name: routePatternArray.[n].pattern
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this route pattern.
  • Field Name: routePatternArray.[n].description
  • Type: String
  • MaxLength: 1024
Route Partition * The route partition to which this pattern belongs.
  • Field Name: routePatternArray.[n].routePartition
  • Type: String
  • MaxLength: 1024
Route List
  • Field Name: routePatternArray.[n].routeList
  • Type: String
  • MaxLength: 1024
Gateway Name
  • Field Name: routePatternArray.[n].gatewayName
  • Type: String
  • MaxLength: 1024
Route Option Default: Route this pattern
  • Field Name: routePatternArray.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • MaxLength: 1024
  • Choices: ["Route this pattern", "Block this pattern"]
Release Clause If this is a blocking pattern, select the release clause when the call is blocked. Default: No Error
  • Field Name: routePatternArray.[n].releaseClause
  • Type: String
  • Default: No Error
  • MaxLength: 1024
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Call Classification * OnNet or Offnet call Default: OffNet
  • Field Name: routePatternArray.[n].callClassification
  • Type: String
  • Default: OffNet
  • MaxLength: 1024
  • Choices: ["OffNet", "OnNet"]
Allow Device Override
  • Field Name: routePatternArray.[n].allowDeviceOverride
  • Type: Boolean
Provide Outside Dial Tone
  • Field Name: routePatternArray.[n].provideOutsideDialTone
  • Type: Boolean
Allow Overlap Sending
  • Field Name: routePatternArray.[n].allowOverlapSending
  • Type: Boolean
Urgent Priority
  • Field Name: routePatternArray.[n].urgentPriority
  • Type: Boolean
Require Forced Authorization Code
  • Field Name: routePatternArray.[n].reqForcedAuthCode
  • Type: Boolean
Authorization Level * Default: 0
  • Field Name: routePatternArray.[n].authLevel
  • Type: String
  • Default: 0
  • MaxLength: 1024
Require Client Matter Code
  • Field Name: routePatternArray.[n].reqClientMatterCode
  • Type: Boolean
Use Calling Party's External Phone Number Mask
  • Field Name: routePatternArray.[n].useCallingPartyExternalPhoneNumMask
  • Type: Boolean
Calling Party Transform Mask
  • Field Name: routePatternArray.[n].callingPartyTransformMask
  • Type: String
  • MaxLength: 1024
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: routePatternArray.[n].callingPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Called Party Discard Digits Default: None
  • Field Name: routePatternArray.[n].calledPartyDiscardDigits
  • Type: String
  • Default: None
  • MaxLength: 1024
  • Choices: ["None", "PreDot", "PreDot Trailing-#"]
Called Party Transform Mask
  • Field Name: routePatternArray.[n].calledPartyTransformMask
  • Type: String
  • MaxLength: 1024
Called Party Prefix Digits (Outgoing Calls)
  • Field Name: routePatternArray.[n].calledPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Calling Line Presentation Bit Default: Default
  • Field Name: routePatternArray.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: routePatternArray.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: routePatternArray.[n].connLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: routePatternArray.[n].connNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
MLPP Precedence Default: Default
  • Field Name: routePatternArray.[n].patternPrecedence
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Executive Override", "Flash", "Flash Override", "Immediate", "Priority", "Routine"]
SIP Route Patterns SIP Route pattern list for this dial plan schema.
  • Field Name: sipRoutePatternArray.[n]
  • Type: Array
Pattern * The SIP route pattern.
  • Field Name: sipRoutePatternArray.[n].pattern
  • Type: String
  • MaxLength: 1024
Description A meaningful description for this SIP route pattern.
  • Field Name: sipRoutePatternArray.[n].description
  • Type: String
  • MaxLength: 1024
Usage * The usage for this SIP route pattern.
  • Field Name: sipRoutePatternArray.[n].usage
  • Type: String
  • MaxLength: 1024
  • Choices: ["Domain Routing"]
Route Partition * The route partition to which this pattern belongs.
  • Field Name: sipRoutePatternArray.[n].routePartitionName
  • Type: String
  • MaxLength: 1024
Route Option Default: Route this pattern
  • Field Name: sipRoutePatternArray.[n].routeOption
  • Type: String
  • Default: Route this pattern
  • MaxLength: 1024
  • Choices: ["Route this pattern", "Block this pattern"]
Calling Party Transformation Mask
  • Field Name: sipRoutePatternArray.[n].callingPartyTransformationMask
  • Type: String
  • MaxLength: 1024
Use Calling Party's External Phone Number Mask
  • Field Name: sipRoutePatternArray.[n].useCallingPartyExternalPhoneNumMask
  • Type: Boolean
Calling Party Prefix Digits (Outgoing Calls)
  • Field Name: sipRoutePatternArray.[n].callingPartyPrefixDigits
  • Type: String
  • MaxLength: 1024
Calling Line Presentation Bit Default: Default
  • Field Name: sipRoutePatternArray.[n].cgLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Bit Default: Default
  • Field Name: sipRoutePatternArray.[n].cgNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line Presentation Bit Default: Default
  • Field Name: sipRoutePatternArray.[n].connLinePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Bit Default: Default
  • Field Name: sipRoutePatternArray.[n].connNamePresBit
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Sip Trunk/Route List Name *
  • Field Name: sipRoutePatternArray.[n].sipTrunkName
  • Type: String
  • MaxLength: 1024
Dn or Pattern IPv6
  • Field Name: sipRoutePatternArray.[n].dnOrPatternIpv6
  • Type: String
  • MaxLength: 1024
Route On User Part
  • Field Name: sipRoutePatternArray.[n].routeOnUserPart
  • Type: Boolean
Use Caller CSS
  • Field Name: sipRoutePatternArray.[n].useCallerCss
  • Type: Boolean
Domain Routing Css Name
  • Field Name: sipRoutePatternArray.[n].domainRoutingCssName
  • Type: String
  • MaxLength: 1024
CTI Route Points
  • Field Name: ctiRoutePointArray.[n]
  • Type: Array
Device Name * The name for this CTI route point.
  • Field Name: ctiRoutePointArray.[n].deviceName
  • Type: String
  • MaxLength: 1024
Description Meaningful description for this CTI route point.
  • Field Name: ctiRoutePointArray.[n].description
  • Type: String
  • MaxLength: 1024
Device Pool *
  • Field Name: ctiRoutePointArray.[n].devicePool
  • Type: String
  • MaxLength: 1024
Calling Search Space
  • Field Name: ctiRoutePointArray.[n].css
  • Type: String
  • MaxLength: 1024
Location *
  • Field Name: ctiRoutePointArray.[n].location
  • Type: String
  • MaxLength: 1024
Use Trusted Relay Point * Default: Default
  • Field Name: ctiRoutePointArray.[n].useTrustedRelayPoint
  • Type: String
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "On", "Off"]
Calling Party Transformation CSS
  • Field Name: ctiRoutePointArray.[n].cgPtyTransCss
  • Type: String
  • MaxLength: 1024
Geolocation
  • Field Name: ctiRoutePointArray.[n].geolocation
  • Type: String
  • MaxLength: 1024
Use Device Pool Calling Party Transformation CSS
  • Field Name: ctiRoutePointArray.[n].useDevPoolCgPtyTransCss
  • Type: Boolean