Alias
|
String(64)
|
Read/Write
|
A unique text name for addressable objects:
Global Users, Contacts, DistributionLists, and PersonalGroups.
|
Display Name
|
String(64)
|
Read/Write
|
Enter a descriptive name for the user
template.
|
ObjectId
|
String(36)
|
Read-Only
|
Specifies a globally unique,
system-generated identifier for a UserSubscriber object.
|
TenantObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the tenant to
which the user template belongs. This field is reflected in the response only
if the user template belongs to a particular tenant.
|
UseDefaultLanguage
|
Boolean
|
Read/Write
|
Possible values can be:
- False: The
language is the default language defined for the user template.
- True: The
language is derived from the location to which this user template belongs.
Default value: False
|
UseDefaultTimeZone
|
Boolean
|
Read/Write
|
Possible values can be:
- False: The time
zone is the default time zone defined for the user template.
- True: The time
zone is derived from the location to which this user template belongs.
Default value: False
|
City
|
String(64)
|
Read/Write
|
Enter the city. (optional)
|
State
|
String(64)
|
Read/Write
|
Enter the state. (optional)
|
Country
|
String(2)
|
Read/Write
|
Enter the country. (optional)
|
PostalCode
|
String(40)
|
Read/Write
|
Enter the Postal code (optional)
|
Department
|
String(64)
|
Read/Write
|
Enter the users department. (optional)
|
Manager
|
String(64)
|
Read/Write
|
Enter the name of the manager. (optional)
|
Address
|
String(64)
|
Read/Write
|
Enter the user address .(optional)
|
BillingId
|
String(32)
|
Read/Write
|
Billing ID can be used for
organization-specific information, such as accounting information, department
names, or project codes.
|
TimeZone
|
Integer
|
Read/Write
|
Select the desired time zone for the user,
or check the Use System Default Time Zone check box.
|
CreationTime
|
DateTime
|
Read-Only
|
The date and time the user template was
created.
|
CosObjectId
|
String(36)
|
Read/Write
|
The unique identifier of the COS (Class of
Service) object to which this user template account is associated.
|
Language
|
Integer
|
Read/Write
|
Select Use System Default Language or
select a language from the list
|
VoiceName
|
String
|
Read/Write
|
Wav file that contains recorded name.
|
LocationObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the LocationVMS
object to which this user belongs.
|
AddressMode
|
Integer
|
Default
|
The default method the subscriber will use
to address messages to other subscribers.
Possible options are:
- 0=LastNameFirst
- 1=Extension
- 2=FirstNameFirst
|
ClockMode
|
Integer
|
Read-Only
|
The time format used for the message
timestamps that the subscriber hears when they listen to their messages over
the phone.
Possible options are:
- 0=SystemDefaultClock
- 1=HourClock12
- 2=HourClock24
|
ConversationTUI
|
String(36)
|
Read-Only
|
The name of the conversation the subscriber
uses to set up, send, and retrieve messages.
|
GreetByName
|
Boolean
|
Read-Only
|
A flag indicating whether the subscriber
hears his/her name when they log into their mailbox over the phone.
Values can be:
- False: Do not
play the name.
- True: Play the
recorded voice name.
Default value: True
|
ListInDirectory
|
Boolean
|
Read/Write
|
A flag indicating whether system should
list the subscriber in the phone directory for outside callers.
Possible values can be:
- False: Do not
list the subscriber in the phone directory.
- True: List the
subscriber in the phone directory.
Default value: True
|
IsVmEnrolled
|
Boolean
|
Read/Write
|
A flag indicating whether system plays the
enrollment conversation (record a voice name, indicate if they are listed in
the directory, etc.) for the subscriber when they login.
Values can be:
- False: The
enrollment conversation is not played for the subscriber when they login.
- True: The
enrollment conversation is played for the subscriber when they login.
Default value: True
|
SayCopiedNames
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the "copied" names during message playback for a subscriber.
Values can be:
- False: Do not
announce copied names.
- True: Announce
copied names.
Default value: True
|
SayDistributionList
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the distribution list that sends a message, if applicable.
Values can be:
- False: Do not
announce the distribution list.
- True: Announce
the distribution list.
Default value: True
|
SayMsgNumber
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the position of each message in the stack (i.e., 'Message 1', 'Message 2'
,etc.) during message playback for the subscriber.
Values can be:
- False: Do not
play the message number.
- True: Play the
message number.
Default value: True
|
SaySender
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the sender of a message during message playback for the subscriber.
Values can be:
- False: Do not
announce the sender.
- True: Announce
the sender.
Default value: True
|
SayTimeStampAfter
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the timestamp after it plays back each message for the subscriber.
Values can be:
- False: Do not
announce the timestamp after each message is played.
- True: Announce
the timestamp after each message is played.
Default value: True
|
SayTimeStampBefore
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the timestamp before it plays back each for the subscriber.
Values can be:
- False: Do not
announce the timestamp before each message is played.
- True Announce
the timestamp before each message is played.
Default value: False
|
SayTotalNew
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of new messages in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of new messages.
- True: Announce
the total number of new messages in the subscriber mailbox.
Default value: False
|
SayTotalNewEmail
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of new e-mail messages in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of new e-mail messages.
- True: Announce
the total number of new e-mail messages in the subscriber mailbox.
Default value: False
|
SayTotalNewFax
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of new fax messages in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of new fax messages.
- True: Announce
the total number of new fax messages in the subscriber mailbox.
Default value: False
|
SayTotalNewVoice
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of new voice messages in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of new voice messages.
- True: Announce
the total number of new voice messages in the subscriber mailbox.
Default value: True
|
SayTotalReceipts
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of new receipts in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of new receipts.
- True: Announce
the total number of new receipts in the subscriber mailbox.
Default value: False
|
SayTotalSaved
|
Boolean
|
Read/Write
|
A flag indicating whether system announces
the total number of saved messages in the subscriber mailbox.
Values can be:
- False: Do not
announce total number of saved messages.
- True: Announce
the total number of saved messages in the subscriber mailbox.
Default value: True
|
Speed
|
Integer
|
Read/Write
|
The audio speed system uses to play back
messages to the subscriber. Range: 0-200.
|
MediaSwitchObjectId
|
String(36)
|
Read-Only
|
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 dual switch integration.
|
Undeletable
|
Boolean
|
Read/Write
|
Tells whether it can be deleted by
administrator or not.
|
UseBriefPrompts
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
hears brief or full phone menus when accessing system over the phone.
Default value: False
|
Volume
|
Integer
|
Read/Write
|
The audio volume expressed as a percentage
that Cisco Unity Connection uses to play back message. Range: 0-100
|
EnAltGreetDontRingPhone
|
Boolean
|
Read-Only
|
A flag indicating whether a caller is
prevented from being transferred to the subscriber phone when the subscriber
alternate greeting is turned on.
Values can be:
- False: Ring the
phone.
- True: Send the
caller to the alternate greeting.
Default value: False
|
EnAltGreetPreventSkip
|
Boolean
|
Read-Only
|
A flag indicating whether callers can skip
the greeting while it is playing when the alternate greeting is turned on.
Values can be:
- False: If
alternate greeting is active, callers cannot skip the greeting\
- True: If
alternate greeting is active, callers can skip the greeting.
Default value: False
|
EnAltGreetPreventMsg
|
Boolean
|
Read-Only
|
A flag indicating whether callers can leave
a message after the greeting when the subscriber alternate greeting is turned
on.
Values can be:
- False: If
alternate greeting is active, callers can leave a message for the subscriber
- True: If
alternate greeting is active, callers cannot leave a message for the
subscriber.
Default value: False
|
EncryptPrivateMessages
|
Boolean
|
Read-Only
|
A flag indicating whether system encrypts
messages from the subscriber that are marked private.
Values can be:
- False: Do not
encrypt private messages.
- True: Encrypt
private messages.
Default value: False
|
DeletedMessageSortOrder
|
Integer
|
Read-Only
|
The order in which system presents deleted
messages to the subscriber.
|
SayAltGreetWarning
|
Boolean
|
Read-Only
|
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.
Values can be:
- False: Do not
notify the subscriber that their alternate greeting is turned on.
- True: Notify the
subscriber when they login if their alternate greeting is turned on.
Default value: False
|
SaySenderExtension
|
Boolean
|
Read-Only
|
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.
Values can be:
- False: Do not
play the extension information of the subscriber who sent the message.
- True: After
playing the sender's voice name, play the primary extension information of the
subscriber who sent the message.
Default value: False
|
SayAni
|
Boolean
|
Read-Only
|
A flag indicating whether Cisco Unity
Connection plays the Automatic Number Identification (ANI) information during
message playback for voice messages from unidentified callers.
Default value: False
|
ExitCallActionObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the CallAction
object that is taken when a caller exits the subscriber conversation by
pressing the * key or timing out.
|
CallAnswerTimeout
|
Integer
|
Read/Write
|
The number of rings to wait for a
subscriber destination to answer before the call is forwarded to the
subscriber's primary phone.
|
CallHandlerObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the primary
CallHandler object for the subscriber.
|
DisplayNameRule
|
Integer
|
Read/Write
|
The format for generating the user display
name.
|
DoesntExpire
|
Boolean
|
Read/Write
|
A flag indicating whether or not the user
credential will automatically expire (and the user required to change the
credential upon its expiration) based on a defined schedule. Regardless, the
user still may change the credential (if allowed by CantChange).
Values can be:
- False: The user
credential will automatically expire. The expiration of the credential is
controlled by the value of the column tbl_CredentialPolicy->MaxDays.
- True: The user
credential will not automatically expire.
Default value: False
|
CantChange
|
Boolean
|
Read-Only
|
A flag indicating whether the user can
set/change their credential (i.e., the credential specified by the associated
credential policy).
Values can be:
- False: User is
allowed to change their credential.
- True: User
cannot change their credential.
Default value: False
|
MailboxStoreObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the MailboxStore
object where a mailbox is created for a new subscriber created with this
template.
|
SavedMessageStackOrder
|
String(36)
|
Read/Write
|
The order in which system 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
|
NewMessageStackOrder
|
String(36)
|
Read/Write
|
The order in which system plays the
following types 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
|
MessageLocatorSortOrder
|
Integer
|
Read/Write
|
The order in which system will sort
messages when the "Message Locator" feature is enabled.
|
SavedMessageSortOrder
|
Integer
|
Read/Write
|
The order in which system will sort saved
messages.
|
NewMessageSortOrder
|
Integer
|
Read/Write
|
The order in which system will sort new
messages.
|
MessageTypeMenu
|
Boolean
|
Read/Write
|
A flag indicating whether system plays the
message type menu when the subscriber logs on to system over the phone.
Values can be:
- False: Do not
play message type menu.
- True: Play
message type menu.
Default value: False
|
EnablePersonalRules
|
Boolena
|
Read/Write
|
A flag indicating whether a subscriber's
personal rules are enabled. Subscribers can use this setting to disable all
personal rules at once.
Values can be:
- False: Call
routing rules disabled for subscriber.
- 1: Call routing
rules enabled for subscriber.
- True: Call
routing rules enabled for subscriber.
Default value: True
|
ForcedAuthorizationCode
|
String(36)
|
Read-Only
|
A valid authorization code that is entered
prior to extending calls to classes of dialed numbers, for example, external,
toll and international calls.
|
RecordUnknownCallerName
|
Boolean
|
Read/Write
|
A flag indicating whether a caller should
be promoted to record his/her name if Unity does not receive caller id.
Default value: True
|
RingPrimaryPhoneFirst
|
Boolean
|
Read/Write
|
A flag indicating whether a subscriber's
primary phone should be rung before trying other destinations in a personal
group.
Default value: False
|
PromptSpeed
|
Integer
|
Read/Write
|
The audio speed system uses to play back
prompts to the subscriber.
|
ExitAction
|
Integer
|
Read/Write
|
Type of call action to take, e.g., hang-up,
go to another object, etc.
|
ExitTargetConversation
|
String(64)
|
Read/Write
|
The name of the conversation to which the
caller is routed.
|
ExitTargetHandlerObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the specific
object to send along to the target conversation.
|
RepeatMenu
|
Integer
|
Read/Write
|
The number of times to repeat a menu in
TUI. Possible range 0-250
|
FirstDigitTimeout
|
Integer
|
Read/Write
|
The amount of time to wait (in
milliseconds) for first digits when collecting touch tones. Range: 500-10000.
|
InterdigitDelay
|
Integer
|
Read-Only
|
The amount of time to wait (in
milliseconds) for input between touch tones when collecting digits in TUI.
Range: 1000-10000
|
PromptVolume
|
Integer
|
Read/Write
|
The volume level for playback of system
prompts. Range: 0-100.
|
DelayAfterGreeting
|
Integer
|
Read/Write
|
The amount of time (in milliseconds) Cisco
Unity Connection will delay after playing greeting. Range: 0-50000.
|
ClientMatterCode
|
String(40)
|
Read-Only
|
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 assign 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.
|
AddressAfterRecord
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
will be prompted to address message before or after it is recorded.
Values can be:
- False: Prompt
subscriber to address message before recording.
- True: Prompt
subscriber to address message after recording.
Default value: False
|
ConfirmDeleteMessage
|
Boolean
|
Read/Write
|
A flag indicating whether system will
request confirmation from a subscriber before proceeding with a deletion of a
single new or saved message.
Values can be:
- False: system
will not request confirmation from a subscriber before proceeding with a
deletion of a single new or saved message.
- True: system
will request confirmation from a subscriber before proceeding with a deletion
of a single new or saved message.
Default value: False
|
ConfirmDeleteMultipleMessage
|
Boolean
|
Read/Write
|
A flag indicating whether system allows the
subscriber to choose which message they want to delete or whether system
permanently deletes the specified type of messages. A change what system does
when subscribers press 3 > 2 > 2 from the Main menu to permanently delete
multiple deleted messages at once.
Values can be:
- False: System
does not prompt the subscriber to choose, and instead permanently deletes the
type of messages you specify: either deleted voice messages or all deleted
messages (voice, fax, and e-mail, as applicable).
- True: System
allows the subscriber to choose which messages they want to delete; subscriber
can either delete their deleted voice messages or delete all of their deleted
messages.
Default value: True
|
PabLastImported
|
String(36)
|
Read-Only
|
The date and time when the personal address
book was last imported from a groupware package into the personal groups for a
user.
|
IsClockMode24Hour
|
Boolean
|
Read/Write
|
The time format used for the message
timestamps that the subscriber hears when they listen to their messages over
the phone.
Values can be:
- False: 12-Hour
clock - The subscriber hears message timestamps in the time format of a 12-hour
clock. For example, a subscriber will hear 1:00 PM when listening to the
timestamp of a message left at 1:00 PM.
- True: 24-Hour
clock - The subscriber hears message timestamps in the time format of a 24-hour
clock. For example, a subscriber will hear 13:00 when listening to the
timestamp of a message left at 1:00 PM.
Default value: False
|
RouteNDRToSender
|
Boolean
|
Read/Write
|
For an undeliverable message, whether NDR
messages will appear in the subscriber mailbox or are deleted by the system.
|
NotificationType
|
Integer
|
Read/Write
|
The notification type to use for this
mailbox created.
|
SendReadReceipts
|
Integer
|
Read/Write
|
A flag indicating whether the mailbox
created with this subscriber allows the system to send read receipts on its
behalf.
Values can be:
|
SendQuota
|
Integer
|
Read/Write
|
The mailbox size (in bytes) send limit.
(2048 MB)
Values can be:
- 1: The quota is
unlimited.
- 2: The default
system quota is assigned.
|
WarningQuota
|
Integer
|
Read/Write
|
The mailbox size (in bytes) warning limit.
(2048 MB)
Values can be:
- 1: The quota is
unlimited.
- 2: The default
system quota is assigned.
|
ReceiveQuota
|
Integer
|
Read/Write
|
The mailbox size (in bytes) receive limit.
(2048 MB)
Values can be:
- 1: The quota is
unlimited.
- 2: The default
system quota is assigned.
|
MailboxDn
|
String(36)
|
Read-Only
|
The distinguished name of the mailbox.
|
SynchScheduleObjectId
|
String(36)
|
Read-Only
|
The unique identifiers of the Schedule
object to use for synchronization Calendar information from groupware (such as
Exchange).
|
IsSetForVmEnrollment
|
Boolean
|
Read-Only
|
Temporary placeholder until IsVmEnrolled
can be phased out.
|
SendBroadcastMsg
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
may send broadcast messages.
Values can be:
- False: Cannot
send broadcast messages.
- True: Can send
broadcast messages.
Default value: False
|
UpdateBroadcastMsg
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
has the ability to update broadcast messages that are active or will be active
in the future.
Values can be:
- False: Cannot
update broadcast messages.
- True: Can update
broadcast messages.
Default value: False
|
ConversationVUI
|
Boolean
|
Read/Write
|
The VUI conversation assigned to the
subscriber.
|
SpeechCompleteTimeout
|
Integer
|
Read-Only
|
Specifies the required length of silence
(in milliseconds) following user speech before the recognizer finalizes a
result.
|
SpeechIncompleteTimeout
|
Integer
|
Read-Only
|
Specifies the required length of silence
(in milliseconds) from when the speech prior to the silence matches an active
grammar.
|
UseVui
|
Boolean
|
Read/Write
|
A flag indicating whether the speech
recognition conversation is the default conversation for the subscriber.
Values can be:
- False: Speech
recognition conversation is not default conversation for the subscriber.
- True: Speech
recognition conversation is the default conversation for the subscriber.
Default value: False
|
SkipPasswordForKnownDevice
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
will be asked for his/her PIN when attempting to sign-in from a known device.
Default value: False
|
JumpToMessagesOnLogin
|
Boolean
|
Read/Write
|
A flag indicating whether the subscriber
conversation jumps directly to the first message in the message stack after
subscriber sign-in.
Values can be:
- False:
Subscriber conversation does not jump directly to first message in the message
stack after subscriber sign-in.
- True: Subscriber
conversation jumps directly to the first message in the message stack after
subscriber sign-in.
Default value: True
|
EnableMessageLocator
|
Boolean
|
Read/Write
|
A flag indicating whether the message
locator feature is enabled for the subscriber.
Values can be:
- False: Message
locator feature is disabled for subscriber.
- True: Message
locator feature is enabled for subscriber.
Default value: False
|
MessageAgingPolicyObjectId
|
String(36)
|
Read-Only
|
The unique identifier of the
MessageAgingPolicy object that applies to the mailbox created for a new
subscriber created with this template.
|
AssistantRowsPerPage
|
Integer
|
Read-Only
|
This controls the number of entries to
|