[Index]

Model: relation/CallhandlerREL

Auto Attendant Call Handler Service

Full HTML Help

Overview

A Cisco Unified Communications Manager (CUCM) Auto-Attendant Call Handler transfers incoming calls to the extension of a user or department without the intervention of an operator, via a system of voice menus that the caller interacts with, using their telephone keypad or voice commands.

Note

Auto-Attendant is a comprehensive service that provides for the provisioning, configuration, and management of Call Handlers, greetings, schedules, and related dialplan components in Cisco Unity Connection (CUC) and Cisco Unified Communications Manager (CUCM).

Some Call Handler systems are comprised of message-only information menus and voice menus, which allow organizations to provide business information such as hours, directions to their premises, or to answer other frequently-asked questions. Once the message plays, the caller can be forwarded to an operator, or they can choose to return to the main menu.

Call Handlers can be created at the Customer hierarchy or the Site hierarchy in VOSS Automate:

Created at Customer You must select a Network Device List (NDL), which then instructs the workflow which UC Application servers to provision.
Created at Site The NDL associated to the site is chosen automatically.

Related Topics

Manage Greeting Files in the Core Feature Guide

Call Handler (Auto Attendant) Schedule in the Core Feature Guide

Create a Call Handler (Auto Attendant) Schedule in the Core Feature Guide

Modify a Call Handler (Auto Attendant) Schedule in the Core Feature Guide

Add a Language Filter in the Core Feature Guide

Add a TimeZone Filter in the Core Feature Guide

Call Handlers and Shared Numbers

VOSS Automate allows you to share the same directory number (DN) between a Call Handler and one or more device types (phone, SNR, EM), provided you're using different line partitions between the Call Handler and the device types.

Note

SNR is short for Single Number Reach device. EM is short for Extension Mobility device. Device can include, for example, desk phone, BOT.

Shared Number Scenarios for Call Handler

Overview

This section describes scenarios for number sharing between Call Handler and one or more device types and how this changes the status and usage values for the number in the number inventory.

The following scenarios are described:

Note

Status defines whether the number is available to be assigned (or shared) between Call Handler and one or more devices. Usage value is added to the line details in the directory number inventory.

When adding a Call Handler, all numbers available for the Call Handler (whether shared or not) display in the Pilot drop-down. See Add Auto Attendant Call Handler Service

When a number is currently used exclusively by Call Handler (not shared with a device), the status and usage detail for that number is as follows:

Status Usage
Used-Utility Call_Handler_Pilot

When a number is currently used exclusively by a device (not shared with Call Handler), the status and usage detail for that number is as follows:

Status Usage
Used Device

Add Devices to a Number with an Existing Call Handler

In this scenario, Call Handler is added first and is assigned to a number. Then you can add additional devices (e.g. deskphone, BOT, EM, SNR) with the same number.

Scenario Before adding devices After adding devices
Add devices to a number already assigned to Call Handler
  • Status: "Used-Utility"
  • Usage:
    • "Call_Handler_Pilot", or
    • "Call_Handler_Pilot, Device"
  • Status: "Used"
  • Usage: "Call_Handler_Pilot,Device"

Add a Call Handler to a Number with Existing Devices

In this scenario, one or more device types (device, EM, SNR) were added first to a number, then you add the same number to Call Handler.

Scenario Before adding Call Handler After adding Call Handler

Add Call Handler to a number already assigned to devices

Scenario also applies if Call Handler was added with with a different number, then you change the Call Handler number to one that is used by devices.
  • Status: "Used"
  • Usage: "Device"
  • Status: "Used-Utility"
  • Usage: "Call_Handler_Pilot,Device"

Remove Call Handler from a Number Previously Shared Between Call Handler and Devices

In this scenario, you have a number that is currently shared between Call Handler and one or more devices. Now you remove Call Handler from the number.

Scenario Existing Status / Usage Updated Status / Usage
Where Call Handler was added first, and then devices were added. Now you delete the Call Handler or change the number it uses.
  • Status: "Used"
  • Usage: "Call_Handler_Pilot,Device"
  • Status: "Used"
  • Usage: "Device"
Where devices were added to a number first, and then Call Handler was added. Now you delete Call Handler or change the number it uses.
  • Status: "Used-Utility"
  • Usage: "Call_Handler_Pilot,Device"
  • Status: "Used"
  • Usage: "Device"

Remove Devices from a Number Previously Shared Between Call Handler and Devices

In this scenario, Call Handler was added first, then you added devices (one or more) to that number. Now you remove devices.

In this case, number status and usage depends on whether there was only one device and you remove it, or whether there are multiple devices, and you remove one device from the number shared with Call Handler.

Scenario Existing Status / Usage Updated Status / Usage

Call Handler was added first. One device (e.g. a phone) shares a number with Call Handler.

You delete that one device, or you update that device to remove the number (e.g. update phone to use a new line, or remove line from phone).
  • Status: "Used"
  • Usage: "Call_Handler_Pilot,Device"
  • Status: "Used-Utility"
  • Usage: "Call_Handler_Pilot"

Call Handler was added first. Two or more devices are then added to the shared number (e.g. two phones using the same number).

One device is deleted (e.g. delete phone), or you update one device to remove the number (e.g. update phone to use a new line, or remove line from phone).
  • Status: "Used"
  • Usage: "Call_Handler_Pilot,Device"
  • Status: "Used"
  • Usage: "Call_Handler_Pilot,Device"

Manage Auto-Attendant Call Handlers

This section describes how to add, update, or delete an Auto-Attendant Call Handler in VOSS Automate and Cisco Unity Connection (CUC).

Note

Some of the configuration parameters required to provision the Call Handler are defined via the configuration templates and are not exposed in the user interface. For example, the following settings are hardcoded in the AddCucmRoutePatternForCallhandlerCFT configuration template:

To change these settings or any other values defined via the configuration template, clone the template (via Customizations > Configuration Templates) to the relevant hierarchy level, and edit the fields as required.

Add a Call Handler

This procedure adds a Call Handler.

Before you start:

To add a Call Handler:

  1. Log in to the Admin Portal as Provider, Reseller, or Customer administrator.

  2. Choose the relevant hierarchy, either Customer or Site.

  3. Go to (default menus) Services > Auto Attendant > Call Handler.

  4. Click Add.

    Note

    The Call Handler/New Record page opens at the Call Handler Basics tab. All other tabs on this page remain read-only until you configure the initial settings on this tab. Once you've saved the new call handler, you can edit these settings. See Modify an Auto Attendant Call Handler Service

  5. Mandatory. At Network Device List, choose the required network device list (NDL).

    Note

    This field is auto-populated and read-only if you're adding the call handler at site level.

  6. Mandatory. At Name, enter a name for the new Call Handler.

  7. At Call Handler Template, choose the CUC Call Handler template.

    Note

    For more information about the Call Handler template, see the "Call Handler Templates" section of the "Call Management" chapter of the System Administration Guide for Cisco Unity Connection, Release 11.x.

  8. Optional. At Pilot, choose a directory number to associate with the Call Handler.

    Note

    The drop-down displays the list of directory numbers available at the selected hierarchy. This can include numbers already assigned to one or more device types, since VOSS Automate allows sharing of numbers between Call Handler and multiple device types. See Auto Attendant Call Handler Service

  9. At Do not add Route Pattern define whether to remove the mandatory requirement for adding a route list (if you've chosen a pilot).

    Note

    • When enabled, (checkbox selected), choosing a route list (route pattern) is optional.
    • When disabled (default), choosing a route list (route pattern) is mandatory.

    This setting is relevant when adding or updating a Call Handler.

  10. At Route List, choose a CUCM route list for the new Call Handler.

    Note

    • Optional when Do not add Route Pattern is enabled.
    • The NDL determines the route lists available in this drop-down. If the NDL is updated, route list options are updated.

  11. Click Save.

    Note

    • Adding a Call Handler through VOSS Automate also adds a route pattern on the CUCM designated in the NDL (if Do not add Route Pattern is disabled, and you've chosen a route list and a pilot for the Call Handler). The pattern is the value of the pilot (directory number) you choose.
    • A configuration template (which can be cloned and modified) defines the rest of the pilot configuration (including partition).
    • A direct routing rule is also created on the CUC designated in the NDL. This rule accepts inbound calls into CUC, and routes them to the relevant Call Handler.

Update a Call Handler

To update a Call Handler:

  1. Log in as Provider, Reseller, or Customer administrator.
  2. Choose the relevant hierarchy.
  3. Go to (default menu) Services > Auto Attendant > Call Handler.
  4. In the list view, click the relevant Call Handler to open the Call Handler page.
  5. Click through the following tabs, and update settings as required:
Tab Description
Call Handler Basics

Only this tab is enabled when adding a Call Handler. All tabs are available when updating a Call Handler.

  • Do not add Route Pattern (disabled by default) defines whether to remove the mandatory requirement for choosing a route list (if you've chosen a pilot).
    • When disabled, you must choose a route list if you've selected a pilot
    • When enabled, choosing a route list is hidden and no longer required (even if you've chosen a pilot)
  • Call Handler Owner - choose the CUC user to associate with the owner of the Call Handler.
Transfer Rules tab

Enables/disables transfer rules.

  • The Standard transfer rule can't be disabled.
  • By default, Transfer Call To is set to Greeting. When changing this setting to Extension or URl, you can specify an extension number or URl, and a transfer type (either Release to Switch or Supervise Transfer)
Caller Input tab Configures the default caller. Additional settings become available as you choose options on this tab. For example, choosing User with Mailbox (from the Action drop-down in Callhandler Menu Entry) displays the Transfer/Greeting drop-down.
Greetings tab Configures greeting settings.
Record/Playback tab

Configures the greeting you want to record and playback on the chosen extension. You can trigger a call to a physical device, which allows for recording or playback of a greeting. The extension to dial must be an accessible extension for the administrator (or user) to answer and record or listen to greetings

  • At Extension, choose an extension, or manually type in the number of the device you want to call to record or listen to a greeting.
  • To record or playback a greeting for a specific purpose, select the Specific Greeting checkbox; else, the action applies to the main Call Handler.
  • At Duration (seconds), specify a time period (in seconds) that the system allows for recording a greeting. This time duration does not apply when playing back a recording. Ensure you set this timer appropriately. Setting it too low may result in an incorrect configuration.
  • Before saving the settings on this tab, go to Action > Record Greeting, or to Action > Playback Greeting (as applicable) to record or playback the greeting you wish to use.
Upload Greeting tab At Greeting File, choose the greeting file (.wav) to upload to the Call Handler. Then configure the specific greeting (if required).

  1. Click Save.

    Changes are saved to the Call Handler in VOSS Automate and in Cisco Unity Connection (CUC).

Delete a Call Handler

To delete a Call Handler, click on the Call Handler you want to delete; then, click Delete. On the pop-up, click Yes to confirm.

If this Call Handler is using a number shared with one or more additional device types, see Auto Attendant Call Handler Service to understand how the status and usage description of the number may change when you delete the Call Handler.

Call Handler Page

This section provides more information about the information required in the tabs and fields when adding or editing a Call Handler.

Call Handler Basics Tab

This tab configures base information for the Call Handler.

Title Field Name Description
Network Device List * HF.target_ndl Mandatory input-field for the option (if hierarchy is at Site-node, however, this value is derived automatically). The workflow (and GUIRules) will target the UC devices that is linked to this Network Device List (NDL). In the Mod use-case, this should also be derived automatically and can thus be omitted from Updates.
Cisco Unity Connection HF.cuc_info Informative (non-input) field. Indicates the target CUCx host/IP, which is automatically derived from the input NDL.
Cisco Unified CM HF.cucm_info Informative (non-input) field. Indicates the target CUCM host/IP, which is automatically derived from the input NDL.
Name * DisplayName The text name of the handler to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting Call Handler is "Opening Greeting."
Route List route_list The CUCM Route List to use. The valid options are dependent on the selected NDL/CUCM. console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting Call Handler is "Opening Greeting."
Pilot DtmfAccessId

The DTMF access id (i.e., extension) for the call handler. The dialable number.

When adding a call handler, all numbers available for the call handler (whether shared or not) display in the Pilot drop-down.

Removing a pilot number from a call handler changes the number's status to Available in the Internal Number Inventory (INI).
Call Handler Template cuc_template Select the Unity Template for Call Handler.

Note

If the pilot number is shared between the Call Handler and one or more additional device types, see Auto Attendant Call Handler Service to understand the status of numbers available to assign to the Call Handler.

Transfer Rules Tab

This tab configures transfer rules for the Call Handler, for example, the system behavior to transfer a call to an alternative number.


Title Field Name Description
Message callerInput_tab_message Caller Input
Callhandler Menu Entry CallhandlerMenuEntry.[n]  
Object Id ObjectId The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.
Call Handler * CallHandlerObjectId The unique identifier of the CallHandler object to which this menu entry belongs.
Touchtone Key TouchtoneKey The character on the touch-tone keypad that this menu entry corresponds to ( * , #, 0,1...9).
Ignore Additional Input (Locked) Locked A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key. Values: 0: Additional input accepted 1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key.
Call Action Action The type of call action to take, e.g., hang-up, goto another object, etc.
Extension or URI TransferNumber This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Description DisplayName This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Transfer Type TransferType This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Rings to Wait for TransferRings This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Target Conversation TargetConversation The name of the conversation to which the caller is routed.
Target Handler Object Id TargetHandlerObjectId The unique identifier of the specific object to send along to the target conversation.

Caller Input Tab

This tab defines the Call Handler behavior for caller input and navigation.


The table describes fields on this tab:

Field Description
Wait for Additional Digits (milliseconds) The amount of time (in milliseconds) that Cisco Unity Connection (CUC) waits for additional input after a caller presses a single, unlocked key. If there's no input within this time, CUC performs the action assigned to the key.
Enable Prepend Digits to Dialed Extensions Defines whether to prepend digits when dialing an extension number to transfer to.
Digits to Prepend The touch-tone digits to prepend to the extension when dialing the transfer number.

Note

These fields are exposed automatically in the default FDP for relation/CallhandlerREL. If the FDP has been customized, you'll need to expose these fields manually by exposing the following field names: OneKeyDelay, EnablePrependDigits, PrependDigits

The table describes options in the Call Handler Menu Entry fieldsets:

Title Field Name Description
Message callerInput_tab_message  
Callhandler Menu Entry CallhandlerMenuEntry.[n]  
Object Id ObjectId The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.
Call Handler * CallHandlerObjectId The unique identifier of the Call Handler object to which this menu entry belongs.
Touchtone Key TouchtoneKey The character on the touch-tone keypad that this menu entry corresponds to ( * , #, 0,1...9).
Ignore Additional Input (Locked) Locked A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key. Values: 0: Additional input accepted 1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key.
Call Action Action The type of call action to take, e.g., hang-up, goto another object, etc.
Extension or URI TransferNumber This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Description DisplayName This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Transfer Type TransferType This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Rings to Wait for TransferRings This setting only applies if "Call Action" is set to 'Transfer to Alternate Contact Number'.
Target Conversation TargetConversation The name of the conversation to which the caller is routed.
Target Handler Object Id TargetHandlerObjectId The unique identifier of the specific object to send along to the target conversation.

Greetings Tab

This tab configures the behavior and type of greetings enabled in the Call Handler.


Title Field Name Description
Message greetings_tab_message  
Greeting Greeting.[n]  
Greeting Type Enabled The type of greeting, e.g. "Standard," "Off Hours," "Busy," etc.
Enabled Enabled If TimeExpires is set, this field is ignored.
Time Expires TimeExpires The date and time when the greeting rule expires. The greeting rule is considered not expired (enabled), if the value is NULL or a future date. The greeting rule is considered expired (disabled), the value is in the past.
Callers Hear PlayWhat The source for the greeting when this greeting is active.
Play the "Record Your Message at the tone" Prompt PlayRecordMessage Prompt A flag indicating whether the "Record your message at the tone?" prompt prior to recording a message.
Callers See My Personal Recording EnablePersonal VideoRecording It will Enable the Personal video Recording in CUCA.
Callers See Play the "Record Your Message at the Tone" Prompt PlayRecordVideo MessagePrompt A flag indicating whether the "Record your message at the tone?" prompt prior to Video recording a message.
Ignore Caller Input During Greeting IgnoreDigits A flag indicating whether Cisco Unity Connection takes action in response to touchtone keys pressed by callers during the greeting.
Allow Transfers to Numbers Not Associated with Users or Call Handlers EnableTransfer A flag indicating when an extension is dialed at the greeting and the extension is not available whether to transfer to another extension.
Times to Re-prompt Caller Reprompts The number of times to reprompt a caller. After the number of times indicated here, Cisco Unity Connection performs the after-greeting action.
Delay between Re-prompts RepromptDelay The amount of time (in seconds) that Cisco Unity Connection waits without receiving any input from a caller before Cisco Unity Connection prompts the caller again.
Title Field Name Description
After Greeting AfterGreetingAction The type of call action to take, for example, hang-up, goto another object, etc.
After Greeting Target Conversation AfterGreetingTarget Conversation The name of the conversation to which the caller is routed.
After Greeting Target Handler Object Id AfterGreetingTarget HandlerObjectId The unique identifier of the specific object to send along to the target conversation.
Call Handler Object Id CallHandlerObjectId The unique identifier of the Call Handler object to which this greeting rule belongs.
Callhandler URI CallhandlerURI  
Greeting Stream Files URI GreetingStreamFilesURI  
Greetings Type GreetingType The type of greeting, e.g. "Standard," "Off Hours," "Busy," etc.
URI URI  

Record/Playback Tab

This tab configures message recording and playback for the Call Handler.


Title Field Name Description
Message RecordPlayback.note A special interface, which allows administrators to trigger a call to a physical device, which allows for recording or playback of a greeting. The extension to dial must be an accessible extension for the admin (or user) to answer and record or listen to greetings.
Call Handler Name RecordPlayback.call_handler Call Handler Name.
Extension RecordPlayback.extension Extension to Record message on.
Specific Greeting RecordPlayback.specific_greeting The unique identifier of the Call Handler object to which this menu entry belongs.
Greetings RecordPlayback.greeting Greetings.
Duration RecordPlayback.duration Duration to allow enough time to make recording/playback.

Upload Greeting Tab

On this tab you can upload a greeting for the Call Handler.


Title Field Name Description
Message note Upload a greeting to the selected Call Handler.
Greeting File Upload.filename Call Handler Name.
Call Handler Name Upload.call_handler Call Handler Name.
Specific Greeting Upload.specific_greeting Specific Greeting.
Greetings Upload.greeting Greetings.

Add Call Handler (Auto Attendant)

Before You Begin

Make sure that the relevant Cisco Unity Connection Call Handler template has been synced from Cisco Unity Connection.

Note

Not all the configuration parameters needed to provision the Call Handler are exposed in the user interface. Many settings and values are derived from Configuration Templates, i.e. Provide Outside Dial Tone = False, and Call Classification = OnNet are hard coded in the AddCucmRoutePatternForCallhandlerCFT configuration template. If you want to change these, or other values, clone the configuration template from Customizations > Configuration Templates to the desired hierarchy level, and edit the fields as required.

Procedure

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

  2. Make sure that the hierarchy path is set to the required Customer or Site node.

  3. Choose Services > Auto Attendant > Call Handler.

  4. Click Add to add a Call Handler.

  5. From the Hierarchy drop-down, choose the Site to which you want to add the Call Handler (if not already done).

  6. From the Network Device List drop-down, choose the required network device list (NDL). This is a mandatory field. This field is only applicable at the customer node, and the value is derived automatically at the site node.

  7. Enter a Name for the Call Handler. This is a mandatory field.

  8. Optionally enter a number from the Pilot drop-down that you want to associate the Call Handler. The drop-down list displays a list of directory numbers that are available at the selected hierarchy level.

  9. If a Pilot number is added, the Route List input field is shown to choose the Cisco Unified CM route list to apply to the Call Handler.

    The route lists available in the drop-down are determined by the NDL. If the NDL changes, the drop-down list auto updates to display new route lists based on the updated NDL.

  10. From the Call Handler Template drop-down, choose the Cisco Unity Connection Call Handler Template to apply to the Call Handler.

    For detailed information about the call handler template, see the "Call Handler Templates" section of the "Call Management" chapter of the System Administration Guide for Cisco Unity Connection, Release 11.x.

  11. Click Save to add the Call Handler to VOSS-4-UC and Cisco Unity Connection.

  12. Optionally, edit the Call Handler settings, see Modify an Auto Attendant Call Handler Service.

Adding a Call Handler through VOSS-4-UC, also adds a Route Pattern on the Cisco Unified CM designated in the NDL. The pattern is the value of the pilot selected. The rest of the pilot configuration (including partition), is driven through a configuration template that can be cloned and modified. A Direct Routing Rule is also created on the Cisco Unity Connection designated in the NDL, during this step. This rule will accept inbound calls into Cisco Unity Connection, and route them to the relevant Call Handler.

Modify a Call Handler (Auto Attendant)

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

  2. Make sure that the hierarchy path is set to the correct hierarch level.

  3. Choose Services > Auto Attendant > Call Handler.

  4. Click the Call Handler that you want to modify.

  5. From the Call Handler Basics tab, edit the settings from the following drop-downs if required: Pilot, Time Zone, Schedule, Phone System, Language, Partition Name and Call Handler Owner.

  6. From the Transfer Rules tab, enable or disable the required transfer rules. Note that the Standard transfer rule can not be disabled.

    By default the Transfer Call To action is set to Greeting. If the action is changed to Extension or URl, additional controls are exposed that allow you to enter an extension number or URl as well as the transfer type (Release to Switch or Supervise Transfer).

  7. From the Caller Input and Greetings tabs respectively, edit the default caller input and greeting settings.

    Additional fields are exposed when choosing certain options. For example, when you choose the User with Mailbox call action on the Caller Input tab, the User with Mailbox and Transfer / Greeting fields are exposed.

    Refer to "System Call Handlers" in the "Cisco Unity Connection System Administration Guide" for more information about the Call Handler feature.

  8. From the Record/Playback tab, configure the greeting that you want to record and playback on the chosen extension. This interface allows administrators to trigger a call to a physical device, which allows for recording or playback of a greeting. The extension to dial must be an accessible extension for the administrator (or user) to answer and record or listen to greetings.

    1. Select an extension from the drop-down, or manually type in the number of the device you want to call to record or listen to a greeting.
    2. Select the Specific Greeting check box if you want to record or playback a greeting for Standard, or Busy, etc. Otherwise the action will apply to the main Call Handler.
    3. The duration is the time (in seconds), that the system will allow to record a greeting, and does not apply when playing back a recording. This is an important timer, as setting this too low, might result in incorrect configuration.

    Important

    Do not click Save on this form, go to Action > Record Greeting or Action > Playback Greeting to save these settings.

  9. On the Upload Greeting tab, from the Greeting File drop-down, choose the greeting file (.wav) to upload to the call handler, and then configure the specific greeting (if required), see Manage Greeting Files.

    See also: Call Handler Field Descriptions.

  10. Click Save when complete to save the changes to the Call Handler in VOSS-4-UC and Cisco Unity Connection.

Note

To delete a Call Handler, click on the Call Handler you want to delete and then click Delete on the button bar. From the popup window, click Yes to confirm the deletion.

Model Details: relation/CallhandlerREL

Title Description Details
Message Sensitivity Determines if an outside caller can mark their message as private.
  • Field Name: SendPrivateMsg
  • Type: Integer
  • Choices: ["Mark Normal", "Mark Urgent", "Ask Callers"]
Voice Name The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.
  • Field Name: VoiceName
  • Type: String
Partition URI
  • Field Name: PartitionURI
  • Type: String
  • Format: uri
Play Post Greeting Recording Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.
  • Field Name: PlayPostGreetingRecording
  • Type: Integer
  • Choices: ["Do Not Play Recording", "Play Recording to All Callers", "Play Recording Only to Unidentified Callers"]
Template Query parameter
  • Field Name: templateObjectId
  • Type: String
  • Target: device/cuc/CallhandlerTemplate
  • Target attr: ObjectId
  • Format: uri
Creation Time The date and time the handler is created.
  • Field Name: CreationTime
  • Type: String
Call Handler Owner URI The URI to fetch the call handler owners.
  • Field Name: CallHandlerOwnerURI
  • Type: String
Enable Prepend Digits A flag to indicate weather or not to prepend digits when dialing a extension number to transfer too.
  • Field Name: EnablePrependDigits
  • Type: Boolean
Use Default Time Zone A flag indicating whether the timezone for this call handler is derived from the call handler object attribute or the default timezone from the location to which the call handler belongs. Always use the Timezone column - if this is set, then the column Timezone is being derived directly from the location.
  • Field Name: UseDefaultTimeZone
  • Type: Boolean
Phone System URI
  • Field Name: PhoneSystemURI
  • Type: String
  • Format: uri
Recipient Distribution List URI
  • Field Name: RecipientDistributionListURI
  • Type: String
  • Format: uri
Time Zone TimeZone this call handler is operating in.
  • Field Name: TimeZone
  • Type: Integer
Display Name * The text name of the handler to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting call handler is "Opening Greeting."
  • Field Name: DisplayName
  • Type: String
Voice Name URI
  • Field Name: VoiceNameURI
  • Type: String
  • Format: uri
URI
  • Field Name: URI
  • Type: String
  • Format: uri
Partition Name The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.
  • Field Name: PartitionObjectId
  • Type: String
  • Target: device/cuc/Partition
  • Target attr: ObjectId
  • Format: uri
User with Mailbox The recipient for this call handler. If the recipient is a subscriber, the DignetObjectId of the User object to which the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL.
  • Field Name: RecipientSubscriberObjectId
  • Type: String
  • Target: device/cuc/User
  • Target attr: ObjectId
  • Format: uri
Call Search Space The unique identifier of the SearchSpace that is used limit visibility to dialable objects when searching by extension (dial string).
  • Field Name: CallSearchSpaceObjectId
  • Type: String
  • Target: device/cuc/SearchSpace
  • Target attr: ObjectId
  • Format: uri
Object Id The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]
  • Field Name: ObjectId
  • Type: String
Use Call Language A flag indicating whether Cisco Unity Connection will use the language assigned to the call.
  • Field Name: UseCallLanguage
  • Type: Boolean
Localization Key Localization Key for Timezone update.
  • Field Name: LocalizationKey
  • Type: String
Schedule Set The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.
  • Field Name: ScheduleSetObjectId
  • Type: String
  • Target: device/cuc/ScheduleSet
  • Target attr: ObjectId
  • Format: uri
One Key Delay The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key.
  • Field Name: OneKeyDelay
  • Type: Integer
Dispatch Delivery A flag indicating that all messages left for the call handler is for dispatch delivery.
  • Field Name: DispatchDelivery
  • Type: Boolean
Schedule Set URI
  • Field Name: ScheduleSetURI
  • Type: String
  • Format: uri
After Message Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: AfterMessageAction
  • Type: Integer
  • Choices: ["Ignore", "Hang Up", "OTHER (conversation, etc)", "Take Message", "Skip Greeting", "Restart Greeting", "Transfer to Alternate Contact Number", "Route From Next Call Routing Rule"]
Max Msg Len The maximum recording length (in seconds) for messages left by unidentified callers.
  • Field Name: MaxMsgLen
  • Type: Integer
Edit Msg A flag that determines whether the caller can edit messages.
  • Field Name: EditMsg
  • Type: Boolean
Menu Entries URI
  • Field Name: MenuEntriesURI
  • Type: String
  • Format: uri
Is Primary A flag indicating whether this is a "primary" call handler for a subscriber, or an "application" call handler.
  • Field Name: IsPrimary
  • Type: Boolean
Prepend Digits Touch-Tone digits to prepended to extension when dialing transfer number ( #, 0,1...9,*).
  • Field Name: PrependDigits
  • Type: String
Location The unique identifier of the Location object to which this handler belongs.
  • Field Name: LocationObjectId
  • Type: String
  • Target: device/cuc/Location
  • Target attr: ObjectId
  • Format: uri
Language The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.
  • Field Name: Language
  • Type: Integer
  • Choices: ["English(UnitedStates)"]
Transfer Options URI
  • Field Name: TransferOptionsURI
  • Type: String
  • Format: uri
Is Template A flag indicating whether this CallHandler is a "template" for creating new call handlers.
  • Field Name: IsTemplate
  • Type: Boolean
Recipient User URI
  • Field Name: RecipientUserURI
  • Type: String
  • Format: uri
Call Search Space URI
  • Field Name: CallSearchSpaceURI
  • Type: String
  • Format: uri
Play After Message Recording A Link To a PostGreetingRecording that is used as After Message Recording
  • Field Name: PlayAfterMessageRecordingObjectId
  • Type: String
  • Target: device/cuc/PostGreetingRecording
  • Target attr: ObjectId
  • Format: uri
Recipient Contact URI
  • Field Name: RecipientContactURI
  • Type: String
  • Format: uri
Play After Message Indicates whether the Sent Message Prompt Recording referenced by Post Greeting
  • Field Name: PlayAfterMessage
  • Type: Integer
  • Choices: ["Do Not Play Recording", "System Default Recording"]
Greetings URI
  • Field Name: GreetingsURI
  • Type: String
  • Format: uri
After Message Target Handler The unique identifier of the specific object to send along to the target conversation.
  • Field Name: AfterMessageTargetHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Tenant Object Id Unique ObjectId of the tbl_Tenant
  • Field Name: TenantObjectId
  • Type: String
Message Urgency A flag indicating whether an unidentified caller can mark a message as "urgent."
  • Field Name: SendUrgentMsg
  • Type: Integer
  • Choices: ["Mark Normal", "Mark Urgent", "Ask Callers"]
Undeletable A flag indicating whether this handler can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.
  • Field Name: Undeletable
  • Type: Boolean
Voice File URI
  • Field Name: VoiceFileURI
  • Type: String
  • Format: uri
After Message Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: AfterMessageTargetConversation
  • Type: String
Inherit Search Space From Call A flag indicating whether the call handler inherits the search space from the call or uses the call handler CallSearchSpaceObject. The default value is true ? inherit the search space from the call thereby ignoring the call handler's CallSeachSpaceObjectId.
  • Field Name: InheritSearchSpaceFromCall
  • Type: Boolean
Recipient Contact The recipient for this call handler. If the recipient is a contact, the unique identifier of the Subscriber object where the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL.
  • Field Name: RecipientContactObjectId
  • Type: String
  • Target: device/cuc/Contact
  • Target attr: ObjectId
  • Format: uri
Recipient Distribution List The recipient for this call handler. If the recipient is a distribution list, the unique identifier of the DistributionList object where the recorded message of a call handler should be routed. Otherwise, this attribute is set ot NULL.
  • Field Name: RecipientDistributionListObjectId
  • Type: String
  • Target: device/cuc/DistributionList
  • Target attr: ObjectId
  • Format: uri
Dtmf Access Id The DTMF access id (i.e., extension) for the call handler. The dialable number.
  • Field Name: DtmfAccessId
  • Type: String
Send Secure Msg A flag indicating whether an unidentified caller can mark a message as "secure."
  • Field Name: SendSecureMsg
  • Type: Boolean
Post Greeting Recording A link to a PostGreetingRecording
  • Field Name: PostGreetingRecordingObjectId
  • Type: String
  • Target: device/cuc/PostGreetingRecording
  • Target attr: ObjectId
  • Format: uri
Use Default Language A flag indicating whether the language for this call handler is derived from the call handler object attribute or the default language from the location to which the call handler belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.
  • Field Name: UseDefaultLanguage
  • Type: Boolean
Phone System Default switch to use for transfers.
  • Field Name: MediaSwitchObjectId
  • Type: String
  • Target: device/cuc/PhoneSystem
  • Target attr: ObjectId
  • Format: uri
Location URI
  • Field Name: LocationURI
  • Type: String
  • Format: uri
Callhandler Menu Entry
  • Field Name: CallhandlerMenuEntry.[n]
  • Type: Array
Locked A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key. Values: 0: Additional input accepted 1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key.
  • Field Name: CallhandlerMenuEntry.[n].Locked
  • Type: Boolean
Transfer Type The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as "Release to Switch" transfer).
  • Field Name: CallhandlerMenuEntry.[n].TransferType
  • Type: Integer
  • Choices: ["Release to Switch", "Supervise Transfer"]
Object Id The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.
  • Field Name: CallhandlerMenuEntry.[n].ObjectId
  • Type: String
Transfer Number The phone number associated with the alternate contact
  • Field Name: CallhandlerMenuEntry.[n].TransferNumber
  • Type: String
Transfer Rings The number of times the extension rings before Cisco Unity Connection considers it a "ring no answer" and plays the subscriber or handler greeting.
  • Field Name: CallhandlerMenuEntry.[n].TransferRings
  • Type: Integer
Callhandler URI
  • Field Name: CallhandlerMenuEntry.[n].CallhandlerURI
  • Type: String
  • Format: uri
URI
  • Field Name: CallhandlerMenuEntry.[n].URI
  • Type: String
  • Format: uri
Call Handler * The unique identifier of the CallHandler object to which this menu entry belongs. - template parameter [1]
  • Field Name: CallhandlerMenuEntry.[n].CallHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Touchtone Key The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). - template parameter [2]
  • Field Name: CallhandlerMenuEntry.[n].TouchtoneKey
  • Type: String
Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: CallhandlerMenuEntry.[n].TargetConversation
  • Type: String
Call Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: CallhandlerMenuEntry.[n].Action
  • Type: Integer
  • Choices: ["Ignore", "Hang Up", "OTHER (conversation, etc)", "Take Message", "Skip Greeting", "Restart Greeting", "Transfer to Alternate Contact Number", "Route From Next Call Routing Rule"]
Display Name The display name associated with the alternate contact number.
  • Field Name: CallhandlerMenuEntry.[n].DisplayName
  • Type: String
Target Handler Object Id The unique identifier of the specific object to send along to the target conversation.
  • Field Name: CallhandlerMenuEntry.[n].TargetHandlerObjectId
  • Type: String
Greeting
  • Field Name: Greeting.[n]
  • Type: Array
Callers Hear The source for the greeting when this greeting is active.
  • Field Name: Greeting.[n].PlayWhat
  • Type: Integer
  • Choices: ["System Default Greeting", "My Personal Recording", "Nothing"]
Ignore Digits A flag indicating whether Cisco Unity Connection takes action in response to touchtone keys pressed by callers during the greeting.
  • Field Name: Greeting.[n].IgnoreDigits
  • Type: Boolean
Play Record Message Prompt A flag indicating whether the ?Record your message at the tone?? prompt prior to recording a message.
  • Field Name: Greeting.[n].PlayRecordMessagePrompt
  • Type: Boolean
After Greeting Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: Greeting.[n].AfterGreetingTargetConversation
  • Type: String
Call Handler Object Id * The unique identifier of the CallHandler object to which this greeting rule belongs. - template parameter [1]
  • Field Name: Greeting.[n].CallHandlerObjectId
  • Type: ["String"]
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Enabled If TimeExpires is set, this field is ignored.
  • Field Name: Greeting.[n].Enabled
  • Type: Boolean
After Greeting The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: Greeting.[n].AfterGreetingAction
  • Type: Integer
  • Choices: ["Ignore", "Hang Up", "OTHER (conversation, etc)", "Take Message", "Restart Greeting", "Route From Next Call Routing Rule"]
After Greeting Target Handler Object Id The unique identifier of the specific object to send along to the target conversation.
  • Field Name: Greeting.[n].AfterGreetingTargetHandlerObjectId
  • Type: String
URI
  • Field Name: Greeting.[n].URI
  • Type: String
  • Format: uri
Greeting Stream Files URI
  • Field Name: Greeting.[n].GreetingStreamFilesURI
  • Type: String
  • Format: uri
Reprompt Delay The amount of time (in seconds) that Cisco Unity Connection waits without receiving any input from a caller before Cisco Unity Connection prompts the caller again.
  • Field Name: Greeting.[n].RepromptDelay
  • Type: Integer
Reprompts The number of times to reprompt a caller. After the number of times indicated here, Cisco Unity Connection performs the after-greeting action.
  • Field Name: Greeting.[n].Reprompts
  • Type: Integer
Greeting Type The type of greeting, e.g. "Standard," "Off Hours," "Busy," etc. - template parameter [2]
  • Field Name: Greeting.[n].GreetingType
  • Type: String
Enable Transfer A flag indicating when an extension is dialed at the greeting and the extension is not available whether to transfer to another extension.
  • Field Name: Greeting.[n].EnableTransfer
  • Type: Boolean
Enable Personal Video Recording It will Enable the Personal video Recording in CUCA.
  • Field Name: Greeting.[n].EnablePersonalVideoRecording
  • Type: Boolean
Play Record Video Message Prompt A flag indicating whether the ?Record your message at the tone?? prompt prior to Video recording a message.
  • Field Name: Greeting.[n].PlayRecordVideoMessagePrompt
  • Type: Boolean
Callhandler URI
  • Field Name: Greeting.[n].CallhandlerURI
  • Type: String
  • Format: uri
Time Expires The date and time when the greeting rule expires. The greeting rule is considered not expired (enabled), if the value is NULL or a future date. The greeting rule is considered expired (disabled), the value is in the past.
  • Field Name: Greeting.[n].TimeExpires
  • Type: String
Hf
  • Field Name: HF
  • Type: Object
Hierarchy Type Hidden (internal-only) helper field to store hierarchy type string (e.g. 'Site' or 'Customer')
  • Field Name: HF.hierarchy_type
  • Type: String
Network Device List Mandatory input-field for the Add use-case (if hierarchy is at Site-node, however, this value is derived automatically). The workflow (and GUIRules) will target the UC devices that is linked to this Network Device List (NDL). In the Mod use-case, this should also be derived automatically and can thus be omitted from Updates.
  • Field Name: HF.target_ndl
  • Type: String
Cisco Unity Connection Informative (non-input) field. Indicates the target CUCx host/IP, which is automatically derived from the input NDL.
  • Field Name: HF.cuc_info
  • Type: String
Cisco Unified CM Informative (non-input) field. Indicates the target CUCM host/IP, which is automatically derived from the input NDL.
  • Field Name: HF.cucm_info
  • Type: String
Call Handler Template Select the Cisco Unity Connection Call Handler Template. (The valid options are dependent on the selected NDL / CUCx)
  • Field Name: HF.cuc_template
  • Type: String
Message Caller Input
  • Field Name: HF.callerInput_tab_message
  • Type: String
Message Greetings
  • Field Name: HF.greetings_tab_message
  • Type: String
Message (fields will become available after new item has been saved)
  • Field Name: HF.owners_message
  • Type: String
Message (fields will become available after new item has been saved)
  • Field Name: HF.transfer_rules_message
  • Type: String
Do not add Route Pattern Check this option to bypass Route Pattern addition
  • Field Name: HF.do_not_add_rp
  • Type: Boolean
Route List The Cisco Unified CM Route List to use. (The valid options are dependent on the selected NDL / CUCM)
  • Field Name: HF.route_list
  • Type: String
Record Playback
  • Field Name: RecordPlayback
  • Type: Object
Message PLEASE NOTE! This is a special interface, which allows admins to trigger a call to a physical device, which allows for recording or playback of a greeting. The extension to dial must be an accessible extension for the admin (or user) to answer and record or listen to greetings. 1. Select an extension from the drop-down, or manually type in the number of the device you want to call to record or listen to a greeting. 2. Select the “Specific Greeting” checkbox if you want to record or playback a greeting for Standard, or Busy, etc. Else the action will apply to the main Call Handler. 3. The duration is the time in seconds, that the system will allow to record a greeting, and does not apply when playing back a recording. This is an important timer, as setting this too low, might result in incorrect configuration. 4. Finally, do not click “Save” on this form, as it will not trigger the workflow to but rather go to Action - Record Greeting, or Action - Playback Greeting.
  • Field Name: RecordPlayback.note
  • Type: String
Call Handler Name Call Handler Name
  • Field Name: RecordPlayback.call_handler
  • Type: String
Extension Extension to Record message on.
  • Field Name: RecordPlayback.extension
  • Type: String
Specific Greeting Specific Greeting
  • Field Name: RecordPlayback.specific_greeting
  • Type: Boolean
Greetings Greetings
  • Field Name: RecordPlayback.greeting
  • Type: String
Duration Duration to allow enough time to make recording/playback.
  • Field Name: RecordPlayback.duration
  • Type: String
Upload
  • Field Name: Upload
  • Type: Object
Message Upload a greeting to the selected Call Handler.
  • Field Name: Upload.note
  • Type: String
Greeting File Greeting File Name
  • Field Name: Upload.filename
  • Type: String
Call Handler Name Call Handler Name
  • Field Name: Upload.call_handler
  • Type: String
Specific Greeting Specific Greeting
  • Field Name: Upload.specific_greeting
  • Type: Boolean
Greetings Greetings
  • Field Name: Upload.greeting
  • Type: String
Owner
  • Field Name: Owner.[n]
  • Type: Array
Distribution List Object Id The unique identifier of the DistributionList object to which this distribution list member belongs.
  • Field Name: Owner.[n].DistributionListObjectId
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a Call handler owner object. - template parameter [2]
  • Field Name: Owner.[n].ObjectId
  • Type: String
URI
  • Field Name: Owner.[n].URI
  • Type: String
  • Format: uri
User URI
  • Field Name: Owner.[n].UserURI
  • Type: String
  • Format: uri
Distribution List URI
  • Field Name: Owner.[n].DistributionListURI
  • Type: String
  • Format: uri
User Object Id
  • Field Name: Owner.[n].UserObjectId
  • Type: String
Target Handler Object Id * The unique identifier of the Call Handler object for which this distribution list is the owner. - template parameter [1]
  • Field Name: Owner.[n].TargetHandlerObjectId
  • Type: ["String"]
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
User
  • Field Name: User
  • Type: Object
Exit Target Handler The unique identifier of the specific object to send along to the target conversation.
  • Field Name: Owner.[n].User.ExitTargetHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Title The position or function of a user within an organization, such as 'Vice President.'
  • Field Name: Owner.[n].User.Title
  • Type: String
Address Mode The default method the subscriber will use to address messages to other subscribers.
  • Field Name: Owner.[n].User.AddressMode
  • Type: Integer
Ring Primary Phone First A flag indicating whether a subscriber's primary phone should be rung before trying other destinations in a personal group.
  • Field Name: Owner.[n].User.RingPrimaryPhoneFirst
  • Type: Boolean
Command Digit Timeout The amount of time (in milliseconds) between digits on a multiple digit menu command entry (i.e. different than the inter digit timeout that is used for strings of digits such as extensions and transfer strings).
  • Field Name: Owner.[n].User.CommandDigitTimeout
  • Type: Integer
Voice Name The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.
  • Field Name: Owner.[n].User.VoiceName
  • Type: String
En Alt Greet Dont Ring Phone A flag indicating whether a caller is prevented from being transferred to the subscriber phone when the subscriber alternate greeting is turned on.
  • Field Name: Owner.[n].User.EnAltGreetDontRingPhone
  • Type: Boolean
Say Timestamp After A flag indicating whether Cisco Unity Connection announces the timestamp after it plays back each message for the subscriber.
  • Field Name: Owner.[n].User.SayTimestampAfter
  • Type: Boolean
Department The name or number for the department or subdivision of an organization to which a person belongs.
  • Field Name: Owner.[n].User.Department
  • Type: String
Greet By Name A flag indicating whether the subscriber hears his/her name when they log into their mailbox over the phone.
  • Field Name: Owner.[n].User.GreetByName
  • Type: Boolean
Address The physical address such as a house number and street name where the user is located, or with which a user is associated.
  • Field Name: Owner.[n].User.Address
  • Type: String
Retain Urgent Message Flag A flag that indicates whether the urgent message flag on a message is retained for both reply and forward message actions. The default value is 0; the urgent message flag is NOT retained for both reply and forward message actions.
  • Field Name: Owner.[n].User.RetainUrgentMessageFlag
  • Type: Boolean
Is Template A flag indicating whether this instance of a User object is a "template" for creating new users.
  • Field Name: Owner.[n].User.IsTemplate
  • Type: Boolean
Dtmf Name Last First The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the last name followed by the first name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: Owner.[n].User.DtmfNameLastFirst
  • Type: String
Speech Sensitivity A variable level of sound sensitivity that enables the speech engine to filter out background noise and not mistake it for speech. A higher value means higher sensitivity.
  • Field Name: Owner.[n].User.SpeechSensitivity
  • Type: Integer
Conversation Tui The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: Owner.[n].User.ConversationTui
  • Type: String
Ccm Id Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager
  • Field Name: Owner.[n].User.CcmId
  • Type: String
Ldap Type The LDAP configuration information for the user.
  • Field Name: Owner.[n].User.LdapType
  • Type: Integer
  • Choices: ["Do not Integrate with LDAP directory", "Integrate with LDAP directory", "Authenticate", "Integrate and Authenticate with LDAP directory", "Inactive"]
External Service Accounts URI
  • Field Name: Owner.[n].User.ExternalServiceAccountsURI
  • Type: String
  • Format: uri
Save Message On Hangup A flag indicating when hanging up while listening to a new message, whether the message is marked new again or is marked read.
  • Field Name: Owner.[n].User.SaveMessageOnHangup
  • Type: Boolean
Enable Visual Message Locator A flag indicating whether the visual message locator feature is enabled for the subscriber. The visual message locator feature presents a list of messages on the subscriber's IP phone display for the subscriber to select from visually.
  • Field Name: Owner.[n].User.EnableVisualMessageLocator
  • Type: Boolean
Repeat Menu The number of times to repeat a menu in TUI.
  • Field Name: Owner.[n].User.RepeatMenu
  • Type: Integer
Building The name of the building where the user is based (e.g., SJ-21).
  • Field Name: Owner.[n].User.Building
  • Type: String
User Mailbox URI The URI to change the mailbox settings.
  • Field Name: Owner.[n].User.UserMailboxURI
  • Type: String
Conversation Vui The VUI conversation assigned to the subscriber.
  • Field Name: Owner.[n].User.ConversationVui
  • Type: String
Employee Id The numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.
  • Field Name: Owner.[n].User.EmployeeId
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a User object. - template parameter [1]
  • Field Name: Owner.[n].User.ObjectId
  • Type: String
Creation Time The date and time the user account was created.
  • Field Name: Owner.[n].User.CreationTime
  • Type: String
Jump To Messages On Login A flag indicating whether the subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.
  • Field Name: Owner.[n].User.JumpToMessagesOnLogin
  • Type: Boolean
Say Sender A flag indicating whether Cisco Unity Connection announces the sender of a message during message playback for the subscriber.
  • Field Name: Owner.[n].User.SaySender
  • Type: Boolean
URI
  • Field Name: Owner.[n].User.URI
  • Type: String
  • Format: uri
Message Locator Sort Order The order in which Cisco Unity Connection will sort messages when the "Message Locator" feature is enabled.
  • Field Name: Owner.[n].User.MessageLocatorSortOrder
  • Type: Integer
Mailbox Dn The distinguished name of the mailbox.
  • Field Name: Owner.[n].User.MailboxDn
  • Type: String
Phone Number A phone number.
  • Field Name: Owner.[n].User.PhoneNumber
  • Type: String
Ccm Id Type Type of CCM user/object this id refers to (end user, application user, or directory number)
  • Field Name: Owner.[n].User.CcmIdType
  • Type: Integer
Synch Schedule URI
  • Field Name: Owner.[n].User.SynchScheduleURI
  • Type: String
  • Format: uri
Client Matter Code The client matter code to transmit to Call Manger when a phone number is dialed on an outbound call. The CMC is entered after a phone number is dialed so that the customer can assigning account or billing codes to the call. Whether or not the CMC will be transmitted is dictated by a setting on outbound call. The subscriber's CMC is used only if the outbound call doesn't have its own CMC.
  • Field Name: Owner.[n].User.ClientMatterCode
  • Type: String
Confirm Delete Deleted Message A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single deleted message.
  • Field Name: Owner.[n].User.ConfirmDeleteDeletedMessage
  • Type: Boolean
Enable Save Draft A flag indicating whether the save draft message feature is enabled for the subscriber.
  • Field Name: Owner.[n].User.EnableSaveDraft
  • Type: Boolean
Alternate Names URI The URI to get the alternate names of the user.
  • Field Name: Owner.[n].User.AlternateNamesURI
  • Type: String
Voice File URI
  • Field Name: Owner.[n].User.VoiceFileURI
  • Type: String
  • Format: uri
Initials The initial letters of some or all of the names of this user.
  • Field Name: Owner.[n].User.Initials
  • Type: String
Alt First Name The alternate spelling of a user first name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.
  • Field Name: Owner.[n].User.AltFirstName
  • Type: String
Exit Call Action The unique identifier of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out.
  • Field Name: Owner.[n].User.ExitCallActionObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Say Msg Number A flag indicating whether Cisco Unity Connection announces the position of each message in the stack (i.e., 'Message 1', 'Message 2' ,etc.) during message playback for the subscriber.
  • Field Name: Owner.[n].User.SayMsgNumber
  • Type: Boolean
Say Total New Voice A flag indicating whether Cisco Unity Connection announces the total number of new voice messages in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalNewVoice
  • Type: Boolean
Read Only If set to 1 (true) user is read-only and cannot be modified.
  • Field Name: Owner.[n].User.ReadOnly
  • Type: Boolean
Say Sender Extension A flag indicating whether Cisco Unity Connection during message playback, plays the primary extension information of the subscriber who sent the message after playing the sender's voice name.
  • Field Name: Owner.[n].User.SaySenderExtension
  • Type: Boolean
Saved Message Stack Order The order in which Cisco Unity Connection plays the following types of "saved" messages: * Urgent voice messages * Non-urgent voice messages * Urgent fax messages * Non-urgent fax messages * Urgent e-mail messages * Non-urgent e-mail messages * Receipts and notices
  • Field Name: Owner.[n].User.SavedMessageStackOrder
  • Type: String
Say Sender Extension After This flag works exactly the same as the SaySenderExtension flag on a user, except the conversation plays the sender's extension in the message footer.
  • Field Name: Owner.[n].User.SaySenderExtensionAfter
  • Type: Boolean
Display Name The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.
  • Field Name: Owner.[n].User.DisplayName
  • Type: String
Inbox Auto Refresh The rate (in minutes) at which Unity Inbox performs a refresh.
  • Field Name: Owner.[n].User.InboxAutoRefresh
  • Type: Integer
Use Default Time Zone Indicates if the default timezone is being used.
  • Field Name: Owner.[n].User.UseDefaultTimeZone
  • Type: Boolean
Phone System URI
  • Field Name: Owner.[n].User.PhoneSystemURI
  • Type: String
  • Format: uri
State The full name of the state or province where this user is located, or with which a user is associated.
  • Field Name: Owner.[n].User.State
  • Type: String
Alt Last Name The alternate spelling of a user last name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.
  • Field Name: Owner.[n].User.AltLastName
  • Type: String
Announce Upcoming Meetings The amount ahead of time, in minutes, that Connection will warn the subscriber of upcoming meetings when the subscriber calls into the system.
  • Field Name: Owner.[n].User.AnnounceUpcomingMeetings
  • Type: Integer
Mailbox Store Name The Mailbox store name of user.
  • Field Name: Owner.[n].User.MailboxStoreName
  • Type: String
Say Ani A flag indicating whether Cisco Unity Connection plays the Automatic Number Identification (ANI) information during message playback for voice messages from unidentified callers.
  • Field Name: Owner.[n].User.SayAni
  • Type: Boolean
New Message Sort Order The order in which Cisco Unity Connection will sort new messages.
  • Field Name: Owner.[n].User.NewMessageSortOrder
  • Type: Integer
  • Choices: ["Newest first", "Oldest first"]
Time Last Call The date and time when the subscriber last accessed their mailbox by phone (last time they were offered messages).
  • Field Name: Owner.[n].User.TimeLastCall
  • Type: String
Dtmf Name Last The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the last name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: Owner.[n].User.DtmfNameLast
  • Type: String
Fax Server The unique identifier of the FaxServer object for the subscriber.
  • Field Name: Owner.[n].User.FaxServerObjectId
  • Type: String
  • Target: device/cuc/FaxServer
  • Target attr: ObjectId
  • Format: uri
Location The name of the LocationVMS object to which this user belongs.
  • Field Name: Owner.[n].User.LocationObjectId
  • Type: String
  • Target: device/cuc/Location
  • Target attr: ObjectId
  • Format: uri
Dtmf Name First The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: Owner.[n].User.DtmfNameFirst
  • Type: String
Prompt Speed The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.
  • Field Name: Owner.[n].User.PromptSpeed
  • Type: Integer
En Alt Greet Prevent Skip A flag indicating whether callers can skip the greeting while it is playing when the alternate greeting is turned on.
  • Field Name: Owner.[n].User.EnAltGreetPreventSkip
  • Type: Boolean
Continuous Add Mode A flag indicating whether when addressing, after entering one recipient name, whether the subscriber is asked to enter another name or assume the subscriber is finished adding names and is ready to move on to recording the message or applying message options.
  • Field Name: Owner.[n].User.ContinuousAddMode
  • Type: Boolean
Enhanced Security Alias The unique text name used to idenitify and authenticate the user with an RSA SecurID security system.
  • Field Name: Owner.[n].User.EnhancedSecurityAlias
  • Type: String
Private Lists URI
  • Field Name: Owner.[n].User.PrivateListsURI
  • Type: String
  • Format: uri
Confirm Delete Multiple Messages A flag indicating whether Cisco Unity Connection allows the subscriber to choose which message they want to delete or whether Cisco Unity Connection permanently deletes the specified type of messages. Changes what Cisco Unity Connection does when subscribers press 3 > 2 > 2 from the Main menu to permanently delete multiple deleted messages at once.
  • Field Name: Owner.[n].User.ConfirmDeleteMultipleMessages
  • Type: Boolean
Conversation Name The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: Owner.[n].User.ConversationName
  • Type: String
Enable Message Bookmark A flag indicating whether Message Bookmark is enabled for the subscriber
  • Field Name: Owner.[n].User.EnableMessageBookmark
  • Type: Boolean
Inbox Messages Per Page The number of messages Unity Inbox displays in a page.
  • Field Name: Owner.[n].User.InboxMessagesPerPage
  • Type: Integer
Pab Last Imported The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.
  • Field Name: Owner.[n].User.PabLastImported
  • Type: String
Pca Home Page The Home Page is the first page that is displayed after logging in to the PCA.
  • Field Name: Owner.[n].User.PcaHomePage
  • Type: String
Update Broadcast Msg A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.
  • Field Name: Owner.[n].User.UpdateBroadcastMsg
  • Type: Boolean
Say Copied Names A flag indicating whether Cisco Unity Connection announces the "copied" names during message playback for a subscriber.
  • Field Name: Owner.[n].User.SayCopiedNames
  • Type: Boolean
Inbox Auto Resolve Message Recipients A flag indicating whether Cisco Unity Connection automatically resolves a recipient address entered in the To, Cc or Bcc fields to a subscriber or distribution list. Known as the "AutoResolve" feature.
  • Field Name: Owner.[n].User.InboxAutoResolveMessageRecipients
  • Type: Boolean
Mwis URI
  • Field Name: Owner.[n].User.MwisURI
  • Type: String
  • Format: uri
User Web Password URI The URI to change the web application password.
  • Field Name: Owner.[n].User.UserWebPasswordURI
  • Type: String
Video Service Accounts URI
  • Field Name: Owner.[n].User.VideoServiceAccountsURI
  • Type: String
  • Format: uri
Skip Forward Time Indicates the amount of time (in milliseconds) to jump forward when skipping ahead in a voice or TTS message using either DTMF or voice commands while reviewing messages.
  • Field Name: Owner.[n].User.SkipForwardTime
  • Type: Integer
Say Message Length After This flag works exactly the same as the SayMessageLength flag on a user, except the conversation plays the message length in the message footer.
  • Field Name: Owner.[n].User.SayMessageLengthAfter
  • Type: Boolean
Use Vui A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.
  • Field Name: Owner.[n].User.UseVui
  • Type: Boolean
Speech Confidence Threshold When the engine matches a spoken phrase, it associates a confidence level with that conclusion. This parameter determines what confidence level should be considered a successful match. A higher value means the engine is will report fewer successful matches, but it will be more confident in the matches that it reports.
  • Field Name: Owner.[n].User.SpeechConfidenceThreshold
  • Type: Integer
First Digit Timeout The amount of time to wait (in milliseconds) for first digit when collecting touch tones.
  • Field Name: Owner.[n].User.FirstDigitTimeout
  • Type: Integer
Address After Record A flag indicating whether the subscriber will be prompted to address message before or after it is recorded.
  • Field Name: Owner.[n].User.AddressAfterRecord
  • Type: Boolean
Phone System The unique identifier of the MediaSwitch object Cisco Unity Connection uses for subscriber Telephone Record and Playback (TRAP) sessions and to dial MWI on or off requests when the Cisco Unity Connection system has a dual switch integration.
  • Field Name: Owner.[n].User.MediaSwitchObjectId
  • Type: String
  • Target: device/cuc/PhoneSystem
  • Target attr: ObjectId
  • Format: uri
Exit Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: Owner.[n].User.ExitTargetConversation
  • Type: String
Saved Message Sort Order The order in which Cisco Unity Connection will sort saved messages.
  • Field Name: Owner.[n].User.SavedMessageSortOrder
  • Type: Integer
Partition URI
  • Field Name: Owner.[n].User.PartitionURI
  • Type: String
  • Format: uri
First Name The first name (i.e., givenName) of this user. Not their surname nor middle name.
  • Field Name: Owner.[n].User.FirstName
  • Type: String
Use Brief Prompts A flag indicating whether the subscriber hears brief or full phone menus when accessing Cisco Unity Connection over the phone.
  • Field Name: Owner.[n].User.UseBriefPrompts
  • Type: Boolean
Skip Password For Known Device A flag indicating whether the subscriber will be asked for his/her PIN when attempting to sign-in from a known device.
  • Field Name: Owner.[n].User.SkipPasswordForKnownDevice
  • Type: Boolean
Last Name The last name (i.e., surname or family name) of this user, by which a user is commonly known.
  • Field Name: Owner.[n].User.LastName
  • Type: String
Message Type Menu A flag indicating whether Cisco Unity Connection plays the message type menu when the subscriber logs on to Cisco Unity Connection over the phone.
  • Field Name: Owner.[n].User.MessageTypeMenu
  • Type: Boolean
Skip Reverse Time Indicates the amount of time (in milliseconds) to jump backward when skipping in reverse in a voice or TTS message using either DTMF or voice commands while reviewing messages.
  • Field Name: Owner.[n].User.SkipReverseTime
  • Type: Integer
Route NDR To Sender A flag indicating, for an undeliverable message, whether NDR messages will appear in the subscriber's mailbox or are deleted by the system.
  • Field Name: Owner.[n].User.RouteNDRToSender
  • Type: Boolean
Voice Name URI
  • Field Name: Owner.[n].User.VoiceNameURI
  • Type: String
  • Format: uri
Say Timestamp Before A flag indicating whether Cisco Unity Connection announces the timestamp before it plays back each for the subscriber.
  • Field Name: Owner.[n].User.SayTimestampBefore
  • Type: Boolean
Partition Name The unique identifier of the Partition to which the DtmfAccessId is assigned.
  • Field Name: Owner.[n].User.PartitionObjectId
  • Type: String
  • Target: device/cuc/Partition
  • Target attr: ObjectId
  • Format: uri
Say Msg Number After This flag works exactly the same as the SayMsgNumber flag on a user, except the conversation plays the message number in the message footer.
  • Field Name: Owner.[n].User.SayMsgNumberAfter
  • Type: Boolean
Speech Complete Timeout Specifies the required length of silence (in milliseconds) following user speech before the recognizer finalizes a result (either accepting it or throwing a nomatch event). The SpeechCompleteTimeout property is used when the speech prior to the silence matches an active grammar. A long SpeechCompleteTimeout value delays the result completion and therefore makes the system's response slow. A short SpeechCompleteTimeout value may lead to the inappropriate break up of an utterance. Reasonable SpeechCompleteTimeout values are typically in the range of 0.3 seconds to 1.0 second. See Appendix D?Timing properties of the VoiceXML Specification for details.
  • Field Name: Owner.[n].User.SpeechCompleteTimeout
  • Type: Integer
Forced Authorization Code A valid authorization code that is entered prior to extending calls to classes of dialed numbers, for example, external, toll and international calls.
  • Field Name: Owner.[n].User.ForcedAuthorizationCode
  • Type: String
En Alt Greet Prevent Msg A flag indicating whether callers can leave a message after the greeting when the subscriber alternate greeting is turned on.
  • Field Name: Owner.[n].User.EnAltGreetPreventMsg
  • Type: Boolean
Auto Advance Msgs A flag indicating that the conversation will, during playback, advance to the next message in the playback stack automatically after it is done playing the after message menu.
  • Field Name: Owner.[n].User.AutoAdvanceMsgs
  • Type: Boolean
Assistant Rows Per Page This controls the number of entries to display per page for all tables in the Unity Assistant, e.g. the Private List Members table.
  • Field Name: Owner.[n].User.AssistantRowsPerPage
  • Type: Integer
Template Alias Query parameter
  • Field Name: Owner.[n].User.templateAlias
  • Type: ["String"]
  • Target: device/cuc/UserTemplate
  • Target attr: Alias
  • Format: uri
Enable Message Locator A flag indicating whether the message locator feature is enabled for the subscriber.
  • Field Name: Owner.[n].User.EnableMessageLocator
  • Type: Boolean
Create Smtp Proxy From Corp Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created for this User.
  • Field Name: Owner.[n].User.CreateSmtpProxyFromCorp
  • Type: Boolean
Is Set For Vm Enrollment Temporary placeholder until IsVmEnrolled can be phased out. At that point, delete this column and rename tbl_UserSubscriber.IsVmEnrolled to IsSetForVmEnrollment. A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.
  • Field Name: Owner.[n].User.IsSetForVmEnrollment
  • Type: Boolean
Use Dynamic Name Search Weight Use dynamic name search weight. When this user addresses objects, the name search weight for those objects will automatically be incremented.
  • Field Name: Owner.[n].User.UseDynamicNameSearchWeight
  • Type: Boolean
User Role URI The URI to change the role of the user.
  • Field Name: Owner.[n].User.UserRoleURI
  • Type: String
Clock Mode The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.
  • Field Name: Owner.[n].User.ClockMode
  • Type: Integer
Class of Service The name of the Class of Service object with which this user account is associated.
  • Field Name: Owner.[n].User.CosObjectId
  • Type: String
  • Target: device/cuc/Cos
  • Target attr: ObjectId
  • Format: uri
Ldap Ccm User Id The userid of associated end user in the sleeping SeaDragon database.
  • Field Name: Owner.[n].User.LdapCcmUserId
  • Type: String
Say Ani After This flag works exactly the same as the SayAni flag on a user, except the conversation plays the ani in the message footer.
  • Field Name: Owner.[n].User.SayAniAfter
  • Type: Boolean
Dtmf Name First Last The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name followed by the last name of the user. These digits are used for searching the user by name via the phone.
  • Field Name: Owner.[n].User.DtmfNameFirstLast
  • Type: String
Postal Code For users in the United States, the zip code where the user is located. For users in Canada, Mexico, and other countries, the postal code where the user is located.
  • Field Name: Owner.[n].User.PostalCode
  • Type: String
Xfer String The cross-server transfer extension. If NULL, the user's primary extension is used.
  • Field Name: Owner.[n].User.XferString
  • Type: String
Confirmation Confidence Threshold Voice Recognition Confirmation Confidence Threshold
  • Field Name: Owner.[n].User.ConfirmationConfidenceThreshold
  • Type: Integer
Undeletable A flag indicating whether this subscriber can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.
  • Field Name: Owner.[n].User.Undeletable
  • Type: Boolean
Delay After Greeting The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting.
  • Field Name: Owner.[n].User.DelayAfterGreeting
  • Type: Integer
Encrypt Private Messages A flag indicating whether Cisco Unity Connection encrypts messages from the subscriber that are marked private.
  • Field Name: Owner.[n].User.EncryptPrivateMessages
  • Type: Boolean
Say Total Receipts A flag indicating whether Cisco Unity Connection announces the total number of new receipts in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalReceipts
  • Type: Boolean
New Message Stack Order The order in which Cisco Unity Connection plays the following types of "new" messages: * Urgent voice messages * Non-urgent voice messages * Urgent fax messages * Non-urgent fax messages * Urgent e-mail messages * Non-urgent e-mail messages * Receipts and notices
  • Field Name: Owner.[n].User.NewMessageStackOrder
  • Type: String
Notification Devices URI
  • Field Name: Owner.[n].User.NotificationDevicesURI
  • Type: String
  • Format: uri
Mailbox Store Mailbox Store for the tenant.
  • Field Name: Owner.[n].User.MailboxStoreObjectId
  • Type: String
  • Target: device/cuc/MailboxStore
  • Target attr: ObjectId
  • Format: uri
Is Vm Enrolled A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.
  • Field Name: Owner.[n].User.IsVmEnrolled
  • Type: Boolean
Inactive A flag indicating whether this subscriber is inactive or not.
  • Field Name: Owner.[n].User.Inactive
  • Type: Boolean
Email Address The corporate email address of the user.
  • Field Name: Owner.[n].User.EmailAddress
  • Type: String
Enable Tts A flag indicating whether TTS is enabled for the subscriber. Only relevant if TTS enabled in User's COS also.
  • Field Name: Owner.[n].User.EnableTts
  • Type: Boolean
Search By Extension Search Space The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).
  • Field Name: Owner.[n].User.SearchByExtensionSearchSpaceObjectId
  • Type: String
  • Target: device/cuc/SearchSpace
  • Target attr: ObjectId
  • Format: uri
Pca Address Book Rows Per Page Controls the number of matching entries the Address Book displays per page, when a search is performed. The Address Book is used across multiple PCA applications and so this setting applies globally.
  • Field Name: Owner.[n].User.PcaAddressBookRowsPerPage
  • Type: Integer
Location URI
  • Field Name: Owner.[n].User.LocationURI
  • Type: String
  • Format: uri
Say Distribution List A flag indicating whether Cisco Unity Connection announces the distribution list that sends a message, if applicable.
  • Field Name: Owner.[n].User.SayDistributionList
  • Type: Boolean
City The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated.
  • Field Name: Owner.[n].User.City
  • Type: String
Send Broadcast Msg A flag indicating whether the subscriber may send broadcast messages.
  • Field Name: Owner.[n].User.SendBroadcastMsg
  • Type: Boolean
Exit Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: Owner.[n].User.ExitAction
  • Type: Integer
Voice Name Required A flag indicating whether a recorded voice name is required for this subscriber.
  • Field Name: Owner.[n].User.VoiceNameRequired
  • Type: Boolean
Search By Extension Search Space URI
  • Field Name: Owner.[n].User.SearchByExtensionSearchSpaceURI
  • Type: String
  • Format: uri
Smtp Proxy Addresses URI The URI to get the smtp proxy addresses of the user.
  • Field Name: Owner.[n].User.SmtpProxyAddressesURI
  • Type: String
Message Handlers URI
  • Field Name: Owner.[n].User.MessageHandlersURI
  • Type: String
  • Format: uri
Say Total New Fax A flag indicating whether Cisco Unity Connection announces the total number of new fax messages in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalNewFax
  • Type: Boolean
Call Handler The unique identifier of the primary CallHandler object for the subscriber.
  • Field Name: Owner.[n].User.CallHandlerObjectId
  • Type: String
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Time Zone The time zone to which this user account is associated.
  • Field Name: Owner.[n].User.TimeZone
  • Type: Integer
Say Sender After This flag works exactly the same as the SaySender flag on a user, except the conversation plays the sender in the message footer.
  • Field Name: Owner.[n].User.SaySenderAfter
  • Type: Boolean
Name Confirmation Indicates whether the voice name of the subscriber or distribution list added to an address list when a subscriber addresses a message to other subscribers is played. The default value for this is off (no voice name played) since the voice name was just played as part of the list of matches . To most users this sounds redundant when on, but some users prefer it.
  • Field Name: Owner.[n].User.NameConfirmation
  • Type: Boolean
Search By Name Search Space URI
  • Field Name: Owner.[n].User.SearchByNameSearchSpaceURI
  • Type: String
  • Format: uri
Enable Personal Rules A flag indicating whether a subscriber's personal rules are enabled. Subscribers can use this setting to disable all personal rules at once.
  • Field Name: Owner.[n].User.EnablePersonalRules
  • Type: Boolean
Confirm Delete Message A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single new or saved message.
  • Field Name: Owner.[n].User.ConfirmDeleteMessage
  • Type: Boolean
Synch Schedule The unique identifier of the Schedule object to use for synchronization Calendar information from groupware (such as Exchange).
  • Field Name: Owner.[n].User.SynchScheduleObjectId
  • Type: String
  • Target: device/cuc/Schedule
  • Target attr: ObjectId
  • Format: uri
Language The preferred language of this user. For a user with a voice mailbox, it is the language in which the subscriber hears instructions played to them. If the subscriber has TTS enabled by their COS, it is the language used for TTS.
  • Field Name: Owner.[n].User.Language
  • Type: Integer
Record Unknown Caller Name A flag indicating whether a caller should be promoted to record his/her name if Unity does not receive caller id.
  • Field Name: Owner.[n].User.RecordUnknownCallerName
  • Type: Boolean
Manager The name of the person who is the manager or supervisor of the user.
  • Field Name: Owner.[n].User.Manager
  • Type: ["String", "Null"]
Call Answer Timeout The number of rings to wait for a subscriber destination to answer before the call is forwarded to the subscriber's primary phone.
  • Field Name: Owner.[n].User.CallAnswerTimeout
  • Type: Integer
Volume The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message.
  • Field Name: Owner.[n].User.Volume
  • Type: Integer
Say Total Saved A flag indicating whether Cisco Unity Connection announces the total number of saved messages in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalSaved
  • Type: Boolean
Interdigit Delay The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.
  • Field Name: Owner.[n].User.InterdigitDelay
  • Type: Integer
Cos URI
  • Field Name: Owner.[n].User.CosURI
  • Type: String
  • Format: uri
Smtp Address SMTP address The full SMTP address for this object.
  • Field Name: Owner.[n].User.SmtpAddress
  • Type: String
Localization Key Localization Key.
  • Field Name: Owner.[n].User.LocalizationKey
  • Type: String
Country The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated.
  • Field Name: Owner.[n].User.Country
  • Type: String
Say Message Length A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.
  • Field Name: Owner.[n].User.SayMessageLength
  • Type: Boolean
List In Directory A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.
  • Field Name: Owner.[n].User.ListInDirectory
  • Type: Boolean
Callhandler URI
  • Field Name: Owner.[n].User.CallhandlerURI
  • Type: String
  • Format: uri
Say Alt Greet Warning A flag indicating whether Cisco Unity Connection notifies the subscriber when they login via the phone (plays conversation) or CPCA (displays a warning banner) if their alternate greeting is turned on.
  • Field Name: Owner.[n].User.SayAltGreetWarning
  • Type: Boolean
Alias * The unique text name for either a user, distribution list, or personal group.
  • Field Name: Owner.[n].User.Alias
  • Type: String
Prompt Volume The volume level for playback of system prompts.
  • Field Name: Owner.[n].User.PromptVolume
  • Type: Integer
Tenant The name of the tenant to which the user belongs.
  • Field Name: Owner.[n].User.TenantObjectId
  • Type: String
  • Target: device/cuc/Tenant
  • Target attr: ObjectId
  • Format: uri
Say Total Draft Msg A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox
  • Field Name: Owner.[n].User.SayTotalDraftMsg
  • Type: Boolean
Say Total New A flag indicating whether Cisco Unity Connection announces the total number of new messages in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalNew
  • Type: Boolean
Say Total New Email A flag indicating whether Cisco Unity Connection announces the total number of new e-mail messages in the subscriber mailbox.
  • Field Name: Owner.[n].User.SayTotalNewEmail
  • Type: Boolean
Speech Incomplete Timeout Specifies the required length of silence (in milliseconds) from when the speech prior to the silence matches an active grammar, but where it is possible to speak further and still match the grammar. By contrast, the SpeechCompleteTimeout property is used when the speech prior to the silence matches an active grammar and no further words can be spoken. A long SpeechIncompleteTimeout value delays the result completion and therefore makes the system's response slow. A short SpeechIncompleteTimeout value may lead to the inappropriate break up of an utterance. The SpeechIncompleteTimeout value is usually longer than the completetimeout value to allow users to pause mid-utterance (for example, to breathe). Note that values set for the completetimeout property are only supported if they are less than the incompletetimeout property. See Appendix D?Timing properties of the VoiceXML Specification for details.
  • Field Name: Owner.[n].User.SpeechIncompleteTimeout
  • Type: Integer
User Voice Pin URI The URI to change the voice mail pin of the user.
  • Field Name: Owner.[n].User.UserVoicePinURI
  • Type: String
Ldap Ccm Pkid The pkid of associated end user in the sleeping SeaDragon database.
  • Field Name: Owner.[n].User.LdapCcmPkid
  • Type: String
Send Message On Hangup An enum indicating when hanging up while addressing a message that has a recording and at least one recipient, whether the message is discarded, sent or saved as a draft message if the subscriber explicitly issues the command to send the message either via DTMF or voice input.
  • Field Name: Owner.[n].User.SendMessageOnHangup
  • Type: Integer
Alternate Extensions URI
  • Field Name: Owner.[n].User.AlternateExtensionsURI
  • Type: String
  • Format: uri
Dialable Phone Number A dialable version of the PhoneNumber column.
  • Field Name: Owner.[n].User.DialablePhoneNumber
  • Type: String
Is Clock Mode24Hour The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.
  • Field Name: Owner.[n].User.IsClockMode24Hour
  • Type: Boolean
Use Short Poll For Cache A flag indicating whether the user's polling cycle for retrieving calendar information will be the shorter "power user" polling cycle.
  • Field Name: Owner.[n].User.UseShortPollForCache
  • Type: Boolean
Dtmf Access Id * The DTMF access id (i.e., extension) of the subscriber. The dialable number.
  • Field Name: Owner.[n].User.DtmfAccessId
  • Type: String
Fax Server URI
  • Field Name: Owner.[n].User.FaxServerURI
  • Type: String
  • Format: uri
Billing Id Accounting information or project code associated with this user.
  • Field Name: Owner.[n].User.BillingId
  • Type: String
Search By Name Search Space The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string).
  • Field Name: Owner.[n].User.SearchByNameSearchSpaceObjectId
  • Type: String
  • Target: device/cuc/SearchSpace
  • Target attr: ObjectId
  • Format: uri
Deleted Message Sort Order The order in which Cisco Unity Connection presents deleted messages to the subscriber.
  • Field Name: Owner.[n].User.DeletedMessageSortOrder
  • Type: Integer
Speech Speed Vs Accuracy Tunes the engine towards Performance or Accuracy. A higher value for this setting means faster matches that may be less accurate. A lower value for this setting means more accurate matches along with more processing and higher CPU utilization.
  • Field Name: Owner.[n].User.SpeechSpeedVsAccuracy
  • Type: Integer
Use Default Language Set to true (1) if call handler is using default language from the location it belongs to.
  • Field Name: Owner.[n].User.UseDefaultLanguage
  • Type: Boolean
Speed The audio speed Cisco Unity Connection uses to play back messages to the subscriber.
  • Field Name: Owner.[n].User.Speed
  • Type: Integer
Transfer
  • Field Name: Transfer.[n]
  • Type: Array
Transfer Holding Mode The action Cisco Unity Connection will take when the extension is busy.
  • Field Name: Transfer.[n].TransferHoldingMode
  • Type: Integer
Transfer Option Type The type of transfer option, e.g. "Standard," "Off Hours," or "Alternate." - template parameter [2]
  • Field Name: Transfer.[n].TransferOptionType
  • Type: String
Phone System URI
  • Field Name: Transfer.[n].PhoneSystemURI
  • Type: String
  • Format: uri
Transfer Confirm A flag indicating whether Cisco Unity Connection prompts the subscriber to accept or refuse a call ("Press 1 to take the call or 2 and I'll take a message"). If the call is accepted, it is transferred to the subscriber phone. If the call is refused, Cisco Unity Connection plays the applicable subscriber greeting.
  • Field Name: Transfer.[n].TransferConfirm
  • Type: Boolean
Transfer Rings The number of times the extension rings before Cisco Unity Connection considers it a "ring no answer" and plays the subscriber or handler greeting.
  • Field Name: Transfer.[n].TransferRings
  • Type: Integer
Transfer Screening A flag indicating whether Cisco Unity Connection will prompt callers to say their names. When the phone is answered, the subscriber hears "Call from..." before Cisco Unity Connection transfers the call.
  • Field Name: Transfer.[n].TransferScreening
  • Type: Boolean
Rna Action The action Cisco Unity Connection takes for a "Ring-No-Answer" (RNA) condition. Cisco Unity Connection will either transfer the call to the appropriate greeting or releases the call to the phone system.
  • Field Name: Transfer.[n].RnaAction
  • Type: Integer
Personal Call Transfer A flag indicating whether or not Personal Call Transfer Rules are used for the specific Transfer Option.
  • Field Name: Transfer.[n].PersonalCallTransfer
  • Type: Boolean
Extension The extension (phone number) to transfer to.
  • Field Name: Transfer.[n].Extension
  • Type: String
Enabled If TimeExpires is set, this field is ignored.
  • Field Name: Transfer.[n].Enabled
  • Type: Boolean
Callhandler URI
  • Field Name: Transfer.[n].CallhandlerURI
  • Type: String
  • Format: uri
URI
  • Field Name: Transfer.[n].URI
  • Type: String
  • Format: uri
Use Primary Extension If extension is null this will be set to 1 (true) to indicate we are using instead the DtmfAccessId for the owning handler or subscriber.
  • Field Name: Transfer.[n].UsePrimaryExtension
  • Type: Boolean
Transfer Announce A flag indicating whether Cisco Unity Connection plays "transferring call" when the subscriber answers the phone.
  • Field Name: Transfer.[n].TransferAnnounce
  • Type: Boolean
Action A flag indicating whether Cisco Unity Connection transfers the call to the call handler greeting or attempts to transfer the call to an extension.
  • Field Name: Transfer.[n].Action
  • Type: Integer
Transfer Type The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as "Release to Switch" transfer).
  • Field Name: Transfer.[n].TransferType
  • Type: Integer
Call Handler Object Id * The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]
  • Field Name: Transfer.[n].CallHandlerObjectId
  • Type: ["String"]
  • Target: device/cuc/Callhandler
  • Target attr: ObjectId
  • Format: uri
Transfer Dt Detect A flag indicating whether Cisco Unity Connection will check for dialtone before attempting to transfer the call.
  • Field Name: Transfer.[n].TransferDtDetect
  • Type: Boolean
Play Transfer Prompt A flag indicating whether the "Wait while I transfer your call" prompt should be played prior to transferring a call.
  • Field Name: Transfer.[n].PlayTransferPrompt
  • Type: Boolean
Transfer Introduce A flag indicating whether Cisco Unity Connection will say "call for <recorded name of the call handler>" when the subscriber answers the phone.
  • Field Name: Transfer.[n].TransferIntroduce
  • Type: Boolean
Media Switch Object Id The unique identifier of the MediaSwitch object that Cisco Unity Connection uses for transferring the call to the subscriber phone.
  • Field Name: Transfer.[n].MediaSwitchObjectId
  • Type: String
Time Expires The date and time when this transfer option expires. If the transfer rule is enabled, the value is NULL or a date in the future. If the transfer rule is disable, the value is a past date.
  • Field Name: Transfer.[n].TimeExpires
  • Type: ["String", "Null"]