[Index]

Model: relation/IntercomLineRelation

Associating Intercom Lines to Phones

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

Navigate to a site hierarchy and choose Phones under the Subscriber Management menu for the site.

To associate an Intercom line on the Lines tab of the Phone form, first specify an Intercom partition for the Route Partition Name.

The simplified Line input form is presented, showing only the supported Intercom line fields to be configured.

Intercom and non-Intercom lines can both be associated to a single phone.

Associated Intercom lines will also show as "used" in the list view of the Directory Number Inventory menu under Dial Plan Management and its Description in the list will also show as "Intercom Line".

Deleting the phone on the Phones list view will then also show the Intercom line as not in use.

Intercom Lines in Subscriber Management

Navigate to a site hierarchy and choose Subscribers under the Subscriber Management menu for the site.

When adding a phone to a subscriber, to associate an Intercom line to the phone on the Phones tab, also first specify an Intercom partition for the Route Partition Name.

The simplified Intercom Line input form shows only the supported Intercom line fields to be configured.

No new lines can be added as a part of Subscriber management - they are added on the Intercom Lines menu.

Associated Intercom lines will also show as "used" in the list view of the Directory Number Inventory menu under Dial Plan Management and its Description in the list will also show as "Intercom Line".

Deleting the phone on the Phones list view will then also show the Intercom line as not in use.

Model Details: relation/IntercomLineRelation

Title Description Details
External Presentation Info
  • Field Name: externalPresentationInfo
  • Type: Object
  • Cardinality: [0..1]
Presentation Info
  • Field Name: presentationInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
External Presentation Number
  • Field Name: externalPresentationInfo.presentationInfo.externalPresentationNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
External Presentation Name
  • Field Name: externalPresentationInfo.presentationInfo.externalPresentationName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Is Anonymous
  • Field Name: externalPresentationInfo.isAnonymous
  • Type: Boolean
  • Cardinality: [0..1]
ASCII Alerting Name This field provides the same information as the Alerting Name field, but you must limit input to ASCII characters. Devices that do not support Unicode (internationalized) characters display the content of the Alerting Name ASCII field. Caution    Do not use the following strings anywhere in your Alerting Name or ASCII Alerting Name: Alert(—Use of "Alert(" returns a security protocol error. Voicemail—Use of this word can cause Cisco Unity Connection to process the call as a direct call rather than as a forwarded one.
  • Field Name: asciiAlertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 32
Party Entrance Tone From the Party Entrance Tone drop-down list box, choose one of the following options: Default—Use the value that you configured in the Party Entrance Tone service parameter. On—A tone plays on the phone when a basic call changes to a multi-party call; that is, a barge call, cBarge call, ad hoc conference, meet-me conference, or a joined call. In addition, a different tone plays when a party leaves the multi-party call. If the controlling device, that is, the originator of the multi-party call has a built-in bridge, the tone gets played to all parties if you choose On for the controlling device. When the controlling device leaves the call, Cisco Unified Communications Manager identifies whether another device on the call can play the tone; if another device on the call can play the tone, Cisco Unified Communications Manager plays the tone. If the controlling device cannot play the tone, Cisco Unified Communications Manager does not play the tone even if you enable the party entrance tone feature. Off—A tone does not play on the phone when a basic call changes to a multi-party call. Default: Default
  • Field Name: partyEntranceTone
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Search Space Activation Policy Three possible values exist for this option: Use System Default With Configured CSS With Activating Device/Line CSS If you select the With Configured CSS option, the Forward All Calling Search Space that is explicitly configured in the Directory Number Configuration window controls the forward all activation and call forwarding. If the Forward All Calling Search Space is set to None, no CSS gets configured for Forward All. A forward all activation attempt to any directory number with a partition will fail. No change in the Forward All Calling Search Space and Secondary Calling Search Space for Forward All occurs during the forward all activation. If you prefer to utilize the combination of the Directory Number Calling Search Space and Device Calling Search Space without explicitly configuring a Forward All Calling Search Space, select With Activating Device/Line CSS for the Calling Search Space Activation Policy. With this option, when Forward All is activated from the phone, the Forward All Calling Search Space and Secondary Calling Search Space for Forward All automatically gets populated with the Directory Number Calling Search Space and Device Calling Search Space for the activating device. With this configuration (Calling Search Space Activation Policy set to With Activating Device/Line), if the Forward All Calling Search Space is set to None, when forward all is activated through the phone, the combination of Directory Number Calling Search Space and activating Device Calling Search Space gets used to verify the forward all attempt. If you configure the Calling Search Space Activation Policy to Use System Default, then the CFA CSS Activation Policy cluster-wide service parameter determines which Forward All Calling Search space will be used. If the CFA CSS Activation Policy service parameter gets set to With Configured CSS, then Forward All Calling Search Space and Secondary Calling Search Space for Forward All will be used for Call Forwarding. If CFA CSS Activation Policy service parameter gets set to With Activating Device/Line CSS, then Forward All Calling Search Space and Secondary Calling Search Space for Forward All will be automatically populated with the Directory Number Calling Search Space and Device Calling Search Space for the activating device. CFA CSS Activation Policy Service Parameter: Ensure the CFA CSS Activation Policy service parameter that displays in the Clusterwide Parameters (Feature - Forward) section of the Service Parameter Configuration window is set correctly for call forward all to work as intended. The parameter includes two possible values: With Configured CSS (default) With Activating Device/Line CSS When the Calling Search Space Activation Policy is set to Use System Default, the value of the CFA CSS Activation Policy service parameter gets used to determine the Call Forward All CSS. When the option With Configured CSS is selected, the primary and secondary CFA Calling Search Space get used. When the option With Activating Device/Line CSS is selected, the primary and secondary CFA Calling Search Space get updated with primary line Calling Search Space and activating Device Calling Search Space. By default, the value of the CFA CSS Activation Policy service parameter is set to With Configured CSS. Roaming: When a device is roaming in the same device mobility group, Cisco Unified Communications Manager uses the Device Mobility CSS to reach the local gateway. If a user sets Call Forward All at the phone, the CFA CSS is set to None, and the CFA CSS Activation Policy is set to With Activating Device/Line CSS, then: The Device CSS and Line CSS get used as the CFA CSS when the device is in its home location. If the device is roaming within the same device mobility group, the Device Mobility CSS from the Roaming Device Pool and the Line CSS get used as the CFA CSS. If the device is roaming within a different device mobility group, the Device CSS and Line CSS get used as the CFA CSS. Default: Use System Default
  • Field Name: cfaCssPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "With Configured CSS", "With Activating Device/Line CSS"]
Associated Devices
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Associated Devices
  • Field Name: device.[n]
  • Type: Array
Auto Answer Choose one of the following options to activate the Auto Answer feature for this directory number: Auto Answer Off <Default> Auto Answer with Headset Auto Answer with Speakerphone Note    Make sure that the headset or speakerphone is not disabled when you choose Auto Answer with headset or Auto Answer with speakerphone. Note    Do not configure Auto Answer for devices that have shared lines. Default: Auto Answer Off
  • Field Name: autoAnswer
  • Type: String
  • Cardinality: [0..1]
  • Default: Auto Answer Off
  • Choices: ["Auto Answer Off", "Auto Answer with Headset", "Auto Answer with Speakerphone"]
User Hold MOH Audio Source Choose the audio source that plays when a user initiates a hold action.
  • Field Name: userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
E164Alt Num Applicable only for Update and Get Request
  • Field Name: e164AltNum
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Add Local Route Partition
  • Field Name: e164AltNum.addLocalRoutePartition
  • Type: Boolean
  • Cardinality: [0..1]
Is Urgent
  • Field Name: e164AltNum.isUrgent
  • Type: Boolean
  • Cardinality: [0..1]
Advertise Globally Ils Default: True
  • Field Name: e164AltNum.advertiseGloballyIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Route Partition
  • Field Name: e164AltNum.routePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Num Mask
  • Field Name: e164AltNum.numMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Call Forward Not Registered Int
  • Field Name: callForwardNotRegisteredInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call Forward Unregistered Internal Destination Mask This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegisteredInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Call Forward Unregistered Internal voice Mail Enabled This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegisteredInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Unregistered CSS Internal * This field applies to unregistered internal DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegisteredInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Route Partition Choose the partition to which the directory number belongs. Make sure that the directory number that you enter in the Directory Number field is unique within the partition that you choose. If you do not want to restrict access to the directory number, choose <None> for the partition. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions 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 Partitions window, then find and choose a partition name. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters.
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Forward On Failure
  • Field Name: callForwardOnFailure
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Failure Directory Number This field applies only to CTI route points and CTI ports. The settings in this row specify the forwarding treatment for external calls to this CTI route point or CTI port if the CTI route point or CTI port fails. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: callForwardOnFailure.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward CTI Failure Voice Mail Enabled DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
  • Field Name: callForwardOnFailure.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Device Failure Calling Search Space * This field applies only to CTI route points and CTI ports. The settings in this row specify the forwarding treatment for external calls to this CTI route point or CTI port if the CTI route point or CTI port fails. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: callForwardOnFailure.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Default Activated Device Name This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
  • Field Name: defaultActivatedDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Retain this destination in the call forwarding history This setting determines whether the AAR leg of the call will be present in the call forwarding history. If you uncheck the check box, the AAR leg of the call is not present in the call history. If you check the check box, the AAR leg of the call will be present in the call history. By default, the directory number configuration retains the AAR leg of the call in the call history, which ensures that the AAR forward to voice-messaging system will prompt the user to leave a voice message.
  • Field Name: aarKeepCallHistory
  • Type: Boolean
  • Cardinality: [0..1]
Calling Search Space From the drop-down list box, choose the appropriate calling search space. A calling search space comprises a collection of partitions that are searched for numbers that are called from this directory number. The value that you choose applies to all devices that are using this directory number. Changes result in an update of the numbers that the Call Pickup Group field lists. You can configure calling search space for Forward All, Forward Busy, Forward No Answer, Forward No Coverage, and Forward on CTI Failure directory numbers. The value that you choose applies to all devices that are using this directory number. You must configure either primary Forward All Calling Search Space or Secondary Forward All Calling Search Space or both for Call Forward All to work properly. The system uses these concatenated fields (Primary CFA CSS + Secondary CFA CSS) to validate the CFA destination and forward the call to the CFA destination. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the other call forward calling search spaces as well. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. When you forward calls by using the CFwdAll softkey on the phone, the automatic combination of the line CSS and device CSS does not get used. Only the configured Primary CFA CSS and Secondary CFA CSS get used. If both of these fields are None, the combination results in two null partitions, which may cause the operation to fail. If you want to restrict users from forwarding calls on their phones, you must choose a restrictive calling search space from the Forward All Calling Search Space field.
  • Field Name: shareLineAppearanceCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
AAR Destination Mask The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: aarDestinationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 24
  • Pattern: ^[0-9*#+X]{0,24}$
Call Forward Busy
  • Field Name: callForwardBusy
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward Busy External Destination The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward Busy Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusy.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Busy External Calling Search Space * The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for external calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When the Voice Mail check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for external calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy external Calling Search Space is used to forward the call to the Forward Busy External destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Directory Number * Enter a dialable phone number. Values can include route pattern wildcards and numeric characters (0 through 9). Special characters such as a question mark (?), exclamation mark (!), backslash (\), brackets ([ ]), plus sign (+), dash (-), asterisk (*), caret (^), pound sign (#), and an X are also allowable. Special characters that are not allowed are a period (.), at sign (@), dollar sign ($), and percent sign (%). At the beginning of the pattern, enter \+ if you want to use the international escape character +. For this field, \+ does not represent a wildcard; instead, entering \+ represents a dialable digit. Note    When a pattern is used as a directory number, the display on the phone and the caller ID that displays on the dialed phone will both contain characters other than digits. To avoid this, Cisco recommends that you provide a value for Display (Internal Caller ID), Line text label, and External phone number mask. The directory number that you enter can appear in more than one partition. If you configure this field under Call Routing > Directory Number, you can enter insert directory numbers in bulk by entering a range (that is, by entering the beginning directory number in the first field and by entering the ending directory number in the second field); by using this method, you can create up to 500 directory numbers at a time.
  • Field Name: pattern
  • Type: String
  • Cardinality: [1..1]
Pattern Precedence Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Allow Control of Device from CTI Check this check box to allow CTI to control and monitor a line on a device with which this directory number is associated If the directory number specifies a shared line, ensure the check box is enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports. Default: True
  • Field Name: allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Forward No Answer
  • Field Name: callForwardNoAnswer
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Duration Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
  • Field Name: callForwardNoAnswer.duration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Forward No Answer External Destination The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: callForwardNoAnswer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Answer Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: callForwardNoAnswer.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Answer External Calling Search Space * The settings in this row of fields specify the forwarding treatment for external calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an external call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer external Calling Search Space is used to forward the call to the Forward No Answer external destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: callForwardNoAnswer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Hold Reversion Notification Interval (seconds) Enter a number from 0 to 1200 (inclusive) to specify the interval time in seconds for sending periodic reminder alerts to the holding party phone. If you enter a value of 0, Cisco Unified Communications Manager does not send reminder alerts. At installation, this field remains blank. If you leave this setting blank, the Hold Reversion Notification Interval timer setting for the cluster applies. Note    SCCP phones support a minimum Hold Reversion Notification Interval (HRNI) of 5 seconds, whereas SIP phones support a minimum of 10 seconds. SCCP phones set for the minimum HRNI of 5 seconds may experience a Hold Reversion Notification ring delay of 10 seconds when handling calls involving SIP phones.
  • Field Name: hrInterval
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Call Forward No Coverage
  • Field Name: callForwardNoCoverage
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward No Coverage External Destination The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: callForwardNoCoverage.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Coverage External Enabled The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: callForwardNoCoverage.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Coverage External Calling Search Space * The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage external Calling Search Space is used to forward the call to the Forward No Coverage external destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: callForwardNoCoverage.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward Not Registered
  • Field Name: callForwardNotRegistered
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Call Forward Unregistered External Destination This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegistered.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Call Forward Unregistered External Voice Mail Enabled This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegistered.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward Unregistered CSS External * This field applies to unregistered external DN calls. The calls are rerouted to a specified Destination Number or Voice Mail. Note    You must also specify the maximum number of forwards in the Service Parameters Configuration window for a Directory Number.
  • Field Name: callForwardNotRegistered.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
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"]
Reject Anonymous Calls Check this check box to reject all anonymous calls for the DN. Anonymous calls are calls with no caller ID or that have caller ID blocked.
  • Field Name: rejectAnonymousCall
  • Type: Boolean
  • Cardinality: [0..1]
Hold Reversion Ring Duration (seconds) Enter a number from 0 to 1200 (inclusive) to specify the wait time in seconds before issuing a reverted call alert to the holding party phone. If you enter a value of 0, Cisco Unified Communications Manager does not invoke the reverted call feature for a held call. At installation, this field remains blank. If you leave this setting blank, the Hold Reversion Duration timer setting for the cluster applies.
  • Field Name: hrDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Alerting Name Enter a name that you want to display on the phone of the caller when the called phone is ringing. This setting, which supports the Identification Services for the QSIG protocol, applies to shared and nonshared directory numbers. When the phone rings at the terminating PINX, if you configured an alerting name for a directory number with shared-line appearances, the system performs the following tasks: Forwards the alerting name of the called party, if configured, to the caller. Applies the Connected Name Restrictions (CONR) that are configured for the translation pattern (if restrictions exist) Depending on the state of the call and your configuration, the alerting name, directory number, or display (internal caller ID) configuration may display on the phone, as described in the following bullets. Alerting state—The alerting name displays, as configured in the Directory Number window. Connected state—If you configure the Display (Internal Caller ID) and the Alerting Name fields, the display (internal caller ID) name displays. Connected State—If you configured the Alerting Name field but not the Display (Internal Caller ID) field, the directory number displays. If you set the Always Display Original Dialed Number service parameter to True, the original dialed number and the alerting name displays during the call. You can choose if the alerting name for the original dialed number or the translated dialed number is displayed using the Cisco CallManager service parameter called Name Display for Original Dialed Number When Translated. The default setting displays the alerting name of the original dialed number before translation. Caution    Do not use the following strings anywhere in your Alerting Name or ASCII Alerting Name: Alert(—Use of "Alert(" returns a security protocol error. Voicemail—Use of this word can cause Cisco Unity Connection to process the call as a direct call rather than as a forwarded one.
  • Field Name: alertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Enterprise Alt Num Applicable only for Update and Get Request
  • Field Name: enterpriseAltNum
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Add Local Route Partition
  • Field Name: enterpriseAltNum.addLocalRoutePartition
  • Type: Boolean
  • Cardinality: [0..1]
Is Urgent
  • Field Name: enterpriseAltNum.isUrgent
  • Type: Boolean
  • Cardinality: [0..1]
Advertise Globally Ils Default: True
  • Field Name: enterpriseAltNum.advertiseGloballyIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Route Partition
  • Field Name: enterpriseAltNum.routePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Num Mask
  • Field Name: enterpriseAltNum.numMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Description Enter a description of the directory number and route partition. 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: description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
AAR Voice Mail Enabled The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: aarVoiceMailEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Use E164Alt Num In the text box, enter a number mask for the enterprise alternate number or +E.164 alternate number. This field can contain only digits 0-9, X and the plus sign (+). If the Number Mask contains a plus sign, the plus sign must be the first character in the mask. Refer to the Alternate Number field to see how the alternate number appears after the mask is applied. Cisco Unified Communications Manager applies the mask to the directory number and creates an enterprise alternate number or +E.164 alternate number that acts as an alias for the directory number. Other phones can dial this directory number by dialing the enterprise number. Enterprise Alternate Number Example If you apply a number mask of 8XXXX to directory number 2000, Cisco Unified Communications Manager creates an enterprise alternate number 82000 as an alias of directory number 2000. If the dialed digits of an incoming call are 82000, Cisco Unified Communications Manager routes the call to the user that is registered to directory number 2000. +E.164 Alternate Number Example If you apply a number mask of 1972515XXXX to directory number 2000, Cisco Unified Communications Manager creates an +E.164 alternate number 19725152000 as an alias of directory number 2000. If the dialed digits of an incoming call are 19725152000, Cisco Unified Communications Manager routes the call to the user that is registered to directory number 2000.
  • Field Name: useE164AltNum
  • Type: Boolean
  • Cardinality: [0..1]
Call Control Agent Profile Select the Call Control Agent Profile to associate to the directory number user. Configure a Call Control Agent Profile from the Advanced Features > Call Control Agent Profile menu.
  • Field Name: callControlAgentProfile
  • Type: String
  • Cardinality: [0..1]
Calling Search Space No Retrieve Internal When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveIntCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Park Monitoring Forward No Retrieve Destination External When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Calling Search Space No Retrieve External When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Forward No Coverage Int
  • Field Name: callForwardNoCoverageInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward No Coverage Internal Destination The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage internal Calling Search Space is used to forward the call to the Forward No Coverage internal destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: callForwardNoCoverageInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Coverage Internal Enabled The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting specifies the directory number to which an internal nonconnected call is forwarded when an application that controls that directory number fails. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Coverage internal Calling Search Space is used to forward the call to the Forward No Coverage internal destination. This setting applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Coverage destination, you should also configure the Forward No Coverage Calling Search Space. If you do not configure the Forward No Coverage Calling Search Space, and the Forward No Coverage destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, choose a different setting in the Calling Search Space for external calls.
  • Field Name: callForwardNoCoverageInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Coverage Internal Calling Search Space *
  • Field Name: callForwardNoCoverageInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Park Monitoring Reversion Timer This parameter determines the number of seconds that Cisco Unified Communications Manager waits before prompting the user to retrieve a call that the user parked. This timer starts when the user presses the Park softkey on the phone, and a reminder is issued when the timer expires. The default is 60 seconds. Note    If you configure a non-zero value, this value overrides the value of this parameter set in the Service Parameters window. However, if you configure a value of 0 here, then the value in the Service Parameters window will be used.
  • Field Name: parkMonReversionTimer
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Release Clause Default: No Error
  • Field Name: releaseClause
  • Type: String
  • Cardinality: [0..1]
  • Default: No Error
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Park Monitoring Forward No Retrieve Destination Internal When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveIntDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#+X]{0,50}$
Call Forward All
  • Field Name: callForwardAll
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Secondary Calling Search Space for Forward All Because call forwarding is a line-based feature, in cases where the device calling search space is unknown, the system uses only the line calling search space to forward the call. If the line calling search space is restrictive and not routable, the forward attempt fails. Addition of a secondary calling search space for Call Forward All provides a solution to enable forwarding. The primary calling search space for Call Forward All and secondary calling search space for Call Forward All get concatenated (Primary CFA CSS + Secondary CFA CSS). Cisco Unified Communications Manager uses this combination to validate the CFA destination and to forward the call. See the description for the Calling Search Space field for information about how the combination of Primary and Secondary CFA CSSs works
  • Field Name: callForwardAll.secondaryCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Forward All Destination The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: callForwardAll.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward All Voice Mail Enabled The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: callForwardAll.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward All Calling Search Space * The settings in this row of fields specify the forwarding treatment for calls to this directory number if the directory number is set to forward all calls. The Calling Search Space field gets used to validate the Forward All destination that is entered when the user activates Call Forward All from the phone. This field also gets used to redirect the call to the Call Forward All destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting indicates the directory number to which all calls are forwarded. Use any dialable phone number, including an outside destination. Calling Search Space—This setting applies to all devices that are using this directory number.
  • Field Name: callForwardAll.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Park Mon Forward No Retrieve Vm Enabled When the parkee is an external party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an external party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveVmEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Active To view this check box on the Directory Number Configuration window, access an unassigned directory number from the Route Plan Report window. Checking this check box allows calls to this DN to be forwarded (if forwarding is configured). If check box is not checked, Cisco Unified Communications Manager ignores the DN. Default: True
  • Field Name: active
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Voice Mail Profile Choose from list of Voice Mail Profiles that the Voice Mail Profile Configuration defines. The first option specifies <None>, which represents the current default Voice Mail Profile that is configured in the Voice Mail Profile Configuration.
  • Field Name: voiceMailProfileName
  • Type: ["String", "Null"]
  • Target: device/cucm/VoiceMailProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Use Enterprise Alt Num Click Add Enterprise Alternate Number to add an enterprise alternate number and associate it to this directory number. Click Add +E.164 Alternate Number to add an +E.164 alternate number and associate it to this directory number.
  • Field Name: useEnterpriseAltNum
  • Type: Boolean
  • Cardinality: [0..1]
Pstn Failover
  • Field Name: pstnFailover
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["", "Enterprise Number", "+E.164 Number"]
BLF Presence Group Configure this field with the BLF Presence feature. From the drop-down list box, choose a BLF Presence group for this directory number. The selected group specifies the devices, end users, and application users that can monitor this directory number. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. Presence groups that are configured in Cisco Unified Communications Manager Administration also appear in the drop-down list box. BLF Presence authorization works with presence groups to allow or block presence requests between groups.
  • Field Name: presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Directory UR Is While updating, send all the URIs
  • Field Name: directoryURIs
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Directory Uri
  • Field Name: directoryUri.[n]
  • Type: Array
Is Primary *
  • Field Name: directoryURIs.directoryUri.[n].isPrimary
  • Type: Boolean
  • Cardinality: [1..1]
Uri *
  • Field Name: directoryURIs.directoryUri.[n].uri
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Advertise Globally Via Ils Default: True
  • Field Name: directoryURIs.directoryUri.[n].advertiseGloballyViaIls
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Partition *
  • Field Name: directoryURIs.directoryUri.[n].partition
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward Busy Int
  • Field Name: callForwardBusyInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Forward Busy Internal Destination The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusyInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward Busy Internal Enabled The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusyInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward Busy Internal Calling Search Space * The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number is busy. See the description for the Busy Trigger field for information on when a line is considered busy. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window for internal calls. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the call forward busy destination for internal calls. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward Busy internal Calling Search Space is used to forward the call to the Forward Busy Internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward Busy Destination, you should also configure the Forward Busy Calling Search Space. If you do not configure the Forward Busy Calling Search Space and the Forward Busy destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box.
  • Field Name: callForwardBusyInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Pickup Group Choose the number that can be dialed to answer calls to this directory number (in the specified partition).
  • Field Name: callPickupGroupName
  • Type: ["String", "Null"]
  • Target: device/cucm/CallPickupGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Hold MOH Audio Source Choose the audio source that plays when the network initiates a hold action.
  • Field Name: networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Pattern Urgency If the dial plan contains overlapping patterns, Cisco Unified Communications Manager does not route the call to the device associated with the directory number until the interdigit timer expires (even if the directory number is a better match for the sequence of digits dialed as compared to the overlapping pattern). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately to the device associated with the directory number. By default, the Urgent Priority check box is unchecked.
  • Field Name: patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
AAR Group The settings in this row of fields specify treatment of calls for which insufficient bandwidth exists to reach the destination. Automated alternate routing (AAR) handles these calls that are routed to the AAR Destination Mask or Voice Mail. Configure the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Coverage/Destination box and Calling Search Space. AAR Destination Mask—Use this setting instead of the external phone number mask to determine the AAR Destination to be dialed. AAR Group—This setting provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None indicates that no rerouting of blocked calls will be attempted.
  • Field Name: aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Park Mon Forward No Retrieve Int Vm Enabled When the parkee is an internal party, the call will be forwarded to the specified destination in this field. If this field value is empty, the parkee will be redirected to the parker’s line. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Destination—This setting specifies the directory number to which a parked call (from an internal party) is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: parkMonForwardNoRetrieveIntVmEnabled
  • Type: Boolean
  • Cardinality: [0..1]
Call Forward Alternate Party
  • Field Name: callForwardAlternateParty
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
MLPP No Answer Ring Duration (seconds) Enter the number of seconds (between 4 and 60) after which an MLPP precedence call will be directed to this directory number alternate party if this directory number and its call-forwarding destination have not answered the precedence call. Leave this setting blank to use the value that is set in the Cisco Unified Communications Manager enterprise parameter, Precedence Alternate Party Timeout.
  • Field Name: callForwardAlternateParty.duration
  • Type: Integer
  • Cardinality: [0..1]
Target (Destination) Enter the number to which MLPP precedence calls should be diverted if this directory number receives a precedence call and neither this number nor its call forward destination answers the precedence call. Values can include numeric characters, octothorpe (#), and asterisk (*).
  • Field Name: callForwardAlternateParty.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
MLPP Calling Search Space * From the drop-down list box, choose the calling search space to associate with the MLPP alternate party target (destination) number.
  • Field Name: callForwardAlternateParty.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Call Forward No Answer Int
  • Field Name: callForwardNoAnswerInt
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
No Answer Ring Duration (seconds) Used in conjunction with Call Forward No Answer Destination, this field sets the timer for how long the phone will ring before it gets forwarded. Leave this setting blank to use the value that is set in the Cisco CallManager service parameter, Forward No Answer Timer. Caution    By default, Cisco Unified Communications Manager makes the time for the T301 timer longer than the No Answer Ring Duration time; if the set time for the T301 timer expires before the set time for the No Answer Ring Duration expires, the call ends, and no call forwarding can occur. If you choose to do so, you can configure the time for the No Answer Ring Duration to be greater than the time for the T301 timer. For information on the T301 timer, choose System > Service Parameters; choose the server, the Cisco CallManager service, and then the parameter in the window that displays.
  • Field Name: callForwardNoAnswerInt.duration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Forward No Answer Internal Destination
  • Field Name: callForwardNoAnswerInt.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Forward No Answer Internal Enabled The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an internal call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer internal Calling Search Space is used to forward the call to the Forward No Answer internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: callForwardNoAnswerInt.forwardToVoiceMail
  • Type: Boolean
  • Cardinality: [0..1]
Forward No Answer Internal Calling Search Space * The settings in this row of fields specify the forwarding treatment for internal calls to this directory number if the directory number does not answer. The call forward destination and Calling Search Space field get used to redirect the call to the forward destination. Specify the following values: Voice Mail—Check this check box to use settings in the Voice Mail Profile Configuration window. Note    When this check box is checked, the calling search space of the voice mail pilot gets used. Cisco Unified Communications Manager ignores the settings in the Destination box and Calling Search Space. Note    When this check box is checked for internal calls, the system automatically checks the Voice Mail check box for external calls. If you do not want external calls to forward to the voice-messaging system, you must uncheck the Voice Mail check box for external calls. Destination—This setting indicates the directory number to which an internal call is forwarded when the call is not answered. Use any dialable phone number, including an outside destination. Note    When you enter a destination value for internal calls, the system automatically copies this value to the Destination field for external calls. If you want external calls to forward to a different destination, you must enter a different value in the Destination field for external calls. Calling Search Space—The Forward No Answer internal Calling Search Space is used to forward the call to the Forward No Answer internal destination. It applies to all devices that are using this directory number. Note    If the system is using partitions and calling search spaces, Cisco recommends that you configure the forward calling search spaces. When a call is forwarded or redirected to the call forward destination, the configured call forward calling search space gets used to forward the call. If the forward calling search space is None, the forward operation may fail if the system is using partitions and calling search spaces. For example, if you configure the Forward No Answer destination, you should also configure the Forward No Answer Calling Search Space. If you do not configure the Forward No Answer Calling Search Space, and the Forward No Answer destination is in a partition, the forward operation may fail. Note    When you choose a Calling Search Space for internal calls, the system automatically copies this setting to the Calling Search Space setting for external calls. If you want external calls to forward to a different calling search space, you must choose a different setting in the Calling Search Space drop-down list box for external calls.
  • Field Name: callForwardNoAnswerInt.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Id Presentation When Diverted Default: Default
  • Field Name: callingIdPresentationWhenDiverted
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Allowed", "Restricted"]
External Call Control Profile
  • Field Name: externalCallControlProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ExternalCallControlProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Dataline
  • Field Name: dataline
  • Type: Object
pattern
  • Field Name: dataline.pattern
  • Type: String
partition
  • Field Name: dataline.partition
  • Type: String
Phones
  • Field Name: phones.[n]
  • Type: Array
Device Profile
  • Field Name: deviceprofile.[n]
  • Type: Array
Remote Destination Profiles
  • Field Name: rdp.[n]
  • Type: Array