[Index]

Model: relation/Voicemail

Voicemail

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

Overview

VOSS Automate allows admin users to add, update, or delete Cisco Unity Connection (CUC) voicemail accounts (voicemail users), and their associated voicemail services, via (default menus) Subscriber Management > Voicemail.

Note

Optionally (depending on your deployment), VOSS Automate supports a Unity SIP integration feature that can be used in place of your existing voicemail service. See Introduction to Unity SIP Integration

Users and associated services added through VOSS Automate are also added to Cisco Unity Connection (CUC) voicemail system.

Related Topics

Add, Update, or Delete a Call Handler (Auto Attendant) in the Core Feature Guide

Unified Messaging Account

Unified Messaging (Single Inbox) is a Cisco Unity Connection (CUC) service that enables users to have a single inbox in their e-mail client that is used for their e-mail as well as their Voicemail.

Note

The following CUC settings, set to 'True' (On), are included in Unified Messaging:

The following two models were added to the Model Type List CUCXN Overbuild Resources for Unified Messaging:

VOSS Automate also added a new Model Type list CUCXN Unified Messaging Services, and added the same two Models: device/cuc/ExternalService and device/cuc/ExternalServiceAccount

Add, Edit, or Delete a Voicemail Account

Prerequisites:

Perform these steps:

  1. In the VOSS Admin Portal, go to (default menus) Subscriber Management > Voicemail.

  2. From the summary list view, choose an option:

  3. On the CUC Account tab, configure CUC account details, such as voicemail account name (the subscriber), voicemail number, and the language the caller hears. For details, see Unified Messaging Account

    Note

    • The Voicemail Number drop-down only shows numbers associated to the selected subscriber (chosen for voicemail account name).
    • Email address is auto-populated when selecting an existing subscriber.
    • Click the Plus icon (+) at Unified Messaging Account to add a unified messaging service. See Unified Messaging Account. Once saved, the summary header is the user's email address. It is only possible to add one CUC messaging account per subscriber in VOSS Automate.

  4. On the Alternate Extensions tab, add alternate extensions available to the CUC voicemail user, if applicable.

    Note

    Once you've saved these changes you can log in to Cisco Unity Connection, choose the user you updated, and go to Edit > Alternate Extensions to view the alternate extension configured in VOSS Automate.

  5. From Alternate Extension choose the Partition from the drop-down and click Save.

  6. On the Message Actions tab, define how incoming voicemail, email, fax, and receipt messages are handled. If the selected message action involves relaying the message, enter a valid email address in the Relay Address field.

    Note

    You can accept the default message actions and update them later.

  7. On the Credentials tab, configure a password and PIN.

    Note

    The admin user configuring the account can lock these credentials or require the user to change the credentials on first login. The CUC user password template and CUC user PIN template in the user's Quick Add Group (QAG) are applied. See Quick Add Subscriber Group Default Model.

  8. On the Notification Devices tab, add devices used to notify this CUC user of voicemails sent to them.

    Note

    • While the system automatically provisions default notification devices, you can add additional devices when adding a voicemail account.
    • SMS notification is only available if an SMPP Provider has been added on the relevant Voicemail server.

  9. On the Caller Input tab, click on the required key (*, #, or 0 to 9), then select an action from the drop-down to associate caller input keys to specific actions (to configure default caller input keys). See Caller Input.

    Note

    • The Caller Input tab displays only once the CUC account (including voicemail account name) has been created and saved.
    • Additional fields are exposed when choosing certain options. For example, when you choose the User with Mailbox call action, the User with Mailbox and Transfer / Greeting fields are exposed.

  10. Save your changes to add or update this voicemail account.

    Note

    Once you've added a voicemail service to a subscriber, the lines lines used by any devices associated with the subscriber are updated to reflect the proper call forward and voicemail profile settings to enable the following buttons: Call Forwarding to Voicemail and Voicemail.

doc

Model Details: relation/Voicemail

Title Description Details
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
Title The position or function of a user within an organization, such as 'Vice President.'
  • Field Name: Title
  • Type: String
Address Mode The default method the subscriber will use to address messages to other subscribers.
  • Field Name: AddressMode
  • Type: Integer
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: DtmfNameFirstLast
  • Type: String
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: CommandDigitTimeout
  • Type: Integer
Exit Target Handler The unique identifier of the specific object to send along to the target conversation.
  • Field Name: ExitTargetHandlerObjectId
  • Type: String
  • Target: /api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24T6NduIO4AENAlW4J%24dNdjkNHHkh3T3zIy7lq94cQAIk5A5qozm6ArNeQEYTkGC0zmKZgAJRsgo1tcjUFjW/NjFqV7SbGoHBvwHWAlTh2z/CvFEY65z75I7Sz4Yxxf5Va1kgnpKL8a38JyUT9nPK/rnsiwcf8bYQukXdd0fZ559WMXUpSwP4Z%2BG0B4V1etC%2BAn7wIebESwkQw9j6DjJezkiob5eTd7Z73YZMPx91cVgD%2B8qxR6RGHJ9YWvlJtNVzUops3TnJAc5w90a2hdc9HoKip8qCYFpJjpiocHrFCar9N6V4jqQ5K9mBu04lLVtY/76jKvjaKD3zSaD6wdxZBgHKmzX4BLhfxI7Ik%2BC1pZQAuLh8m8OL7rpKx1mJKm5tQK8EpzjrXrJcWF4KZOnCsCuCqdU/hr%2BYo8TvSzpTFzCZSy0QF0JJTc%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
Say Timestamp After A flag indicating whether Cisco Unity Connection announces the timestamp after it plays back each message for the subscriber.
  • Field Name: SayTimestampAfter
  • Type: Boolean
Department The name or number for the department or subdivision of an organization to which a person belongs.
  • Field Name: 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: GreetByName
  • Type: Boolean
Cucsmtp
  • Field Name: cucsmtp.[n]
  • Type: Array
Smtp Address The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the "To:" field.
  • Field Name: cucsmtp.[n].SmtpAddress
  • Type: ["String", "Null"]
Display Name * The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc.
  • Field Name: cucsmtp.[n].DisplayName
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMTP object. - template parameter [2]
  • Field Name: cucsmtp.[n].ObjectId
  • Type: String
Device Name The "DeviceName" of the notification device.
  • Field Name: cucsmtp.[n].DeviceName
  • Type: String
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: cucsmtp.[n].EventList
  • Type: String
Send Caller Id A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message.
  • Field Name: cucsmtp.[n].SendCallerId
  • Type: Boolean
Static Text The actual text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the "Send:" field.
  • Field Name: cucsmtp.[n].StaticText
  • Type: String
User URI
  • Field Name: cucsmtp.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
URI
  • Field Name: cucsmtp.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Phone Number The phone number or alphanumeric text (as applicable) for sending a notification message to a text-compatible cell phone or pager. In the SA, this is referred to as the "From:" field. Typically, this field contains the number that the subscriber calls to check messages.
  • Field Name: cucsmtp.[n].PhoneNumber
  • Type: String
Send Count A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message.
  • Field Name: cucsmtp.[n].SendCount
  • Type: Boolean
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: cucsmtp.[n].RepeatInterval
  • Type: Integer
Max Subject The maximum number of characters allowed in the 'subject' of a notification message.
  • Field Name: cucsmtp.[n].MaxSubject
  • Type: Integer
Max Body The maximum number of characters allowed in the 'body' of a notification message.
  • Field Name: cucsmtp.[n].MaxBody
  • Type: Integer
Urgent Only A flag indicating whether Cisco Unity Connection sends voice message transcripted in urgent mode or not
  • Field Name: cucsmtp.[n].UrgentOnly
  • Type: Boolean
Undeletable Device cannot be deleted.
  • Field Name: cucsmtp.[n].Undeletable
  • Type: Boolean
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: cucsmtp.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Voice Message A flag indicating whether Cisco Unity Connection sends transcription of voice message
  • Field Name: cucsmtp.[n].VoiceMessage
  • Type: Boolean
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: cucsmtp.[n].ScheduleSetObjectId
  • Type: String
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: cucsmtp.[n].InitialDelay
  • Type: Integer
Header Text The actual header text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the "Header Text:" field.
  • Field Name: cucsmtp.[n].HeaderText
  • Type: String
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: cucsmtp.[n].RepeatNotify
  • Type: Boolean
Footer Text The actual footer text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the "Footer Text:" field.
  • Field Name: cucsmtp.[n].FooterText
  • Type: String
Send Pca Link A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message.
  • Field Name: cucsmtp.[n].SendPcaLink
  • Type: Boolean
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: cucsmtp.[n].Active
  • Type: Boolean
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: cucsmtp.[n].FailDeviceObjectId
  • Type: String
Cucphone
  • Field Name: cucphone.[n]
  • Type: Array
Display Name * The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc.
  • Field Name: cucphone.[n].DisplayName
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceConversation object. - template parameter [2]
  • Field Name: cucphone.[n].ObjectId
  • Type: String
Device Name The "DeviceName" of the notification device.
  • Field Name: cucphone.[n].DeviceName
  • Type: String
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: cucphone.[n].EventList
  • Type: String
Detect Transfer Loop A flag indicating whether Unity can do a loop detect transfer to this device.
  • Field Name: cucphone.[n].DetectTransferLoop
  • Type: Boolean
After Dial Digits The extra digits (if any) that Cisco Unity Connection will dial after the phone number.
  • Field Name: cucphone.[n].AfterDialDigits
  • Type: String
User URI
  • Field Name: cucphone.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
URI
  • Field Name: cucphone.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Phone System URI
  • Field Name: cucphone.[n].PhoneSystemURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Prompt For Id A flag indicating whether to prompt a subscriber for their Cisco Unity Connection ID, or just their password.
  • Field Name: cucphone.[n].PromptForId
  • Type: Boolean
Phone Number The phone number to dial, including the trunk access code (if any), of the device.
  • Field Name: cucphone.[n].PhoneNumber
  • Type: ["String", "Null"]
Dial Delay The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.
  • Field Name: cucphone.[n].DialDelay
  • Type: Integer
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: cucphone.[n].RepeatInterval
  • Type: Integer
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: cucphone.[n].InitialDelay
  • Type: Integer
Max Subject The maximum number of characters allowed in the 'subject' of a notification message.
  • Field Name: cucphone.[n].MaxSubject
  • Type: Integer
Max Body The maximum number of characters allowed in the 'body' of a notification message.
  • Field Name: cucphone.[n].MaxBody
  • Type: Integer
Rings To Wait The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.
  • Field Name: cucphone.[n].RingsToWait
  • Type: Integer
Wait Connect A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits.
  • Field Name: cucphone.[n].WaitConnect
  • Type: Boolean
Conversation The name of the Conversation Cisco Unity Connection will use when calling the subscriber to notify of new messages. This maps to one of the conversations in tbl_Conversation.
  • Field Name: cucphone.[n].Conversation
  • Type: String
Undeletable Notification device is undeletable.
  • Field Name: cucphone.[n].Undeletable
  • Type: Boolean
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: cucphone.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: cucphone.[n].ScheduleSetObjectId
  • Type: String
Busy Retry Interval The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.
  • Field Name: cucphone.[n].BusyRetryInterval
  • Type: Integer
Media Switch Object Id * The unique identifier of the MediaSwitch object to use for notification.
  • Field Name: cucphone.[n].MediaSwitchObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24SXOvySNEGYgYZey1%24t%2Bfy%2BhiUkWEw%2BSlB51gj9RPauphFQAOLt3dNTEjzNoz2AQABbqcJZkvRVqLS%2B1XajPG9cE03G2R/6qNTaX0EtwEF5jXuNMnCVtrn2fNiOaLSczrJ6PeaUntGD/KI/sIA3B4ktlXeTuPajzf7EtX4hDvIzyKmAkqPoXulvyBVGczA9FBQT1cBJvby/cHG%2BOx1BRQAzRqiCvB6FHmYqTrXm/AMnmRDlfD2WI5lauC1xHzWrAS/89vbM7rw3Ui5F61ViAfaoMdh4NoOtDQhOcxTB10JM0bEfFHgD2RgJ9YL7T51ph/lcfSRTqhj55f1pxoJfz2yJjSiVFJ2bUv8U/Lep/iTE2zON3lDB%2BG1JzS6DQvBgg%2B0Rc3vwua6AOzz8UQ2xrw%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PhoneSystem
  • Format: uri
  • Choices: []
Retries On Rna The number of times Cisco Unity Connection will retry the notification device if the device does not answer.
  • Field Name: cucphone.[n].RetriesOnRna
  • Type: Integer
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: cucphone.[n].RepeatNotify
  • Type: Boolean
Transmit Forced Authorization Code A flag indicating whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.
  • Field Name: cucphone.[n].TransmitForcedAuthorizationCode
  • Type: Boolean
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: cucphone.[n].Active
  • Type: Boolean
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: cucphone.[n].FailDeviceObjectId
  • Type: String
Rna Retry Interval The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.
  • Field Name: cucphone.[n].RnaRetryInterval
  • Type: Integer
Retries On Busy The number of times Cisco Unity Connection will retry the notification device if it is busy.
  • Field Name: cucphone.[n].RetriesOnBusy
  • Type: Integer
Is Template A flag indicating whether this instance of a User object is a "template" for creating new users.
  • Field Name: 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: 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: SpeechSensitivity
  • Type: Integer
Conversation Tui The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: ConversationTui
  • Type: String
Ccm Id Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager
  • Field Name: CcmId
  • Type: String
Location The name of the LocationVMS object to which this user belongs.
  • Field Name: LocationObjectId
  • Type: String
  • Target: /api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249C4X8PGdrquOuYhJ%24OF2yMVsKe0FXo/GPW3/SgUPwcJfdoTidVeFsDeWHqwBedRvzcVpEWMD4fDMLfXilWzltR1dkdAa7XeOEvhoznmXSmI1vhwHQQfivAo3fbalAEgC3F64YyT3xiM5lgkZ74bkHK2BZ0RHhSu%2BlNlyn4lRBIA6L9jPTFnDYwwGiH9HgjTeibPlI6cgRt2V1O9DGNUREkAFOVD5KRANCwQ7fZC9EZEF%2B9PTDjXueld6VkW6D%2BFMlXRDSsK3ZIoCuQkFSuzMcdMhfsbEupDfDhp0u4bXBSQXwGvs20Ex3bFOMtwCFlFxKsVE03QEt6GALl%2Bf7bX3fJS5dKOGQY/nTcHm9l88fhsmWggQxCGAjSmPP3SDSDsB4xAmEjXq7KN2NZWMQIhfMcv9lW6xUbbrNpq9qFy84IQaXRgX4%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Location
  • Format: uri
  • Choices: []
External Service Accounts URI
  • Field Name: ExternalServiceAccountsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: 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: EnableVisualMessageLocator
  • Type: Boolean
Repeat Menu The number of times to repeat a menu in TUI.
  • Field Name: RepeatMenu
  • Type: Integer
Building The name of the building where the user is based (e.g., SJ-21).
  • Field Name: Building
  • Type: String
User Mailbox URI The URI to change the mailbox settings.
  • Field Name: UserMailboxURI
  • Type: String
Conversation Vui The VUI conversation assigned to the subscriber.
  • Field Name: 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: 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: ObjectId
  • Type: String
Cucuma
  • Field Name: cucuma.[n]
  • Type: Array
  • Cardinality: [0..1]
Enable Tts Of Email Capability A flag indicating whether the capability to access an email store for the purpose of playing the email via TTS is enabled for the user.
  • Field Name: cucuma.[n].EnableTtsOfEmailCapability
  • Type: Boolean
Enable Mailbox Synch Capability A flag indicating whether synchronization of mailbox contents between Connection and an external/third-party mail system is enabled.
  • Field Name: cucuma.[n].EnableMailboxSynchCapability
  • Type: Boolean
Is Primary Meeting Service A flag indicating whether this external service is the user's primary meeting service. A user is only allowed to schedule meetings on the MeetingPlace server that is designated as the user?s primary meeting service. This column applies only to a ServerType of MeetingPlace and EnableMeetingCapability must be enabled.
  • Field Name: cucuma.[n].IsPrimaryMeetingService
  • Type: Boolean
Object Id The primary key for this table. A globally unique, system-generated identifier for an subscriber external service map object. - template parameter [2]
  • Field Name: cucuma.[n].ObjectId
  • Type: String
User Password The user password for logon to the external service.
  • Field Name: cucuma.[n].UserPassword
  • Type: String
URI
  • Field Name: cucuma.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: cucuma.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Enable Meeting Capability A flag indicating whether the capability to access meeting information from a server is enabled for the user. For example, allowing a user to receive notification of a meeting about ready to start, providing join meeting and cancel meeting capabilities on the server, and allowing a user to schedule a meeting on the server.
  • Field Name: cucuma.[n].EnableMeetingCapability
  • Type: Boolean
Email Address Use Corp Flag indicating whether to use the EmailAddress specified in this row or the corporate e-mail address specified on the owning User.
  • Field Name: cucuma.[n].EmailAddressUseCorp
  • Type: Boolean
Sign-In Type Type of login to use
  • Field Name: cucuma.[n].LoginType
  • Type: Integer
  • Choices: ["Use Connection Alias", "Use User ID Provided Below"]
Subscriber Object Id * A foreign key to a Subscriber. The unique identifier of the subscriber object that is associated with the external service. - template parameter [1]
  • Field Name: cucuma.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Unified Messaging Service The Unified Messaging Service associated with this Unified Messaging Account
  • Field Name: cucuma.[n].ExternalServiceObjectId
  • Type: String
  • Target: /api/device/cuc/ExternalService/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24hFXi5JCIp2Ti2zUY%24L2gH9rScw1//0L%2B/iOG0zL8GwLh/0iK204V0TS0miOWe8CbAj5jNMCyY/QAszMFdmbywf6%2BIesXjJ5uU7/xESXISQvxJMq%2Bep1FdUDZfncEXO3F3Y25PgnXEX92jJdWh5ZtFaEJ50WxPGP5nJzSLdFMg9X3oPYNsPFF2XvQ3LkbkK0jSba4S3WIvmQKeI9HUo/%2BXGs8swwIuFXrvz0r%2Bdjg%2B9ZaiT3v6kMl0ePNemXbAuUPLI5ulUJmqZZyV1Rwd9514007WKcMsmm3tqXxWB5HfekCozW3bv3H2ffyFtAK2%2Br5tjJ5gN3yciSkQpLryN/5z8kvlhqvf4T4jm5AHg7i%2BV4fH7DLillK2KRVkwp8LTabFsUBeebEeHGOt%2BVYxmDmvWtVJDadu93KGaMRB1GqE%2By4iixPzNRbPJo7vyA%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/ExternalService
  • Format: uri
  • Choices: []
User Id The unique text name (e.g., logon name) used by the User to logon to the service.
  • Field Name: cucuma.[n].UserId
  • Type: String
User Profile Number Number that identifies a MeetingPlace Express 2.x user profile. Used to authenticate to Cisco Unified MeetingPlace Express from a touch-tone phone.
  • Field Name: cucuma.[n].UserProfileNumber
  • Type: String
Email Address The user's primary SMTP address on the selected external service. It's possible the user has other email addresses on other email servers, but in this case it has to be their primary email address on this specific server.
  • Field Name: cucuma.[n].EmailAddress
  • Type: String
User External Service Reset URI The URI to reset external service.
  • Field Name: cucuma.[n].UserExternalServiceResetURI
  • Type: String
Enable Calendar Capability A flag indicating whether the capabilities to access calendar information such as appointments, information for free/busy based PCTR rules, and for Exchange servers only, the capability to import a user's contacts from Exchange is enabled for the user.
  • Field Name: cucuma.[n].EnableCalendarCapability
  • Type: Boolean
Creation Time The date and time the user account was created.
  • Field Name: 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: 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: SaySender
  • Type: Boolean
URI
  • Field Name: URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Cucpass
  • Field Name: cucpass
  • Type: Object
Credential Policy URI
  • Field Name: cucpass.CredentialPolicyURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Locked A flag indicating whether access to the user account associated with this set of credentials is locked.
  • Field Name: cucpass.Locked
  • Type: Boolean
Time Hacked The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.
  • Field Name: cucpass.TimeHacked
  • Type: String
Time Changed The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.
  • Field Name: cucpass.TimeChanged
  • Type: String
URI
  • Field Name: cucpass.URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: cucpass.UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Credential Type The type of credential such as password, PIN, Windows or Domino credential.
  • Field Name: cucpass.CredentialType
  • Type: Integer
  • Choices: ["Password", "PIN"]
Alias The unique text name for either a user, distribution list, or personal group.
  • Field Name: cucpass.Alias
  • Type: String
Hacked A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.
  • Field Name: cucpass.Hacked
  • Type: Boolean
Password The PIN or password, for a user. The credentials are stored in an encrypted format.
  • Field Name: cucpass.Credentials
  • Type: String
  • Is Password: True
User Object Id * The unique identifier of the User object to which this credential belongs. - template parameter [1]
  • Field Name: cucpass.UserObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Time Last Hack The date and time of the last logon attempt with an invalid user credential.
  • Field Name: cucpass.TimeLastHack
  • Type: String
Time Lockout The date and time that the credential was locked by an administrator.
  • Field Name: cucpass.TimeLockout
  • Type: String
Doesnt Expire A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if allowed by CantChange).
  • Field Name: cucpass.DoesntExpire
  • Type: Boolean
Object Id Surrogate key to support IMS
  • Field Name: cucpass.ObjectId
  • Type: String
Cant Change A flag indicating whether the user can set this credential.
  • Field Name: cucpass.CantChange
  • Type: Boolean
Credential Policy Object Id The unique identifier of the CredentialPolicy object that is associated with this credential.
  • Field Name: cucpass.CredentialPolicyObjectId
  • Type: String
Hack Count The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid.
  • Field Name: cucpass.HackCount
  • Type: Integer
Is Primary A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.
  • Field Name: cucpass.IsPrimary
  • Type: Boolean
Cred Must Change A flag indicating whether the user must change their credentials (PIN or password) at the next login.
  • Field Name: cucpass.CredMustChange
  • Type: Boolean
Ldap Ccm Pkid The pkid of associated end user in the sleeping SeaDragon database.
  • Field Name: LdapCcmPkid
  • Type: String
Cucalt
  • Field Name: cucalt.[n]
  • Type: Array
Partition Name The name of the associated partition
  • Field Name: cucalt.[n].PartitionObjectId
  • Type: String
  • Target: /api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Xl4kReb5cWz5cvU8%242clAnX3uG69Z1wNjZXJs2BLcxOmziJbvh7dRy3r415/eI4PB1Qsk4JJEXOA/roYYz1Efq23n1njck/uE9X4CS/aPIH44%2ByaaZrzK%2BOK9WXI/onWyDwCKx9Be9OTVCutGamxNziXv%2B0s/uukDQqUsUBRY4o%2BcfP9Y4UCirRCu8MqzRCWf5uIxcyDQvL7lwxJ56Q0TrRCYHteVAqtf5kVy/uC/M1VsISl1yKmXyBUMlC1AYsS1qnqDJOIVTTaokBBy7AdHy4EIKSTuUz3BaaPCS46k7AhMY2XTBe7DhSTXKIjHXvtSFCDQuPrenk12Oo08uF1NBSK3ry8qUtmmwy/A2kDqN9LLUD1C/5RNqd/3ybWv4wkHLjxy8yV3QQm76%2B4ZCMwUMa7s9m/tLxVLlG7q/w3M%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Partition
  • Format: uri
  • Choices: []
Partition URI
  • Field Name: cucalt.[n].PartitionURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Object Id The primary key for this table. A globally unique, system-generated identifier for a DtmfAccessId object. - template parameter [2]
  • Field Name: cucalt.[n].ObjectId
  • Type: String
Phone Type * An index into the alternate extensions for a subscriber.
  • Field Name: cucalt.[n].IdIndex
  • Type: Integer
  • Choices: ["Work Phone", "Work Phone 2", "Home Phone", "Home Phone 2", "Mobile Phone", "Mobile Phone 2", "Work Fax", "Work Fax 2", "Home Fax", "Directory URI"]
URI
  • Field Name: cucalt.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Alternate Extension Advanced URI The URI to get the advanced setting of the alternate extension.
  • Field Name: cucalt.[n].AlternateExtensionAdvancedURI
  • Type: String
Dtmf Access Id * The dialable number.
  • Field Name: cucalt.[n].DtmfAccessId
  • Type: String
Location Object Id The unique identifier of the Location object to which this location (denormalized) belongs.
  • Field Name: cucalt.[n].LocationObjectId
  • Type: String
Display Name The text name of this DtmfAccessId to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.
  • Field Name: cucalt.[n].DisplayName
  • Type: String
User Object Id * template parameter [1]
  • Field Name: cucalt.[n].UserObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Location URI
  • Field Name: cucalt.[n].LocationURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Mailbox Dn The distinguished name of the mailbox.
  • Field Name: MailboxDn
  • Type: String
Phone Number A phone number.
  • Field Name: PhoneNumber
  • Type: String
Ccm Id Type Type of CCM user/object this id refers to (end user, application user, or directory number)
  • Field Name: CcmIdType
  • Type: Integer
Synch Schedule URI
  • Field Name: SynchScheduleURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: 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: ConfirmDeleteDeletedMessage
  • Type: Boolean
Callhandler
  • Field Name: Callhandler
  • Type: Object
Transfer
  • Field Name: Transfer.[n]
  • Type: Array
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: Callhandler.Transfer.[n].Action
  • Type: Integer
Transfer Holding Mode The action Cisco Unity Connection will take when the extension is busy.
  • Field Name: Callhandler.Transfer.[n].TransferHoldingMode
  • Type: Integer
Personal Call Transfer A flag indicating whether or not Personal Call Transfer Rules are used for the specific Transfer Option.
  • Field Name: Callhandler.Transfer.[n].PersonalCallTransfer
  • Type: Boolean
Extension The extension (phone number) to transfer to.
  • Field Name: Callhandler.Transfer.[n].Extension
  • Type: String
Transfer Option Type The type of transfer option, e.g. "Standard," "Off Hours," or "Alternate." - template parameter [2]
  • Field Name: Callhandler.Transfer.[n].TransferOptionType
  • Type: String
Callhandler URI
  • Field Name: Callhandler.Transfer.[n].CallhandlerURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Enabled If TimeExpires is set, this field is ignored.
  • Field Name: Callhandler.Transfer.[n].Enabled
  • Type: Boolean
URI
  • Field Name: Callhandler.Transfer.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: Callhandler.Transfer.[n].UsePrimaryExtension
  • Type: Boolean
Call Handler Object Id * The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]
  • Field Name: Callhandler.Transfer.[n].CallHandlerObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ZCTvGZdVxDK8GfYM%24xl3a1LH2QwnCpIJZe3UxXUnO61RD1hcccSyARV0o3LudbopZ7G4DsHFZl%2B8%2BSo4h%2B8OmPf8dDpKBGRGEgp36rcnS55KXhy%2B4OXFsWhTi%2BzJ/44MxMSLasbtUJNIbk4mLI8Roin1CpaDSyeR4pAJvyUNBvQScTZT/dZ214%2B8ckNuAG%2BJBCoIdXym3XHi%2BxG2yno1cN36zYIH9FEUBd0PRbagXajyGU1NoEWUibu1uiONQBSDKdsrpBVDZx1Cu/cR6MXdiGEKQtbG6G%2BhoP8RG2QMl2lUbu5KDcLqLUpI4gY6OO1bhknD/jbue0YeGR7OJ2K4svTw8xyRziV0vNuRgaYKULV/z%2Bs1Z6K1OhgOJ12m9bOQCIa%2Bk94sJItC7NmAIjWg%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
Transfer Announce A flag indicating whether Cisco Unity Connection plays "transferring call" when the subscriber answers the phone.
  • Field Name: Callhandler.Transfer.[n].TransferAnnounce
  • Type: Boolean
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: Callhandler.Transfer.[n].TransferConfirm
  • 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: Callhandler.Transfer.[n].TransferType
  • Type: Integer
Phone System URI
  • Field Name: Callhandler.Transfer.[n].PhoneSystemURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: Callhandler.Transfer.[n].TransferRings
  • Type: Integer
Transfer Dt Detect A flag indicating whether Cisco Unity Connection will check for dialtone before attempting to transfer the call.
  • Field Name: Callhandler.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: Callhandler.Transfer.[n].PlayTransferPrompt
  • Type: Boolean
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: Callhandler.Transfer.[n].TransferScreening
  • 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: Callhandler.Transfer.[n].TransferIntroduce
  • 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: Callhandler.Transfer.[n].RnaAction
  • Type: Integer
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: Callhandler.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: Callhandler.Transfer.[n].TimeExpires
  • Type: ["String", "Null"]
Message Sensitivity Determines if an outside caller can mark their message as private.
  • Field Name: Callhandler.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: Callhandler.VoiceName
  • Type: String
Partition URI
  • Field Name: Callhandler.PartitionURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Play Post Greeting Recording Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.
  • Field Name: Callhandler.PlayPostGreetingRecording
  • Type: Integer
  • Choices: ["Do Not Play Recording", "Play Recording to All Callers", "Play Recording Only to Unidentified Callers"]
Template Query parameter
  • Field Name: Callhandler.templateObjectId
  • Type: String
  • Target: /api/device/cuc/CallhandlerTemplate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Vi93bY1lztMjScwO%24Ita6xRdS/z091AYEhIDjLtw1MMhpwr%2BJ0fMlfy2srE99oTDjhGnzKJBGK3sg%2BIZd2jQ8lDyda7MZPRApfaSVhMp2H7dEHp%2BuK%2B5VGw7ELPYqX8ygeV/lgGYpWkdaahN7Km7vX1/7E02Zj0SWzoY9WVsWzKCRaOaopIoyVjSCFs8NdRk2tFj1hpxC%2B2v30Qm0MnA8ySZD1HKhgspBaTUCT6KnwIrvlnTlVz%2BedQzUXqUrWoWJql3KJ7KHMXewk9JCD1/MRnZ/iF3YrU8TKRxtVezkTrNcnlX9QHhenxgHtTnjiM973Xaux3FN7BNupUlKiDhY0GN3bmu/Bc4rv1TpFCS/P%2B2D4CedNroqg3pa6OOFC2tEGhXgpgdhebb3NUP4%2BkdlzuBw31noWezUQjmLE0FL5hl7Pwdf/fd9uZDbvwhRoPg%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/CallhandlerTemplate
  • Format: uri
  • Choices: []
Creation Time The date and time the handler is created.
  • Field Name: Callhandler.CreationTime
  • Type: String
Call Handler Owner URI The URI to fetch the call handler owners.
  • Field Name: Callhandler.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: Callhandler.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: Callhandler.UseDefaultTimeZone
  • Type: Boolean
Phone System URI
  • Field Name: Callhandler.PhoneSystemURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Recipient Distribution List URI
  • Field Name: Callhandler.RecipientDistributionListURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Time Zone TimeZone this call handler is operating in.
  • Field Name: Callhandler.TimeZone
  • Type: Integer
Voice Name URI
  • Field Name: Callhandler.VoiceNameURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Partition Name The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.
  • Field Name: Callhandler.PartitionObjectId
  • Type: String
  • Target: /api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Xl4kReb5cWz5cvU8%242clAnX3uG69Z1wNjZXJs2BLcxOmziJbvh7dRy3r415/eI4PB1Qsk4JJEXOA/roYYz1Efq23n1njck/uE9X4CS/aPIH44%2ByaaZrzK%2BOK9WXI/onWyDwCKx9Be9OTVCutGamxNziXv%2B0s/uukDQqUsUBRY4o%2BcfP9Y4UCirRCu8MqzRCWf5uIxcyDQvL7lwxJ56Q0TrRCYHteVAqtf5kVy/uC/M1VsISl1yKmXyBUMlC1AYsS1qnqDJOIVTTaokBBy7AdHy4EIKSTuUz3BaaPCS46k7AhMY2XTBe7DhSTXKIjHXvtSFCDQuPrenk12Oo08uF1NBSK3ry8qUtmmwy/A2kDqN9LLUD1C/5RNqd/3ybWv4wkHLjxy8yV3QQm76%2B4ZCMwUMa7s9m/tLxVLlG7q/w3M%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Partition
  • Format: uri
  • Choices: []
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: Callhandler.RecipientSubscriberObjectId
  • Type: String
  • Target: /api/device/cuc/User/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24s24mxaRdCSLJHjCv%24b2tAsd6NNBVqSvYcbPR2RD4nfcTp6wgwT98ZRFg4QDYmadE72V1uJZh%2BcbaVP1JrnYGYIEhKUzY8eRi1IfSMVKKeZBhAStJ2KZyzSZdnvapMnNk%2Bj%2BtxIVH8Cz5hpNEcDzCfsAIQ25h%2B317cP273AHAcWSgEkRs5cPOprf9bSvvsakEhAk89MHhB1KHB5PuRJZ/WaEFIi2NDtkUFwAWwCJmZ1qwZLWFy1YID35jbJFUu0jLL9tXTnduIhF8B4ITgyN/pCHUg59TiNtYKhpNdQS8UKxpL1wv/mhUqENzWwXg/G%2B/wzD/%2BxYjyivHtUQufGKnoyNhhZ0K8K7Lkj2o7O3GoqjdJzRmI20hvVTJZyGRnW2BRtklV3hXFcxApCX/5UickK%2B/GuPHMsiptuZg%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
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: Callhandler.CallSearchSpaceObjectId
  • Type: String
  • Target: /api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24nZFcCoGDEr1fiEPo%24rA2BHGUkG5eUHtBhXlpdcoL4Kumakrs0jPXPH7yX/B2MzH2Hd4wiaJgjEudW1oX8DgdOCtzDnh1CDLtXYdePDG/PhZezzmM4twQXaEswXU8/BYYAVye82um80DszuiULQ4tyg/1BkQcdPrBiMFnjiSYv7wpMateJUFhvJ6lEyTj2/xZUNCb3n%2BGvIySqR5J097yex4nwOePauLgKCohRkpaoXT%2BkPKcq8FdhpuQJXQzHFtYCssfh3th1XBfBrXwy9CJ4KARfjMwFmxl4OoJoFLzS/1tRwFhFclsEH%2BsLEEfzeV1AzStIU3EsG4iTtwIy/TuZwQDp8O7DkFhZUv/TBJY3mnZ4QW0js%2BTPrQgyncik2CwwOg9702ZiM54uV6NUL1v5ZZfAzFMAKYPzrB5r5ZLcHb4%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/SearchSpace
  • Format: uri
  • Choices: []
Object Id The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]
  • Field Name: Callhandler.ObjectId
  • Type: String
Use Call Language A flag indicating whether Cisco Unity Connection will use the language assigned to the call.
  • Field Name: Callhandler.UseCallLanguage
  • Type: Boolean
Localization Key Localization Key for Timezone update.
  • Field Name: Callhandler.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: Callhandler.ScheduleSetObjectId
  • Type: String
  • Target: /api/device/cuc/ScheduleSet/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24S34iSjK7RRqW4t94%24VTU73kmyny4eSN2tZagtm82k9bk5tdfRSfP1k2rEbv5WJ2AzO6VtPROfF36c4JU5v98LBf6jk/zgqgS1pQG06sPS9T0hErV%2BMWT8XLAkrgGEN9%2BZPYO025FOxJ03C8uNhscYYkiFuqdIev757qFG9fKpF9qB5RKBYjqPW7ohP9cvSNWlr99X8dAa0PB5V8TnoKXK4qVlhkM/mqjyBMOOd3BXOmezPhwUHEsWAwmfp/6ZgAjfw%2Bx%2B4Idp2t2nJX2q5xoOMbaykc%2BUGJaxSbVxw1LUr2PW7zOj541a6htyu4GZDc%2B9jzKCYQ3F%2BQIrrTq9V5AGr2MZjLSDVIpGAuP5ESdFZmNJBAgdxVw718bI2fZHkWSQuesXtYUapHv2OeirRi2F3Wv7e%2BNTjlYtWPiU34OD%2BcDwOtmnhGmA%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/ScheduleSet
  • Format: uri
  • Choices: []
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: Callhandler.OneKeyDelay
  • Type: Integer
Dispatch Delivery A flag indicating that all messages left for the call handler is for dispatch delivery.
  • Field Name: Callhandler.DispatchDelivery
  • Type: Boolean
Schedule Set URI
  • Field Name: Callhandler.ScheduleSetURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
After Message Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: Callhandler.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: Callhandler.MaxMsgLen
  • Type: Integer
Edit Msg A flag that determines whether the caller can edit messages.
  • Field Name: Callhandler.EditMsg
  • Type: Boolean
Menu Entries URI
  • Field Name: Callhandler.MenuEntriesURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Is Primary A flag indicating whether this is a "primary" call handler for a subscriber, or an "application" call handler.
  • Field Name: Callhandler.IsPrimary
  • Type: Boolean
Prepend Digits Touch-Tone digits to prepended to extension when dialing transfer number ( #, 0,1...9,*).
  • Field Name: Callhandler.PrependDigits
  • Type: String
Location The unique identifier of the Location object to which this handler belongs.
  • Field Name: Callhandler.LocationObjectId
  • Type: String
  • Target: /api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%249C4X8PGdrquOuYhJ%24OF2yMVsKe0FXo/GPW3/SgUPwcJfdoTidVeFsDeWHqwBedRvzcVpEWMD4fDMLfXilWzltR1dkdAa7XeOEvhoznmXSmI1vhwHQQfivAo3fbalAEgC3F64YyT3xiM5lgkZ74bkHK2BZ0RHhSu%2BlNlyn4lRBIA6L9jPTFnDYwwGiH9HgjTeibPlI6cgRt2V1O9DGNUREkAFOVD5KRANCwQ7fZC9EZEF%2B9PTDjXueld6VkW6D%2BFMlXRDSsK3ZIoCuQkFSuzMcdMhfsbEupDfDhp0u4bXBSQXwGvs20Ex3bFOMtwCFlFxKsVE03QEt6GALl%2Bf7bX3fJS5dKOGQY/nTcHm9l88fhsmWggQxCGAjSmPP3SDSDsB4xAmEjXq7KN2NZWMQIhfMcv9lW6xUbbrNpq9qFy84IQaXRgX4%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Location
  • Format: uri
  • Choices: []
Language The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.
  • Field Name: Callhandler.Language
  • Type: Integer
  • Choices: ["English(UnitedStates)"]
Transfer Options URI
  • Field Name: Callhandler.TransferOptionsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Play After Message Recording A Link To a PostGreetingRecording that is used as After Message Recording
  • Field Name: Callhandler.PlayAfterMessageRecordingObjectId
  • Type: String
  • Target: /api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24aRAOooMfDiOdlSOe%24LG4cB7FwoDpu5f93YkN6bIWVmcmjWFTxd88ozzs%2BzFpfMzTWpxfCCHm9wOgwYSCiRXJLG8LM56iqpxXWqghLxlEhumN7uL3b/ry5CyOpiNKpLIX2EvGtIUP4Zg1FMqIjv6rXpTWnXsD/0Bi1XVoN/fvrZ2RMLZUF3sDYdVFOUzcRXtCn8pg1sVJDeczhz4sWjFIZ6AOPM%2Bxw8q3manTlcL%2B9oXTRWDrOexXW/dCVxgfynL5SwFekjNlhcpSp1mpnhq801i5fiK%2BSytyYD24LRVne0G/CU53ZSxYO%2B0zrYu6VaBPMeIoS5kLqlRcfvDTIC6tbM6%2B0cs3lPTFyGCI2o8r/ihu1Fb/xSIaQPYdRTwS9aJ1Jh%2BD/Jgot0SnX2ZcMrVyuWWcFZ88Fjm/aQtfI3z7jS94z8IslYwGggIyGDPgSO%2BefLA%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PostGreetingRecording
  • Format: uri
  • Choices: []
Is Template A flag indicating whether this CallHandler is a "template" for creating new call handlers.
  • Field Name: Callhandler.IsTemplate
  • Type: Boolean
Recipient User URI
  • Field Name: Callhandler.RecipientUserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Call Search Space URI
  • Field Name: Callhandler.CallSearchSpaceURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
URI
  • Field Name: Callhandler.URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Recipient Contact URI
  • Field Name: Callhandler.RecipientContactURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Play After Message Indicates whether the Sent Message Prompt Recording referenced by Post Greeting
  • Field Name: Callhandler.PlayAfterMessage
  • Type: Integer
  • Choices: ["Do Not Play Recording", "System Default Recording"]
Greetings URI
  • Field Name: Callhandler.GreetingsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
After Message Target Handler The unique identifier of the specific object to send along to the target conversation.
  • Field Name: Callhandler.AfterMessageTargetHandlerObjectId
  • Type: String
  • Target: /api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24T6NduIO4AENAlW4J%24dNdjkNHHkh3T3zIy7lq94cQAIk5A5qozm6ArNeQEYTkGC0zmKZgAJRsgo1tcjUFjW/NjFqV7SbGoHBvwHWAlTh2z/CvFEY65z75I7Sz4Yxxf5Va1kgnpKL8a38JyUT9nPK/rnsiwcf8bYQukXdd0fZ559WMXUpSwP4Z%2BG0B4V1etC%2BAn7wIebESwkQw9j6DjJezkiob5eTd7Z73YZMPx91cVgD%2B8qxR6RGHJ9YWvlJtNVzUops3TnJAc5w90a2hdc9HoKip8qCYFpJjpiocHrFCar9N6V4jqQ5K9mBu04lLVtY/76jKvjaKD3zSaD6wdxZBgHKmzX4BLhfxI7Ik%2BC1pZQAuLh8m8OL7rpKx1mJKm5tQK8EpzjrXrJcWF4KZOnCsCuCqdU/hr%2BYo8TvSzpTFzCZSy0QF0JJTc%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
Tenant Object Id Unique ObjectId of the tbl_Tenant
  • Field Name: Callhandler.TenantObjectId
  • Type: String
Message Urgency A flag indicating whether an unidentified caller can mark a message as "urgent."
  • Field Name: Callhandler.SendUrgentMsg
  • Type: Integer
  • Choices: ["Mark Normal", "Mark Urgent", "Ask Callers"]
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: Callhandler.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: Callhandler.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: Callhandler.CallhandlerMenuEntry.[n].ObjectId
  • Type: String
Transfer Number The phone number associated with the alternate contact
  • Field Name: Callhandler.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: Callhandler.CallhandlerMenuEntry.[n].TransferRings
  • Type: Integer
Callhandler URI
  • Field Name: Callhandler.CallhandlerMenuEntry.[n].CallhandlerURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
URI
  • Field Name: Callhandler.CallhandlerMenuEntry.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Call Handler * The unique identifier of the CallHandler object to which this menu entry belongs. - template parameter [1]
  • Field Name: Callhandler.CallhandlerMenuEntry.[n].CallHandlerObjectId
  • Type: String
  • Target: /api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24T6NduIO4AENAlW4J%24dNdjkNHHkh3T3zIy7lq94cQAIk5A5qozm6ArNeQEYTkGC0zmKZgAJRsgo1tcjUFjW/NjFqV7SbGoHBvwHWAlTh2z/CvFEY65z75I7Sz4Yxxf5Va1kgnpKL8a38JyUT9nPK/rnsiwcf8bYQukXdd0fZ559WMXUpSwP4Z%2BG0B4V1etC%2BAn7wIebESwkQw9j6DjJezkiob5eTd7Z73YZMPx91cVgD%2B8qxR6RGHJ9YWvlJtNVzUops3TnJAc5w90a2hdc9HoKip8qCYFpJjpiocHrFCar9N6V4jqQ5K9mBu04lLVtY/76jKvjaKD3zSaD6wdxZBgHKmzX4BLhfxI7Ik%2BC1pZQAuLh8m8OL7rpKx1mJKm5tQK8EpzjrXrJcWF4KZOnCsCuCqdU/hr%2BYo8TvSzpTFzCZSy0QF0JJTc%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
Touchtone Key The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). - template parameter [2]
  • Field Name: Callhandler.CallhandlerMenuEntry.[n].TouchtoneKey
  • Type: String
Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: Callhandler.CallhandlerMenuEntry.[n].TargetConversation
  • Type: String
Call Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: Callhandler.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: Callhandler.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: Callhandler.CallhandlerMenuEntry.[n].TargetHandlerObjectId
  • Type: String
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: Callhandler.Undeletable
  • Type: Boolean
Voice File URI
  • Field Name: Callhandler.VoiceFileURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
After Message Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: Callhandler.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: Callhandler.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: Callhandler.RecipientContactObjectId
  • Type: String
  • Target: /api/device/cuc/Contact/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%243lR9T9FvXpn0KYU9%24n1T9NWXF%2Be65iXcrhGA2vM8O9RczQBpu5eqyIoxKcMg5g%2BYLcObgl2xgktklOmRLfaFjFYhAo%2BrbXKwbCZYqhn%2BgaTihyfw9x2QhTqBnqUSExh%2BORdYyGjD4DHlK%2BmNanIt5cSRtEKPz1NfOqcsRIqtezXVjBLTjOIRKRqIE7DzsJUy%2Bciz1Lg5u9IagdBrCKk/cr0/N5FYnjEXHS//fD2FONeIK2/FZYwCCHZTPHyninQB/cvVTvizwPfBhwlvxaOnnDhRwgs8qM9jd9puCI63/wI4FXITbNAFtcP6H57e/9XwK7Jk56DCYlSkuXGh6sH4wV9qCGLucRiUIMzy2xqFvTkPtvjQaqigCp2HnpgcWCuNMQw/pohDdQHvlDqYkhbvbAmCQtwEfIslHnihwn7bi89MoxOo%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Contact
  • Format: uri
  • Choices: []
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: Callhandler.RecipientDistributionListObjectId
  • Type: String
  • Target: /api/device/cuc/DistributionList/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24bQzVw7B1wcM6HFKR%24ByzNNNmS2tE//f8fhgx3dzxOdhNbLYDWl4HN5/4jeVg%2BdP1zNF134IRBqM7FCpyCPmgqufYndn/11w2G0CdzZ5hYd6u8lxsoGPJs5Ps%2BUpav4kF1FDIxcHVBRCr5WHb51xFQUtBp7ZOzE21el4huVLr6ewEpAb28fVO40KiEYex1axJmzBQGQqLNVsObyS4M6%2BOIj0ZeUyJDfb/RMMzWoRrwJjcrzKjw68P6GNytEBlRTNgcu6i7UTux3Eja4QmpJsPyLEmw6tlmDQdVjyqNaGVO%2B0YKugn05y5BwPpfBUMoF4BdN/Vl8QEdjOlS%2Bt%2BSUQI/fFOpjqH1/9r0pq8Bxe5aYI/msyxWBHRnA5c2wl%2BRPkr6hmGfI0odjfMGOKw42DtPse4B3S2NxHLVxWinoVaDRy5LzRuzmgVtvAHLoAk%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/DistributionList
  • Format: uri
  • Choices: []
Dtmf Access Id The DTMF access id (i.e., extension) for the call handler. The dialable number.
  • Field Name: Callhandler.DtmfAccessId
  • Type: String
Send Secure Msg A flag indicating whether an unidentified caller can mark a message as "secure."
  • Field Name: Callhandler.SendSecureMsg
  • Type: Boolean
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: Callhandler.DisplayName
  • Type: String
Post Greeting Recording A link to a PostGreetingRecording
  • Field Name: Callhandler.PostGreetingRecordingObjectId
  • Type: String
  • Target: /api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24aRAOooMfDiOdlSOe%24LG4cB7FwoDpu5f93YkN6bIWVmcmjWFTxd88ozzs%2BzFpfMzTWpxfCCHm9wOgwYSCiRXJLG8LM56iqpxXWqghLxlEhumN7uL3b/ry5CyOpiNKpLIX2EvGtIUP4Zg1FMqIjv6rXpTWnXsD/0Bi1XVoN/fvrZ2RMLZUF3sDYdVFOUzcRXtCn8pg1sVJDeczhz4sWjFIZ6AOPM%2Bxw8q3manTlcL%2B9oXTRWDrOexXW/dCVxgfynL5SwFekjNlhcpSp1mpnhq801i5fiK%2BSytyYD24LRVne0G/CU53ZSxYO%2B0zrYu6VaBPMeIoS5kLqlRcfvDTIC6tbM6%2B0cs3lPTFyGCI2o8r/ihu1Fb/xSIaQPYdRTwS9aJ1Jh%2BD/Jgot0SnX2ZcMrVyuWWcFZ88Fjm/aQtfI3z7jS94z8IslYwGggIyGDPgSO%2BefLA%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PostGreetingRecording
  • Format: uri
  • Choices: []
Owner
  • Field Name: Owner.[n]
  • Type: Array
  • Cardinality: [0..1]
Distribution List Object Id The unique identifier of the DistributionList object to which this distribution list member belongs.
  • Field Name: Callhandler.Owner.[n].DistributionListObjectId
  • Type: String
Distribution List URI
  • Field Name: Callhandler.Owner.[n].DistributionListURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: Callhandler.Owner.[n].TargetHandlerObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ZCTvGZdVxDK8GfYM%24xl3a1LH2QwnCpIJZe3UxXUnO61RD1hcccSyARV0o3LudbopZ7G4DsHFZl%2B8%2BSo4h%2B8OmPf8dDpKBGRGEgp36rcnS55KXhy%2B4OXFsWhTi%2BzJ/44MxMSLasbtUJNIbk4mLI8Roin1CpaDSyeR4pAJvyUNBvQScTZT/dZ214%2B8ckNuAG%2BJBCoIdXym3XHi%2BxG2yno1cN36zYIH9FEUBd0PRbagXajyGU1NoEWUibu1uiONQBSDKdsrpBVDZx1Cu/cR6MXdiGEKQtbG6G%2BhoP8RG2QMl2lUbu5KDcLqLUpI4gY6OO1bhknD/jbue0YeGR7OJ2K4svTw8xyRziV0vNuRgaYKULV/z%2Bs1Z6K1OhgOJ12m9bOQCIa%2Bk94sJItC7NmAIjWg%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
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: Callhandler.Owner.[n].ObjectId
  • Type: String
User Object Id
  • Field Name: Callhandler.Owner.[n].UserObjectId
  • Type: String
URI
  • Field Name: Callhandler.Owner.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: Callhandler.Owner.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: Callhandler.UseDefaultLanguage
  • Type: Boolean
Phone System Default switch to use for transfers.
  • Field Name: Callhandler.MediaSwitchObjectId
  • Type: String
  • Target: /api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24A0zzqbREeHUOo4Lz%24GUzhthcU6hpjEPKuP1vHj5onTcw25h7fbhj5%2BstymNMuJ5KjR8Zf9xbSUp4enJFdtqZE6BvOOx6CbAG2gSIL903mhq%2BofrXshAaCPcI%2BQdpw126L%2Bl1YUKZtRTtaXz4eYGi2d0/%2B8%2BBXygkWDOelR8KnB4zimL0nfGpYaftiCS9/IaaxuQkqnBD5aP5WUtrzHM/El261kstD4yWGvu9ZrNd2U%2BVDnP8JzPWWH%2B/Qr7CBXWfpYXho0N%2BNN7hCB3o98CSsA%2B7EvLrjDbVd30bZMPiKPYCzeb6elOwj44AYyGVCfTgN7T/oPQ%2Bu8PD5W0XQIrCaFFjDU4ZiLbPV8AX/2TerozvG2APmgUGN62fc9%2B/307WhG9oKEo4yFT3keOJ32k%2BB60cCqsMjhWRrZWAM5%2Bg7%2B6eAx1rTDxFx%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PhoneSystem
  • Format: uri
  • Choices: []
Location URI
  • Field Name: Callhandler.LocationURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Enable Save Draft A flag indicating whether the save draft message feature is enabled for the subscriber.
  • Field Name: EnableSaveDraft
  • Type: Boolean
Alternate Names URI The URI to get the alternate names of the user.
  • Field Name: AlternateNamesURI
  • Type: String
Voice File URI
  • Field Name: VoiceFileURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Initials The initial letters of some or all of the names of this user.
  • Field Name: 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: 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: ExitCallActionObjectId
  • Type: String
  • Target: /api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24T6NduIO4AENAlW4J%24dNdjkNHHkh3T3zIy7lq94cQAIk5A5qozm6ArNeQEYTkGC0zmKZgAJRsgo1tcjUFjW/NjFqV7SbGoHBvwHWAlTh2z/CvFEY65z75I7Sz4Yxxf5Va1kgnpKL8a38JyUT9nPK/rnsiwcf8bYQukXdd0fZ559WMXUpSwP4Z%2BG0B4V1etC%2BAn7wIebESwkQw9j6DjJezkiob5eTd7Z73YZMPx91cVgD%2B8qxR6RGHJ9YWvlJtNVzUops3TnJAc5w90a2hdc9HoKip8qCYFpJjpiocHrFCar9N6V4jqQ5K9mBu04lLVtY/76jKvjaKD3zSaD6wdxZBgHKmzX4BLhfxI7Ik%2BC1pZQAuLh8m8OL7rpKx1mJKm5tQK8EpzjrXrJcWF4KZOnCsCuCqdU/hr%2BYo8TvSzpTFzCZSy0QF0JJTc%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
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: 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: SayTotalNewVoice
  • Type: Boolean
Say Total Saved A flag indicating whether Cisco Unity Connection announces the total number of saved messages in the subscriber mailbox.
  • Field Name: SayTotalSaved
  • Type: Boolean
Read Only If set to 1 (true) user is read-only and cannot be modified.
  • Field Name: ReadOnly
  • Type: Boolean
Cucmsghandler
  • Field Name: cucmsghandler
  • Type: Object
Object Id The primary key for this table. A globally unique system-generated identifier for a MessageHandler object. - template parameter [2]
  • Field Name: cucmsghandler.ObjectId
  • Type: String
Subscriber Object Id * The unique identifier of the Subscriber object to which this message handler belongs. - template parameter [1]
  • Field Name: cucmsghandler.SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
URI
  • Field Name: cucmsghandler.URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: cucmsghandler.UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Email The action to take for email messages.
  • Field Name: cucmsghandler.EmailAction
  • Type: Integer
  • Choices: ["Reject the Message", "Accept the Message", "Relay the Message", "Accept and Relay the Message"]
Relay Address The SMTP address to which messages should be relayed.
  • Field Name: cucmsghandler.RelayAddress
  • Type: String
Fax The action to take for fax messages.
  • Field Name: cucmsghandler.FaxAction
  • Type: Integer
  • Choices: ["Reject the Message", "Accept the Message", "Relay the Message", "Accept and Relay the Message"]
Voicemail The action to take for voicemail messages.
  • Field Name: cucmsghandler.VoicemailAction
  • Type: Integer
  • Choices: ["Reject the Message", "Accept the Message", "Relay the Message", "Accept and Relay the Message"]
Receipt The action to take for delivery receipt messages.
  • Field Name: cucmsghandler.DeliveryReceiptAction
  • Type: Integer
  • Choices: ["Reject the Message", "Accept the Message", "Relay the Message", "Accept and Relay the Message"]
Enable Message Bookmark A flag indicating whether Message Bookmark is enabled for the subscriber
  • Field Name: EnableMessageBookmark
  • 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: 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: 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: DisplayName
  • Type: String
Inbox Auto Refresh The rate (in minutes) at which Unity Inbox performs a refresh.
  • Field Name: InboxAutoRefresh
  • Type: Integer
Use Default Time Zone Indicates if the default timezone is being used.
  • Field Name: UseDefaultTimeZone
  • Type: Boolean
Phone System URI
  • Field Name: PhoneSystemURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
State The full name of the state or province where this user is located, or with which a user is associated.
  • Field Name: 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: AltLastName
  • Type: String
Hf
  • Field Name: HF
  • Type: Object
Name
  • Field Name: HF.name
  • Type: String
Language That Callers Hear
  • Field Name: HF.cuc_language_caller_hears
  • Type: String
Private Lists URI
  • Field Name: PrivateListsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: AnnounceUpcomingMeetings
  • Type: Integer
Mailbox Store Name The Mailbox store name of user.
  • Field Name: 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: SayAni
  • Type: Boolean
New Message Sort Order The order in which Cisco Unity Connection will sort new messages.
  • Field Name: NewMessageSortOrder
  • Type: Integer
  • Choices: ["Newest first", "Oldest first"]
Prompt Speed The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.
  • Field Name: PromptSpeed
  • Type: Integer
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: DtmfNameLast
  • Type: String
Fax Server The unique identifier of the FaxServer object for the subscriber.
  • Field Name: FaxServerObjectId
  • Type: String
  • Target: /api/device/cuc/FaxServer/choices/?choice_title=FaxServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24C9Hx6tJbcfeycg12%24L8UV4ELoEVWNSlETSn0TlszrsDQrC1xAUn3wSIUZMZvCggwT2DR8%2BPjgUh31F4vF8EXRMPQ9ibaHiEBLDt07eGtrsriWGUmUoI30wRg%2BGDHjHug4zPm3AsLeoWs4T00mtvVYZvsBI6m17MykvWvJugiJ3Gg8alJcz9Lo/zE9fOSaLB/Ol3a2C7o9CAxOScKguVfXg2krdXhTH%2BmrlAKGNpXz5FTSE/6SXGWYxhwJty3M5I1D6pKmcVYlng9XxqjdL6%2B0AAxRfuwuJjjA1WKNVqd5Hj1DQHqGMGWnvd1sVvz56dEQqRn/kEga6mu0GwFaL5j90bRvCTypXtzprXY2BoO5f98bhz0X30BcZ2uCU%2B5KE65/ctBrz6PjhyG2rPuPg9/DJw2Y%2BESODWxnPduqrIJLMMmFA9BFJzpT%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/FaxServer
  • Format: uri
  • Choices: []
Ldap Type The LDAP configuration information for the user.
  • Field Name: LdapType
  • Type: Integer
  • Choices: ["Do not Integrate with LDAP directory", "Integrate with LDAP directory", "Authenticate", "Integrate and Authenticate with LDAP directory", "Inactive"]
Localization Key Localization Key.
  • Field Name: LocalizationKey
  • Type: String
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: DtmfNameFirst
  • Type: String
Message Locator Sort Order The order in which Cisco Unity Connection will sort messages when the "Message Locator" feature is enabled.
  • Field Name: MessageLocatorSortOrder
  • 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: 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: 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: EnhancedSecurityAlias
  • Type: String
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: AssistantRowsPerPage
  • Type: Integer
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: ConfirmDeleteMultipleMessages
  • Type: Boolean
Conversation Name The name of the conversation the subscriber uses to set up, send, and retrieve messages.
  • Field Name: ConversationName
  • Type: String
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: SaySenderExtension
  • Type: Boolean
Inbox Messages Per Page The number of messages Unity Inbox displays in a page.
  • Field Name: 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: PabLastImported
  • Type: String
Pca Home Page The Home Page is the first page that is displayed after logging in to the PCA.
  • Field Name: 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: UpdateBroadcastMsg
  • Type: Boolean
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: SearchByNameSearchSpaceObjectId
  • Type: String
  • Target: /api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24nZFcCoGDEr1fiEPo%24rA2BHGUkG5eUHtBhXlpdcoL4Kumakrs0jPXPH7yX/B2MzH2Hd4wiaJgjEudW1oX8DgdOCtzDnh1CDLtXYdePDG/PhZezzmM4twQXaEswXU8/BYYAVye82um80DszuiULQ4tyg/1BkQcdPrBiMFnjiSYv7wpMateJUFhvJ6lEyTj2/xZUNCb3n%2BGvIySqR5J097yex4nwOePauLgKCohRkpaoXT%2BkPKcq8FdhpuQJXQzHFtYCssfh3th1XBfBrXwy9CJ4KARfjMwFmxl4OoJoFLzS/1tRwFhFclsEH%2BsLEEfzeV1AzStIU3EsG4iTtwIy/TuZwQDp8O7DkFhZUv/TBJY3mnZ4QW0js%2BTPrQgyncik2CwwOg9702ZiM54uV6NUL1v5ZZfAzFMAKYPzrB5r5ZLcHb4%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/SearchSpace
  • Format: uri
  • Choices: []
Say Copied Names A flag indicating whether Cisco Unity Connection announces the "copied" names during message playback for a subscriber.
  • Field Name: SayCopiedNames
  • 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: SpeechCompleteTimeout
  • Type: Integer
Mwis URI
  • Field Name: MwisURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: ForcedAuthorizationCode
  • Type: String
Video Service Accounts URI
  • Field Name: VideoServiceAccountsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: 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: SayMessageLengthAfter
  • Type: Boolean
Use Vui A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.
  • Field Name: 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: SpeechConfidenceThreshold
  • Type: Integer
First Digit Timeout The amount of time to wait (in milliseconds) for first digit when collecting touch tones.
  • Field Name: 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: 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: MediaSwitchObjectId
  • Type: String
  • Target: /api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24A0zzqbREeHUOo4Lz%24GUzhthcU6hpjEPKuP1vHj5onTcw25h7fbhj5%2BstymNMuJ5KjR8Zf9xbSUp4enJFdtqZE6BvOOx6CbAG2gSIL903mhq%2BofrXshAaCPcI%2BQdpw126L%2Bl1YUKZtRTtaXz4eYGi2d0/%2B8%2BBXygkWDOelR8KnB4zimL0nfGpYaftiCS9/IaaxuQkqnBD5aP5WUtrzHM/El261kstD4yWGvu9ZrNd2U%2BVDnP8JzPWWH%2B/Qr7CBXWfpYXho0N%2BNN7hCB3o98CSsA%2B7EvLrjDbVd30bZMPiKPYCzeb6elOwj44AYyGVCfTgN7T/oPQ%2Bu8PD5W0XQIrCaFFjDU4ZiLbPV8AX/2TerozvG2APmgUGN62fc9%2B/307WhG9oKEo4yFT3keOJ32k%2BB60cCqsMjhWRrZWAM5%2Bg7%2B6eAx1rTDxFx%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PhoneSystem
  • Format: uri
  • Choices: []
Exit Target Conversation The name of the conversation to which the caller is routed.
  • Field Name: ExitTargetConversation
  • Type: String
Saved Message Sort Order The order in which Cisco Unity Connection will sort saved messages.
  • Field Name: SavedMessageSortOrder
  • Type: Integer
Partition URI
  • Field Name: PartitionURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
First Name The first name (i.e., givenName) of this user. Not their surname nor middle name.
  • Field Name: 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: 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: 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: 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: 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: SkipReverseTime
  • Type: Integer
Country The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated.
  • Field Name: Country
  • Type: String
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: RouteNDRToSender
  • Type: Boolean
Template Alias Query parameter
  • Field Name: templateAlias
  • Type: ["String"]
  • Target: /api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24qVLzjsyMXf9XBgtM%248szO2TiIBUMfjY8mtJVtd79LGpNR/5/OjVPAD1I4i7XcTMNLKcZUiaCYCH%2BylPucv0LWxMojwf0VKwSMiGHBrNQAfHgWv/YKA8m0FSSHgxN4ra8/Cox2SpU0Qwe%2BaDV7UayMZlmDc570TCpoDid/3BMjVeOrNKUbYAsCjhOzyPDzUm6hxgbM%2Bf9syEWpvYgxwXa2CzNO55yOmJCbbvHL35ET5ZPLZDFJCX2rMtcu9ojw4kldqnj8LgECnNT/spO9FsPhM90by%2BwnMOwrSuxASY3NoKHa1TYDIKAUsnBlKeDzNyxW3YCLbslTpucPIW8jtOyeestfEvmAIO5pH/dgcl7u6rW2wo2ylsYUEvPecXfjFnhGozN2ay2JbJ1RCQy7%24%3D%3D
  • Target attr: Alias
  • Target Model Type: device/cuc/UserTemplate
  • Format: uri
  • Choices: []
Say Timestamp Before A flag indicating whether Cisco Unity Connection announces the timestamp before it plays back each for the subscriber.
  • Field Name: SayTimestampBefore
  • Type: Boolean
Partition Name The unique identifier of the Partition to which the DtmfAccessId is assigned.
  • Field Name: PartitionObjectId
  • Type: String
  • Target: /api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Xl4kReb5cWz5cvU8%242clAnX3uG69Z1wNjZXJs2BLcxOmziJbvh7dRy3r415/eI4PB1Qsk4JJEXOA/roYYz1Efq23n1njck/uE9X4CS/aPIH44%2ByaaZrzK%2BOK9WXI/onWyDwCKx9Be9OTVCutGamxNziXv%2B0s/uukDQqUsUBRY4o%2BcfP9Y4UCirRCu8MqzRCWf5uIxcyDQvL7lwxJ56Q0TrRCYHteVAqtf5kVy/uC/M1VsISl1yKmXyBUMlC1AYsS1qnqDJOIVTTaokBBy7AdHy4EIKSTuUz3BaaPCS46k7AhMY2XTBe7DhSTXKIjHXvtSFCDQuPrenk12Oo08uF1NBSK3ry8qUtmmwy/A2kDqN9LLUD1C/5RNqd/3ybWv4wkHLjxy8yV3QQm76%2B4ZCMwUMa7s9m/tLxVLlG7q/w3M%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Partition
  • Format: uri
  • Choices: []
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: SayMsgNumberAfter
  • 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: InboxAutoResolveMessageRecipients
  • Type: Boolean
User Web Password URI The URI to change the web application password.
  • Field Name: UserWebPasswordURI
  • 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: 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: AutoAdvanceMsgs
  • Type: Boolean
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: EnAltGreetDontRingPhone
  • Type: Boolean
Voice Name URI
  • Field Name: VoiceNameURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Enable Message Locator A flag indicating whether the message locator feature is enabled for the subscriber.
  • Field Name: 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: 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: IsSetForVmEnrollment
  • Type: Boolean
User Voice Pin URI The URI to change the voice mail pin of the user.
  • Field Name: UserVoicePinURI
  • Type: String
User Role URI The URI to change the role of the user.
  • Field Name: UserRoleURI
  • Type: String
Cucpager
  • Field Name: cucpager.[n]
  • Type: Array
Success Retry Interval The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.
  • Field Name: cucpager.[n].SuccessRetryInterval
  • Type: Integer
Display Name * The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc.
  • Field Name: cucpager.[n].DisplayName
  • Type: String
After Dial Digits The extra digits (if any) that Cisco Unity Connection will dial after the phone number. For numeric pagers, the extra digits are shown on the pager display.
  • Field Name: cucpager.[n].AfterDialDigits
  • Type: String
User URI
  • Field Name: cucpager.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Busy Retry Interval The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.
  • Field Name: cucpager.[n].BusyRetryInterval
  • Type: Integer
Phone System URI
  • Field Name: cucpager.[n].PhoneSystemURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Retries On Success The number of times Cisco Unity Connection will retry the notification device if it is successful.
  • Field Name: cucpager.[n].RetriesOnSuccess
  • Type: Integer
Send Count A flag indicting whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message.
  • Field Name: cucpager.[n].SendCount
  • Type: Boolean
Max Subject The maximum number of characters allowed in the 'subject' of a notification message.
  • Field Name: cucpager.[n].MaxSubject
  • Type: Integer
Device Name The "DeviceName" of the notification device.
  • Field Name: cucpager.[n].DeviceName
  • Type: String
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: cucpager.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: cucpager.[n].ScheduleSetObjectId
  • Type: String
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: cucpager.[n].Active
  • Type: Boolean
Rna Retry Interval The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.
  • Field Name: cucpager.[n].RnaRetryInterval
  • Type: Integer
Retries On Busy The number of times Cisco Unity Connection will retry the notification device if it is busy.
  • Field Name: cucpager.[n].RetriesOnBusy
  • Type: Integer
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: cucpager.[n].RepeatInterval
  • Type: Integer
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDevicePager object. - template parameter [2]
  • Field Name: cucpager.[n].ObjectId
  • Type: String
Max Body The maximum number of characters allowed in the 'body' of a notification message.
  • Field Name: cucpager.[n].MaxBody
  • Type: Integer
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: cucpager.[n].EventList
  • Type: String
Send Caller Id A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message.
  • Field Name: cucpager.[n].SendCallerId
  • Type: Boolean
URI
  • Field Name: cucpager.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Dial Delay The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.
  • Field Name: cucpager.[n].DialDelay
  • Type: Integer
Phone Number The phone number to dial, including the trunk access code, to send a page.
  • Field Name: cucpager.[n].PhoneNumber
  • Type: ["String", "Null"]
Undeletable Device cannot be deleted.
  • Field Name: cucpager.[n].Undeletable
  • Type: Boolean
Rings To Wait The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.
  • Field Name: cucpager.[n].RingsToWait
  • Type: Integer
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: cucpager.[n].FailDeviceObjectId
  • Type: String
Wait Connect A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits.
  • Field Name: cucpager.[n].WaitConnect
  • Type: Boolean
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: cucpager.[n].InitialDelay
  • Type: Integer
Retries On Rna The number of times Cisco Unity Connection will retry the notification device if the device does not answer.
  • Field Name: cucpager.[n].RetriesOnRna
  • Type: Integer
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: cucpager.[n].RepeatNotify
  • Type: Boolean
Media Switch Object Id * The unique identifier of the MediaSwitch object to use for notification.
  • Field Name: cucpager.[n].MediaSwitchObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24SXOvySNEGYgYZey1%24t%2Bfy%2BhiUkWEw%2BSlB51gj9RPauphFQAOLt3dNTEjzNoz2AQABbqcJZkvRVqLS%2B1XajPG9cE03G2R/6qNTaX0EtwEF5jXuNMnCVtrn2fNiOaLSczrJ6PeaUntGD/KI/sIA3B4ktlXeTuPajzf7EtX4hDvIzyKmAkqPoXulvyBVGczA9FBQT1cBJvby/cHG%2BOx1BRQAzRqiCvB6FHmYqTrXm/AMnmRDlfD2WI5lauC1xHzWrAS/89vbM7rw3Ui5F61ViAfaoMdh4NoOtDQhOcxTB10JM0bEfFHgD2RgJ9YL7T51ph/lcfSRTqhj55f1pxoJfz2yJjSiVFJ2bUv8U/Lep/iTE2zON3lDB%2BG1JzS6DQvBgg%2B0Rc3vwua6AOzz8UQ2xrw%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/PhoneSystem
  • Format: uri
  • Choices: []
Transmit Forced Authorization Code A flag indicting whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.
  • Field Name: cucpager.[n].TransmitForcedAuthorizationCode
  • Type: Boolean
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: ClockMode
  • Type: Integer
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: RetainUrgentMessageFlag
  • Type: Boolean
Ldap Ccm User Id The userid of associated end user in the sleeping SeaDragon database.
  • Field Name: 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: SayAniAfter
  • Type: Boolean
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: RingPrimaryPhoneFirst
  • Type: Boolean
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: PostalCode
  • Type: String
Xfer String The cross-server transfer extension. If NULL, the user's primary extension is used.
  • Field Name: XferString
  • Type: String
Confirmation Confidence Threshold Voice Recognition Confirmation Confidence Threshold
  • Field Name: 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: Undeletable
  • Type: Boolean
Delay After Greeting The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting.
  • Field Name: DelayAfterGreeting
  • Type: Integer
Encrypt Private Messages A flag indicating whether Cisco Unity Connection encrypts messages from the subscriber that are marked private.
  • Field Name: 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: 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: NewMessageStackOrder
  • Type: String
Notification Devices URI
  • Field Name: NotificationDevicesURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Mailbox Store Mailbox Store for the tenant.
  • Field Name: MailboxStoreObjectId
  • Type: String
  • Target: /api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24VHzMuCeHIVRFEfr3%24O%2BHq55Jp1dGezEvVUPW%2BAqZl1XOu9wnz9K0C4ZjbIeNUWriuuGYNdP8yxH96XHwQBtMiBZ2zRxCNnGLkOoZc5MyBEK0zxybkIpwDEUGlkrBgQqbUDl859YacGw/ard/c4ZX0iJv%2BinVp20s4JyjNFSbEj%2B2okhIakal%2BiZfnfA2FjRPdrZP972s4zRNGDwo0MSD1tUCSvzJ0oUB9aWXlj%2BG2yJW9o1Cxr5YQVSj15wzKhfboDEIS3Xwkrca%2Bc%2BvicVu9i59A8x13RxZJk78ND5YCEhG0b1G41t15IeMXF0ldgf11N1gW9WjE2iUMoxlF2NZvzNDLoCXw1jCUMf%2B87fr1hVPizd/r6GqADR8FW86gQyufmgQx5mx4PUa5o60HK2HTMt20E7XxRkfaSqVAJBP4/1RZh0UI4wzwtg%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/MailboxStore
  • Format: uri
  • Choices: []
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: IsVmEnrolled
  • Type: Boolean
Inactive A flag indicating whether this subscriber is inactive or not.
  • Field Name: Inactive
  • Type: Boolean
Email Address The corporate email address of the user.
  • Field Name: 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: 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: SearchByExtensionSearchSpaceObjectId
  • Type: String
  • Target: /api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24nZFcCoGDEr1fiEPo%24rA2BHGUkG5eUHtBhXlpdcoL4Kumakrs0jPXPH7yX/B2MzH2Hd4wiaJgjEudW1oX8DgdOCtzDnh1CDLtXYdePDG/PhZezzmM4twQXaEswXU8/BYYAVye82um80DszuiULQ4tyg/1BkQcdPrBiMFnjiSYv7wpMateJUFhvJ6lEyTj2/xZUNCb3n%2BGvIySqR5J097yex4nwOePauLgKCohRkpaoXT%2BkPKcq8FdhpuQJXQzHFtYCssfh3th1XBfBrXwy9CJ4KARfjMwFmxl4OoJoFLzS/1tRwFhFclsEH%2BsLEEfzeV1AzStIU3EsG4iTtwIy/TuZwQDp8O7DkFhZUv/TBJY3mnZ4QW0js%2BTPrQgyncik2CwwOg9702ZiM54uV6NUL1v5ZZfAzFMAKYPzrB5r5ZLcHb4%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/SearchSpace
  • Format: uri
  • Choices: []
Cucsms
  • Field Name: cucsms.[n]
  • Type: Array
Display Name * The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc.
  • Field Name: cucsms.[n].DisplayName
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]
  • Field Name: cucsms.[n].ObjectId
  • Type: String
Device Name The "DeviceName" of the notification device.
  • Field Name: cucsms.[n].DeviceName
  • Type: String
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: cucsms.[n].EventList
  • Type: String
Send Caller Id A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message.
  • Field Name: cucsms.[n].SendCallerId
  • Type: Boolean
Smpp Provider Object Id * The unique identifier of the SMPPProvider object that is used by this notification device.
  • Field Name: cucsms.[n].SmppProviderObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24udAYBRUcgqhPqLGs%24oZrQdCbbekGyw%2B%2BXnOEaSVMcB5avO%2BDcVzw1/UivgxLYOWV/WKBzkaPIKCLxISkZ0wojE5u2kt6oCySRmBJFglRtgps3KCZTR4OeMtnAiZNKJ8hr75lv1TikbflKJiY5ISRto2YynPAMEAQ0wY9Cin9gBVsMooFVUsdf0NT5BH0t7NDW8hc/0hvbrWmrHhyzPVVE6QeH2JO%2BDA/ZDTKyMsxxx3DbUclyqDUNYE0rzZgsxGZpCW6gMgKGb2TxKEiRCtXkTJMxF7EOdCaZhyjOa2UOyoQsYXJAuKtECszmwcH1%2BvzSTd48Fsir3EMLZZa/UeZOGq8y6lZWmNzFZdTEzpsTe/qp3JoPMJmSRgSuTG9vdwytqdrm5LtDU84k6M/hJfmq%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/SmppProvider
  • Format: uri
  • Choices: []
User URI
  • Field Name: cucsms.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Recipient Address The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the "To:" field.
  • Field Name: cucsms.[n].RecipientAddress
  • Type: String
Send Count A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message.
  • Field Name: cucsms.[n].SendCount
  • Type: Boolean
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: cucsms.[n].RepeatInterval
  • Type: Integer
Max Subject The maximum number of characters allowed in the 'subject' of a notification message.
  • Field Name: cucsms.[n].MaxSubject
  • Type: Integer
URI
  • Field Name: cucsms.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Max Body The maximum number of characters allowed in the 'body' of a notification message.
  • Field Name: cucsms.[n].MaxBody
  • Type: Integer
Static Text The text message that the subscriber wants to receive in a Text Pager notification. For Text Pager notifications only. The SA refers to this as the "Send:" field. Typically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.
  • Field Name: cucsms.[n].StaticText
  • Type: String
Undeletable Device cannot be deleted.
  • Field Name: cucsms.[n].Undeletable
  • Type: Boolean
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: cucsms.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: cucsms.[n].ScheduleSetObjectId
  • Type: String
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: cucsms.[n].InitialDelay
  • Type: Integer
Sender Address The return phone number for the message notification. Typically, this column contains the number that the subscriber calls to check messages (i.e., pilot number for Cisco Unity Connection voice mail). If the SMPP Provider requires a source address for the server sending the message, the SMSC will overwrite this data with an IP address. In CUSA, this is referred to as the "From:" field.
  • Field Name: cucsms.[n].SenderAddress
  • Type: String
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: cucsms.[n].RepeatNotify
  • Type: Boolean
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: cucsms.[n].Active
  • Type: Boolean
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: cucsms.[n].FailDeviceObjectId
  • Type: String
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: PcaAddressBookRowsPerPage
  • Type: Integer
Location URI
  • Field Name: LocationURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Say Distribution List A flag indicating whether Cisco Unity Connection announces the distribution list that sends a message, if applicable.
  • Field Name: 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: City
  • Type: String
Send Broadcast Msg A flag indicating whether the subscriber may send broadcast messages.
  • Field Name: SendBroadcastMsg
  • Type: Boolean
Exit Action The type of call action to take, e.g., hang-up, goto another object, etc.
  • Field Name: ExitAction
  • Type: Integer
Voice Name Required A flag indicating whether a recorded voice name is required for this subscriber.
  • Field Name: VoiceNameRequired
  • Type: Boolean
Search By Extension Search Space URI
  • Field Name: SearchByExtensionSearchSpaceURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Smtp Proxy Addresses URI The URI to get the smtp proxy addresses of the user.
  • Field Name: SmtpProxyAddressesURI
  • Type: String
Message Handlers URI
  • Field Name: MessageHandlersURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: SayTotalNewFax
  • Type: Boolean
Call Handler The unique identifier of the primary CallHandler object for the subscriber.
  • Field Name: CallHandlerObjectId
  • Type: String
  • Target: /api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24T6NduIO4AENAlW4J%24dNdjkNHHkh3T3zIy7lq94cQAIk5A5qozm6ArNeQEYTkGC0zmKZgAJRsgo1tcjUFjW/NjFqV7SbGoHBvwHWAlTh2z/CvFEY65z75I7Sz4Yxxf5Va1kgnpKL8a38JyUT9nPK/rnsiwcf8bYQukXdd0fZ559WMXUpSwP4Z%2BG0B4V1etC%2BAn7wIebESwkQw9j6DjJezkiob5eTd7Z73YZMPx91cVgD%2B8qxR6RGHJ9YWvlJtNVzUops3TnJAc5w90a2hdc9HoKip8qCYFpJjpiocHrFCar9N6V4jqQ5K9mBu04lLVtY/76jKvjaKD3zSaD6wdxZBgHKmzX4BLhfxI7Ik%2BC1pZQAuLh8m8OL7rpKx1mJKm5tQK8EpzjrXrJcWF4KZOnCsCuCqdU/hr%2BYo8TvSzpTFzCZSy0QF0JJTc%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Callhandler
  • Format: uri
  • Choices: []
Time Zone The time zone to which this user account is associated.
  • Field Name: 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: 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: NameConfirmation
  • Type: Boolean
Search By Name Search Space URI
  • Field Name: SearchByNameSearchSpaceURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: 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: 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: SynchScheduleObjectId
  • Type: String
  • Target: /api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24l6FMY1JPneKMHZXg%24oNHgxTNMJtfvco0tgXX%2BBtwm3OiO5i%2Bd0ng8kG%2Bbtfc%2B9IKRHWTwU%2BhYzKcngzUwAF4jyYgQxadhzwwDSiKDP3gZWOC6BEj%2BkPIyVECQWUje2l1m6Cfd0R43BXSkhLWdbds034QZCuzEVO97f1fQ/nM//1TJ2uFq4gwaFLQL6DvGYYpYBvUaTb3iNLnI6HHvd%2B86uzLNKl0pb1beAyYLqEkch/7DOTcVfaCiy6Zk7gqQGDru%2BJ5D3KgQi1xb07VEnabhKhLG3c/IrABnHn6o7wv7DI98BlVRDgxRX4Cei4cB/lI2PTLYqD5x5BAw/SAIKVWEdWH3bOTT82YAENZfvJuppqQhMMwz9uxN0shHt3xnoIUMOMeF8/Kzxnf9vo4n2Mo8CmWR0tU4Mhk76CR6I6hLEbgLi2C6%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Schedule
  • Format: uri
  • Choices: []
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: 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: RecordUnknownCallerName
  • Type: Boolean
Fax Server URI
  • Field Name: FaxServerURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: CallAnswerTimeout
  • Type: Integer
Volume The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message.
  • Field Name: Volume
  • Type: Integer
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: Address
  • Type: String
Interdigit Delay The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.
  • Field Name: InterdigitDelay
  • Type: Integer
Speed The audio speed Cisco Unity Connection uses to play back messages to the subscriber.
  • Field Name: Speed
  • Type: Integer
Cos URI
  • Field Name: CosURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Smtp Address SMTP address The full SMTP address for this object.
  • Field Name: SmtpAddress
  • Type: String
Time Last Call The date and time when the subscriber last accessed their mailbox by phone (last time they were offered messages).
  • Field Name: TimeLastCall
  • Type: String
Class of Service The name of the Class of Service object with which this user account is associated.
  • Field Name: CosObjectId
  • Type: String
  • Target: /api/device/cuc/Cos/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24znSdHercvMSG2v6e%24yq%2BofsBdytw4XH6zw%2Bpp0GR6CD8UC1s3YLdrHkFkXWPzJIrpF5gW6J2inkLnBq%2BgR0uifH1PFx826Q5YT%2BBSGFN/Vw%2B/npdSKf4cCDq0a2Xw%2Bap7DFMPakysmYqq%2BoU8bQe3VNYkoh9fvuACUDZwdVtqLsY0YRg9YUA1oKcHlkDxkDl5JcL%2BslNdDjmX6EMoQHfGm/TmwY%2BmKZ8ds7dFHrIcTPEqfZihM6yPl6CYFl863K21tPFIoiDLrWldp8o6PzrwOA/rxcVuiQcsuOq9c%2BKavU/PwA6/Z2J/cZjUXIqRHl/gnRBpgz79vOvdqAlaWCEYicUe6LyroV0W2G41bUcBfHB7Z847qVi8IHf07wXje/svMIQetxcjpUpkFyFgnajGFze1sMRMa4jrU9eKwtwfUw%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Cos
  • Format: uri
  • Choices: []
Say Message Length A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.
  • Field Name: SayMessageLength
  • Type: Boolean
Callhandler URI
  • Field Name: CallhandlerURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
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: SayAltGreetWarning
  • Type: Boolean
Alias * The unique text name for either a user, distribution list, or personal group.
  • Field Name: Alias
  • Type: String
Prompt Volume The volume level for playback of system prompts.
  • Field Name: PromptVolume
  • Type: Integer
Cuchtml
  • Field Name: cuchtml.[n]
  • Type: Array
Disable Mobile Number From PCA A flag indicating whether Cisco Unity Connection will not allow PCA to change Mobile Number.
  • Field Name: cuchtml.[n].DisableMobileNumberFromPCA
  • Type: Boolean
Smtp Address The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the "To:" field.
  • Field Name: cuchtml.[n].SmtpAddress
  • Type: String
Display Name * The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc.
  • Field Name: cuchtml.[n].DisplayName
  • Type: String
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceHTML object. - template parameter [2]
  • Field Name: cuchtml.[n].ObjectId
  • Type: String
Disable Template Selection From PCA A flag indicating whether Cisco Unity Connection will not allow PCA to select notification templates.
  • Field Name: cuchtml.[n].DisableTemplateSelectionFromPCA
  • Type: Boolean
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: cuchtml.[n].EventList
  • Type: String
URI
  • Field Name: cuchtml.[n].URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: cuchtml.[n].UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Allow Voice Mail As Attachment A flag indicating whether Cisco Unity Connection will allow notifier to send voice mail recording with the notification.
  • Field Name: cuchtml.[n].AllowVoiceMailAsAttachment
  • Type: Boolean
Message Count In Summary Field to store number of messages to be sent in summary notification mail
  • Field Name: cuchtml.[n].MessageCountInSummary
  • Type: Integer
Callback Number
  • Field Name: cuchtml.[n].CallbackNumber
  • Type: String
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: cuchtml.[n].RepeatInterval
  • Type: Integer
Undeletable Device cannot be deleted.
  • Field Name: cuchtml.[n].Undeletable
  • Type: Boolean
Device Name The "DeviceName" of the notification device.
  • Field Name: cuchtml.[n].DeviceName
  • Type: String
Send Scheduled Notification At Comma separated list of time slots at which scheduled notification will be triggered at daily basis.
  • Field Name: cuchtml.[n].SendScheduledNotificationAt
  • Type: String
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: cuchtml.[n].SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: cuchtml.[n].ScheduleSetObjectId
  • Type: String
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: cuchtml.[n].InitialDelay
  • Type: Integer
Notification Template ID The unique identifier of the Notification Template object which this notification device is using for HTML based notification
  • Field Name: cuchtml.[n].NotificationTemplateID
  • Type: ["String"]
  • Target: /api/device/cuc/NotificationTemplate/choices/?field=NotificationTemplateID&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Nq1NIOFHyte00UUr%241DaPL49EAaXnknvgIk/CZbThAb58rnXJ%2BGyUyO%2BNdbXaPr4p/nRDVsZhAnPDWrTJkicxKoCAceqMc1iVA/3Ldy8D9zWTiY0tHX5m4H6hFXLzZXklUQ9lgTW0tXChD65zuPleyWuhluOWVqW88svLMajfyeLXqvQQ5YmaAIceXxEDIYnKCgEhNRn682YyC/hVhH7i5Jb3SecMfINEaQRw2qPtroOYXMNLwyeMxrB/h7BIDTTkaOQkYcoBQL6M8fOxkcuI1etM54cNMpkthDNHtkkgdbrkvkMogzat1g3C0nPOJnuRzQZdIMQibDUWFqfynLKhwflxU%2BPet%2BjrXDuniB85l920xu6HODuHdX2om6TWI41ZJ6Az3wEUXLpuIV%2BNhYP4MCC/5MvGfTuy9NguFBc3x%2BJbQ3%2BOsg%3D%3D%24%3D%3D
  • Target attr: NotificationTemplateID
  • Target Model Type: device/cuc/NotificationTemplate
  • Format: uri
  • Choices: []
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: cuchtml.[n].RepeatNotify
  • Type: Boolean
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: cuchtml.[n].Active
  • Type: Boolean
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: cuchtml.[n].FailDeviceObjectId
  • Type: String
Tenant The name of the tenant to which the user belongs.
  • Field Name: TenantObjectId
  • Type: String
  • Target: /api/device/cuc/Tenant/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24oc4a0QA7vfYvWlh4%24aFKwvU0K5rao4x6v8veAz3uueGq%2B18ewL4PfPqlY6WQEpcMdqReC60qUh%2BD4vzDrsdgWxB6x%2ByaFwxivpYFQu8Ba9BSos4MNR6qwu3UW2yoGpqLFrCvFtdZNB8PFQpXVvJFsIXb/29jSvLXLDNbua1%2Bgh2Jn732wMFABPYcO7zcEjV2Yd8LD1aZ7Jhe2kUNumTPRwXzhnGe1NQNnVsCQesuXYEu4BEAWBB9UmbEOWAUnyWO63W28Y6wW5zZ7kBoUJ9ADvsBvOqQ7B4xFKymztzm4Tiok52H15goG1IWBIvGRA4Xfnf2zjKpiggmd7CrCYFPUMmMptHmM8L3VRqgX%2BkxtCERvrMGPJd7JyfK/FUYM6ViHWnLO2LNuIUU2fjG7Ju2tLLl%2BXEL5nJt3Jr3rBw%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/Tenant
  • Format: uri
  • Choices: []
Say Total Draft Msg A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox
  • Field Name: 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: 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: SayTotalNewEmail
  • 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: UseDynamicNameSearchWeight
  • Type: Boolean
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: SendMessageOnHangup
  • Type: Integer
Alternate Extensions URI
  • Field Name: AlternateExtensionsURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Dialable Phone Number A dialable version of the PhoneNumber column.
  • Field Name: 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: 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: UseShortPollForCache
  • Type: Boolean
Dtmf Access Id * The DTMF access id (i.e., extension) of the subscriber. The dialable number.
  • Field Name: DtmfAccessId
  • Type: String
Manager The name of the person who is the manager or supervisor of the user.
  • Field Name: Manager
  • Type: ["String", "Null"]
Billing Id Accounting information or project code associated with this user.
  • Field Name: BillingId
  • Type: String
List In Directory A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.
  • Field Name: ListInDirectory
  • Type: Boolean
Deleted Message Sort Order The order in which Cisco Unity Connection presents deleted messages to the subscriber.
  • Field Name: 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: 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: UseDefaultLanguage
  • 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: SpeechIncompleteTimeout
  • Type: Integer
Cucpin
  • Field Name: cucpin
  • Type: Object
Credential Policy URI
  • Field Name: cucpin.CredentialPolicyURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Locked A flag indicating whether access to the user account associated with this set of credentials is locked.
  • Field Name: cucpin.Locked
  • Type: Boolean
Time Hacked The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.
  • Field Name: cucpin.TimeHacked
  • Type: String
Time Changed The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.
  • Field Name: cucpin.TimeChanged
  • Type: String
URI
  • Field Name: cucpin.URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
User URI
  • Field Name: cucpin.UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%248JoSj93NnpKyeueU%24E7MAfEouzCHHdu/Zl5ObTaJK%2B0o2kc6MEdMtjN3Y8PSQPdgk9Dwsgz6AMnwR3yQv0M%2BAdS0ssQ2DX%2BBx86FNuc7n%2BY6joElNZOBf9vO2cnca8FnLOQnKpeMicf0nexSH1QYFSnX/blPpJxPM/LaGul2S/7rzrNl6p9kQNEIOJa8aU8vRVHOdLtKSRNB4DU/a2J%2BBecwQYl/nbmb8FZiFLkjrhA%2BrUfeqdxySuULeUK16U5MJbHPcC%2BcPjnzCcCJLss6V85QRwCQtqBz0fEAETP3R8jhhHHymkKtB1dMfdcUF5z0SxLty1RAE8Ecqx3/4unGbVtLLYcv3Qsem%24%3D%3D
  • Format: uri
  • Choices: []
Credential Type The type of credential such as password, PIN, Windows or Domino credential.
  • Field Name: cucpin.CredentialType
  • Type: Integer
  • Choices: ["Password", "PIN"]
Alias The unique text name for either a user, distribution list, or personal group.
  • Field Name: cucpin.Alias
  • Type: String
Hacked A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.
  • Field Name: cucpin.Hacked
  • Type: Boolean
PIN The PIN or password, for a user. The credentials are stored in an encrypted format.
  • Field Name: cucpin.Credentials
  • Type: String
  • Is Password: True
User Object Id * The unique identifier of the User object to which this credential belongs. - template parameter [1]
  • Field Name: cucpin.UserObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24I1zxUwOVQEbjrCYl%24d0452eSmQ1%2BHU6qDuOlAy955L1wFglqH2%2BTMq5Z3M0sTqT0PVXd7Cgy9%2BqF2Q2KRi0WXm/XSMzGgmx7qtBfOvz8pChcOva5RT0Rg8i8h6Ozjqq3QUNX/1p/yisUYMRjN4qoMuT8sUvWts1%2Bg826jwx0R7cl6tuBpay1EdTS%2BhFTf9Llj2V7/5TQvJQnOO3rysDWFdpKFWIwJlz9wnzbGdi0tZJ/esDZBp66XrnGmMaUBYO7e814fUDRlRNhqwPBu/DFRxquYCKQf8SbbkaT%2BbOLE9efllRtkt2Nu3cwn8k42XjLp2O3dJitvkF9ZOqQt7olIRqAXOe5PrTEGlK/eg2CzXuss9NIGVl8m1qba3bvao6r7y/NZTNJyDQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Time Last Hack The date and time of the last logon attempt with an invalid user credential.
  • Field Name: cucpin.TimeLastHack
  • Type: String
Time Lockout The date and time that the credential was locked by an administrator.
  • Field Name: cucpin.TimeLockout
  • Type: String
Doesnt Expire A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = "1"), the user still may change the credential (if allowed by CantChange).
  • Field Name: cucpin.DoesntExpire
  • Type: Boolean
Object Id Surrogate key to support IMS
  • Field Name: cucpin.ObjectId
  • Type: String
Cant Change A flag indicating whether the user can set this credential.
  • Field Name: cucpin.CantChange
  • Type: Boolean
Credential Policy Object Id The unique identifier of the CredentialPolicy object that is associated with this credential.
  • Field Name: cucpin.CredentialPolicyObjectId
  • Type: String
Hack Count The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid.
  • Field Name: cucpin.HackCount
  • Type: Integer
Is Primary A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.
  • Field Name: cucpin.IsPrimary
  • Type: Boolean
Cred Must Change A flag indicating whether the user must change their credentials (PIN or password) at the next login.
  • Field Name: cucpin.CredMustChange
  • Type: Boolean