GET http://[host-proxy]/api/relation/Voicemail/schema/?hierarchy=[hierarchy]&format=json&schema=1
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"ExitTargetHandlerObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the specific object to send along to the target conversation.",
"format": "uri",
"minItems": 0,
"title": "Exit Target Handler",
"name": "ExitTargetHandlerObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Title": {
"minItems": 0,
"title": "Title",
"type": "string",
"description": " The position or function of a user within an organization, such as 'Vice President.'",
"name": "Title"
},
"AddressMode": {
"minItems": 0,
"title": "Address Mode",
"type": "integer",
"description": " The default method the subscriber will use to address messages to other subscribers.",
"name": "AddressMode"
},
"RingPrimaryPhoneFirst": {
"minItems": 0,
"title": "Ring Primary Phone First",
"type": "boolean",
"description": " A flag indicating whether a subscriber's primary phone should be rung before trying other destinations in a personal group.",
"name": "RingPrimaryPhoneFirst"
},
"CommandDigitTimeout": {
"minItems": 0,
"title": "Command Digit Timeout",
"type": "integer",
"description": " 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).",
"name": "CommandDigitTimeout"
},
"VoiceName": {
"minItems": 0,
"title": "Voice Name",
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName"
},
"SayTimestampAfter": {
"minItems": 0,
"title": "Say Timestamp After",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the timestamp after it plays back each message for the subscriber.",
"name": "SayTimestampAfter"
},
"Department": {
"minItems": 0,
"title": "Department",
"type": "string",
"description": " The name or number for the department or subdivision of an organization to which a person belongs.",
"name": "Department"
},
"GreetByName": {
"minItems": 0,
"title": "Greet By Name",
"type": "boolean",
"description": " A flag indicating whether the subscriber hears his/her name when they log into their mailbox over the phone.",
"name": "GreetByName"
},
"cucsmtp": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " 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. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"StaticText": {
"minItems": 0,
"title": "Static Text",
"type": "string",
"description": " The actual text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Send:\" field.\n",
"name": "StaticText"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SendCount": {
"minItems": 0,
"title": "Send Count",
"type": "boolean",
"description": " 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. ",
"name": "SendCount"
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"UrgentOnly": {
"title": "Urgent Only",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends voice message transcripted in urgent mode or not",
"name": "UrgentOnly"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"HeaderText": {
"minItems": 0,
"title": "Header Text",
"type": "string",
"description": " 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.",
"name": "HeaderText"
},
"FooterText": {
"minItems": 0,
"title": "Footer Text",
"type": "string",
"description": " 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.",
"name": "FooterText"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"SmtpAddress": {
"minItems": 0,
"title": "Smtp Address",
"type": [
"string",
"null"
],
"description": " 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.",
"name": "SmtpAddress"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMTP object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"SendCallerId": {
"minItems": 0,
"title": "Send Caller Id",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PhoneNumber": {
"minItems": 0,
"title": "Phone Number",
"type": "string",
"description": " 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. ",
"name": "PhoneNumber"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"VoiceMessage": {
"title": "Voice Message",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends transcription of voice message",
"name": "VoiceMessage"
},
"SendPcaLink": {
"minItems": 0,
"title": "Send Pca Link",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message. ",
"name": "SendPcaLink"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
}
}
},
"type": "array",
"title": "Cucsmtp"
},
"cucphone": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " 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. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"AfterDialDigits": {
"minItems": 0,
"title": "After Dial Digits",
"type": "string",
"description": " The extra digits (if any) that Cisco Unity Connection will dial after the phone number.",
"name": "AfterDialDigits"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"BusyRetryInterval": {
"minItems": 0,
"title": "Busy Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.",
"name": "BusyRetryInterval"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"RnaRetryInterval": {
"minItems": 0,
"title": "Rna Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.",
"name": "RnaRetryInterval"
},
"RetriesOnBusy": {
"minItems": 0,
"title": "Retries On Busy",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.",
"name": "RetriesOnBusy"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceConversation object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"DetectTransferLoop": {
"minItems": 0,
"title": "Detect Transfer Loop",
"type": "boolean",
"description": " A flag indicating whether Unity can do a loop detect transfer to this device.",
"name": "DetectTransferLoop"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialDelay": {
"minItems": 0,
"title": "Dial Delay",
"type": "integer",
"description": " 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.\n",
"name": "DialDelay"
},
"Conversation": {
"description": " 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.",
"title": "Conversation",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "Conversation"
},
"PromptForId": {
"minItems": 0,
"title": "Prompt For Id",
"type": "boolean",
"description": " A flag indicating whether to prompt a subscriber for their Cisco Unity Connection ID, or just their password.",
"name": "PromptForId"
},
"PhoneNumber": {
"minItems": 0,
"title": "Phone Number",
"type": [
"string",
"null"
],
"description": " The phone number to dial, including the trunk access code (if any), of the device.",
"name": "PhoneNumber"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Notification device is undeletable.",
"name": "Undeletable"
},
"RingsToWait": {
"minItems": 0,
"title": "Rings To Wait",
"type": "integer",
"description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.",
"name": "RingsToWait"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"WaitConnect": {
"minItems": 0,
"title": "Wait Connect",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits. \n",
"name": "WaitConnect"
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"RetriesOnRna": {
"minItems": 0,
"title": "Retries On Rna",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.",
"name": "RetriesOnRna"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
},
"MediaSwitchObjectId": {
"description": " The unique identifier of the MediaSwitch object to use for notification. ",
"format": "uri",
"minItems": 0,
"required": true,
"name": "MediaSwitchObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/PhoneSystem",
"title": "Media Switch Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"title": "Transmit Forced Authorization Code",
"type": "boolean",
"description": " A flag indicating whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.",
"name": "TransmitForcedAuthorizationCode"
}
}
},
"type": "array",
"title": "Cucphone"
},
"Address": {
"minItems": 0,
"title": "Address",
"type": "string",
"description": " The physical address such as a house number and street name where the user is located, or with which a user is associated.",
"name": "Address"
},
"RetainUrgentMessageFlag": {
"minItems": 0,
"title": "Retain Urgent Message Flag",
"type": "boolean",
"description": " 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.\n",
"name": "RetainUrgentMessageFlag"
},
"DtmfNameLastFirst": {
"minItems": 0,
"title": "Dtmf Name Last First",
"type": "string",
"description": " 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.",
"name": "DtmfNameLastFirst"
},
"SpeechSensitivity": {
"minItems": 0,
"title": "Speech Sensitivity",
"type": "integer",
"description": " 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.",
"name": "SpeechSensitivity"
},
"cucuma": {
"items": {
"type": "object",
"properties": {
"UserProfileNumber": {
"minItems": 0,
"title": "User Profile Number",
"type": "string",
"description": " Number that identifies a MeetingPlace Express 2.x user profile. Used to authenticate to Cisco Unified MeetingPlace Express from a touch-tone phone.",
"name": "UserProfileNumber"
},
"EnableTtsOfEmailCapability": {
"minItems": 0,
"title": "Enable Tts Of Email Capability",
"type": "boolean",
"description": " 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. ",
"name": "EnableTtsOfEmailCapability"
},
"EnableMailboxSynchCapability": {
"minItems": 0,
"title": "Enable Mailbox Synch Capability",
"type": "boolean",
"description": " A flag indicating whether synchronization of mailbox contents between Connection and an external/third-party mail system is enabled.",
"name": "EnableMailboxSynchCapability"
},
"IsPrimaryMeetingService": {
"minItems": 0,
"title": "Is Primary Meeting Service",
"type": "boolean",
"description": " 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.",
"name": "IsPrimaryMeetingService"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier\nfor an subscriber external service map object.\n - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"UserPassword": {
"minItems": 0,
"title": "User Password",
"type": "string",
"description": " The user password for logon to the external service.",
"name": "UserPassword"
},
"ExternalServiceObjectId": {
"target_title": "DisplayName",
"description": "The Unified Messaging Service associated with this Unified Messaging Account",
"format": "uri",
"minItems": 0,
"title": "Unified Messaging Service",
"name": "ExternalServiceObjectId",
"target_attr": "ObjectId",
"readonly": false,
"target_model_type": "device/cuc/ExternalService",
"choices": [],
"type": "string",
"target": "/api/device/cuc/ExternalService/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserId": {
"minItems": 0,
"title": "User Id",
"type": "string",
"description": " The unique text name (e.g., logon name) used by the User to logon to the service.\n",
"name": "UserId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnableCalendarCapability": {
"minItems": 0,
"title": "Enable Calendar Capability",
"type": "boolean",
"description": " 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. ",
"name": "EnableCalendarCapability"
},
"EmailAddress": {
"minItems": 0,
"title": "Email Address",
"type": "string",
"description": " 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.",
"name": "EmailAddress"
},
"EnableMeetingCapability": {
"minItems": 0,
"title": "Enable Meeting Capability",
"type": "boolean",
"description": " 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.",
"name": "EnableMeetingCapability"
},
"EmailAddressUseCorp": {
"minItems": 0,
"title": "Email Address Use Corp",
"type": "boolean",
"description": " Flag indicating whether to use the EmailAddress specified in this row or the corporate e-mail address specified on the owning User.",
"name": "EmailAddressUseCorp"
},
"UserExternalServiceResetURI": {
"title": "User External Service Reset URI",
"type": "string",
"description": "The URI to reset external service.",
"name": "UserExternalServiceResetURI"
},
"LoginType": {
"description": " Type of login to use",
"title": "Sign-In Type",
"minItems": 0,
"choices": [
[
0,
"Use Connection Alias"
],
[
2,
"Use User ID Provided Below"
]
],
"type": "integer",
"name": "LoginType"
},
"SubscriberObjectId": {
"description": " A foreign key to a Subscriber. The unique identifier of the subscriber object that is associated with the external service. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"maxItems": 1,
"title": "Cucuma"
},
"CcmId": {
"minItems": 0,
"title": "Ccm Id",
"type": "string",
"description": " Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager",
"name": "CcmId"
},
"LdapType": {
"description": " The LDAP configuration information for the user.",
"title": "Ldap Type",
"minItems": 0,
"choices": [
[
0,
"Do not Integrate with LDAP directory"
],
[
1,
"Integrate with LDAP directory"
],
[
2,
"Authenticate"
],
[
3,
"Integrate and Authenticate with LDAP directory"
],
[
4,
"Inactive"
]
],
"type": "integer",
"name": "LdapType"
},
"ExternalServiceAccountsURI": {
"name": "ExternalServiceAccountsURI",
"title": "External Service Accounts URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SaveMessageOnHangup": {
"minItems": 0,
"title": "Save Message On Hangup",
"type": "boolean",
"description": " A flag indicating when hanging up while listening to a new message, whether the message is marked new again or is marked read.",
"name": "SaveMessageOnHangup"
},
"EnableVisualMessageLocator": {
"minItems": 0,
"title": "Enable Visual Message Locator",
"type": "boolean",
"description": " 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.",
"name": "EnableVisualMessageLocator"
},
"RepeatMenu": {
"minItems": 0,
"title": "Repeat Menu",
"type": "integer",
"description": " The number of times to repeat a menu in TUI.",
"name": "RepeatMenu"
},
"Building": {
"minItems": 0,
"title": "Building",
"type": "string",
"description": " The name of the building where the user is based (e.g., SJ-21).",
"name": "Building"
},
"UserMailboxURI": {
"readonly": true,
"title": "User Mailbox URI",
"type": "string",
"description": "The URI to change the mailbox settings.",
"name": "UserMailboxURI"
},
"ConversationVui": {
"minItems": 0,
"title": "Conversation Vui",
"type": "string",
"description": " The VUI conversation assigned to the subscriber.",
"name": "ConversationVui"
},
"EmployeeId": {
"minItems": 0,
"title": "Employee Id",
"type": "string",
"description": " The numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.",
"name": "EmployeeId"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a User object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"CreationTime": {
"description": " The date and time the user account was created. ",
"title": "Creation Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CreationTime"
},
"JumpToMessagesOnLogin": {
"minItems": 0,
"title": "Jump To Messages On Login",
"type": "boolean",
"description": " A flag indicating whether the subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.",
"name": "JumpToMessagesOnLogin"
},
"SaySender": {
"minItems": 0,
"title": "Say Sender",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the sender of a message during message playback for the subscriber.",
"name": "SaySender"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"cucpass": {
"type": "object",
"properties": {
"CredentialPolicyURI": {
"name": "CredentialPolicyURI",
"title": "Credential Policy URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DoesntExpire": {
"minItems": 0,
"title": "Doesnt Expire",
"type": "boolean",
"description": " 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). ",
"name": "DoesntExpire"
},
"Locked": {
"minItems": 0,
"title": "Locked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked.",
"name": "Locked"
},
"TimeHacked": {
"minItems": 0,
"title": "Time Hacked",
"type": "string",
"description": " 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.",
"name": "TimeHacked"
},
"TimeChanged": {
"minItems": 0,
"title": "Time Changed",
"type": "string",
"description": " 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.",
"name": "TimeChanged"
},
"CantChange": {
"minItems": 0,
"title": "Cant Change",
"type": "boolean",
"description": " A flag indicating whether the user can set this credential.",
"name": "CantChange"
},
"IsPrimary": {
"minItems": 0,
"title": "Is Primary",
"type": "boolean",
"description": " 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.",
"name": "IsPrimary"
},
"CredentialPolicyObjectId": {
"minItems": 0,
"title": "Credential Policy Object Id",
"type": "string",
"description": " The unique identifier of the CredentialPolicy object that is associated with this credential.",
"name": "CredentialPolicyObjectId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CredentialType": {
"description": " The type of credential such as password, PIN, Windows or Domino credential. ",
"title": "Credential Type",
"minItems": 0,
"choices": [
[
3,
"Password"
],
[
4,
"PIN"
]
],
"type": "integer",
"name": "CredentialType"
},
"Alias": {
"minItems": 0,
"title": "Alias",
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias"
},
"HackCount": {
"minItems": 0,
"title": "Hack Count",
"type": "integer",
"description": " 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. ",
"name": "HackCount"
},
"Hacked": {
"minItems": 0,
"title": "Hacked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.",
"name": "Hacked"
},
"ObjectId": {
"description": " Surrogate key to support IMS",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"Credentials": {
"is_password": true,
"description": " The PIN or password, for a user. The credentials are stored in an encrypted format.",
"title": "Password",
"minItems": 0,
"type": "string",
"name": "Credentials"
},
"UserObjectId": {
"description": " The unique identifier of the User object to which this credential belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "UserObjectId",
"target_attr": "ObjectId",
"readonly": true,
"target_model_type": "device/cuc/User",
"title": "User Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeLastHack": {
"minItems": 0,
"title": "Time Last Hack",
"type": "string",
"description": " The date and time of the last logon attempt with an invalid user credential.",
"name": "TimeLastHack"
},
"CredMustChange": {
"minItems": 0,
"title": "Cred Must Change",
"type": "boolean",
"description": " A flag indicating whether the user must change their credentials (PIN or password) at the next login.",
"name": "CredMustChange"
},
"TimeLockout": {
"minItems": 0,
"title": "Time Lockout",
"type": "string",
"description": " The date and time that the credential was locked by an administrator.",
"name": "TimeLockout"
}
},
"title": "Cucpass"
},
"MessageLocatorSortOrder": {
"minItems": 0,
"title": "Message Locator Sort Order",
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort messages when the \"Message Locator\" feature is enabled.",
"name": "MessageLocatorSortOrder"
},
"cucalt": {
"items": {
"type": "object",
"properties": {
"PartitionObjectId": {
"target_attr": "ObjectId",
"description": "The name of the associated partition",
"format": "uri",
"minItems": 0,
"title": "Partition Name",
"name": "PartitionObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/Partition",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PartitionURI": {
"name": "PartitionURI",
"title": "Partition URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DtmfAccessId object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"IdIndex": {
"description": " An index into the alternate extensions for a subscriber.",
"title": "Phone Type",
"minItems": 0,
"required": true,
"choices": [
[
1,
"Work Phone"
],
[
2,
"Work Phone 2"
],
[
3,
"Home Phone"
],
[
4,
"Home Phone 2"
],
[
5,
"Mobile Phone"
],
[
6,
"Mobile Phone 2"
],
[
7,
"Work Fax"
],
[
8,
"Work Fax 2"
],
[
9,
"Home Fax"
],
[
38,
"Directory URI"
]
],
"type": "integer",
"name": "IdIndex"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AlternateExtensionAdvancedURI": {
"title": "Alternate Extension Advanced URI",
"type": "string",
"description": "The URI to get the advanced setting of the alternate extension.",
"name": "AlternateExtensionAdvancedURI"
},
"DtmfAccessId": {
"description": " The dialable number.",
"title": "Dtmf Access Id",
"minItems": 0,
"required": true,
"type": "string",
"name": "DtmfAccessId"
},
"LocationObjectId": {
"minItems": 0,
"title": "Location Object Id",
"type": "string",
"description": " The unique identifier of the Location object to which this location (denormalized) belongs.",
"name": "LocationObjectId"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": " The text name of this DtmfAccessId to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName"
},
"UserObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "User Object Id",
"type": [
"string"
],
"name": "UserObjectId"
},
"LocationURI": {
"name": "LocationURI",
"title": "Location URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"title": "Cucalt"
},
"MailboxDn": {
"minItems": 0,
"title": "Mailbox Dn",
"type": "string",
"description": " The distinguished name of the mailbox.",
"name": "MailboxDn"
},
"PhoneNumber": {
"description": " A phone number.",
"title": "Phone Number",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "PhoneNumber"
},
"CcmIdType": {
"minItems": 0,
"title": "Ccm Id Type",
"type": "integer",
"description": " Type of CCM user/object this id refers to (end user, application user, or directory number)",
"name": "CcmIdType"
},
"SynchScheduleURI": {
"name": "SynchScheduleURI",
"title": "Synch Schedule URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ClientMatterCode": {
"minItems": 0,
"title": "Client Matter Code",
"type": "string",
"description": " 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.",
"name": "ClientMatterCode"
},
"ConfirmDeleteDeletedMessage": {
"minItems": 0,
"title": "Confirm Delete Deleted Message",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single deleted message.",
"name": "ConfirmDeleteDeletedMessage"
},
"MessageTypeMenu": {
"minItems": 0,
"title": "Message Type Menu",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays the message type menu when the subscriber logs on to Cisco Unity Connection over the phone. ",
"name": "MessageTypeMenu"
},
"EnableSaveDraft": {
"minItems": 0,
"title": "Enable Save Draft",
"type": "boolean",
"description": " A flag indicating whether the save draft message feature is enabled for the subscriber.",
"name": "EnableSaveDraft"
},
"AlternateNamesURI": {
"readonly": true,
"title": "Alternate Names URI",
"type": "string",
"description": "The URI to get the alternate names of the user.",
"name": "AlternateNamesURI"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"title": "Voice File URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Initials": {
"minItems": 0,
"title": "Initials",
"type": "string",
"description": " The initial letters of some or all of the names of this user.",
"name": "Initials"
},
"AltFirstName": {
"minItems": 0,
"title": "Alt First Name",
"type": "string",
"description": " 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.",
"name": "AltFirstName"
},
"ExitCallActionObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out.",
"format": "uri",
"minItems": 0,
"title": "Exit Call Action",
"name": "ExitCallActionObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayMsgNumber": {
"minItems": 0,
"title": "Say Msg Number",
"type": "boolean",
"description": " 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.",
"name": "SayMsgNumber"
},
"SayTotalNewVoice": {
"minItems": 0,
"title": "Say Total New Voice",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new voice messages in the subscriber mailbox.",
"name": "SayTotalNewVoice"
},
"ReadOnly": {
"description": " If set to 1 (true) user is read-only and cannot be modified.",
"title": "Read Only",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "ReadOnly"
},
"cucmsghandler": {
"type": "object",
"properties": {
"ObjectId": {
"description": " The primary key for this table. A globally unique system-generated identifier for a MessageHandler object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this message handler belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EmailAction": {
"description": " The action to take for email messages.",
"title": "Email",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "EmailAction"
},
"RelayAddress": {
"minItems": 0,
"title": "Relay Address",
"type": "string",
"description": " The SMTP address to which messages should be relayed.",
"name": "RelayAddress"
},
"FaxAction": {
"description": " The action to take for fax messages.",
"title": "Fax",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "FaxAction"
},
"VoicemailAction": {
"description": " The action to take for voicemail messages.",
"title": "Voicemail",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "VoicemailAction"
},
"DeliveryReceiptAction": {
"description": " The action to take for delivery receipt messages.",
"title": "Receipt",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "DeliveryReceiptAction"
}
},
"title": "Cucmsghandler"
},
"SaySenderExtension": {
"minItems": 0,
"title": "Say Sender Extension",
"type": "boolean",
"description": " 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.",
"name": "SaySenderExtension"
},
"SavedMessageStackOrder": {
"minItems": 0,
"title": "Saved Message Stack Order",
"type": "string",
"description": " The order in which Cisco Unity Connection plays the following types of \"saved\" messages:\n* Urgent voice messages\n* Non-urgent voice messages\n* Urgent fax messages\n* Non-urgent fax messages\n* Urgent e-mail messages\n* Non-urgent e-mail messages\n* Receipts and notices",
"name": "SavedMessageStackOrder"
},
"SaySenderExtensionAfter": {
"minItems": 0,
"title": "Say Sender Extension After",
"type": "boolean",
"description": " 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.",
"name": "SaySenderExtensionAfter"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": " 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.",
"name": "DisplayName"
},
"InboxAutoRefresh": {
"minItems": 0,
"title": "Inbox Auto Refresh",
"type": "integer",
"description": " The rate (in minutes) at which Unity Inbox performs a refresh.",
"name": "InboxAutoRefresh"
},
"UseDefaultTimeZone": {
"minItems": 0,
"title": "Use Default Time Zone",
"type": "boolean",
"description": "Indicates if the default timezone is being used.",
"name": "UseDefaultTimeZone"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"State": {
"minItems": 0,
"title": "State",
"type": "string",
"description": " The full name of the state or province where this user is located, or with which a user is associated.",
"name": "State"
},
"AltLastName": {
"minItems": 0,
"title": "Alt Last Name",
"type": "string",
"description": " 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.",
"name": "AltLastName"
},
"HF": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"cuc_language_caller_hears": {
"type": "string",
"title": "Language That Callers Hear"
}
},
"title": "Hf"
},
"AnnounceUpcomingMeetings": {
"minItems": 0,
"title": "Announce Upcoming Meetings",
"type": "integer",
"description": " The amount ahead of time, in minutes, that Connection will warn the subscriber of upcoming meetings when the subscriber calls into the system. ",
"name": "AnnounceUpcomingMeetings"
},
"MailboxStoreName": {
"readonly": true,
"title": "Mailbox Store Name",
"type": "string",
"description": "The Mailbox store name of user.",
"name": "MailboxStoreName"
},
"SayAni": {
"minItems": 0,
"title": "Say Ani",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays the Automatic Number Identification (ANI) information during message playback for voice messages from unidentified callers.",
"name": "SayAni"
},
"NewMessageSortOrder": {
"description": " The order in which Cisco Unity Connection will sort new messages.",
"title": "New Message Sort Order",
"minItems": 0,
"choices": [
[
1,
"Newest first"
],
[
2,
"Oldest first"
]
],
"type": "integer",
"name": "NewMessageSortOrder"
},
"TimeLastCall": {
"minItems": 0,
"title": "Time Last Call",
"type": "string",
"description": " The date and time when the subscriber last accessed their mailbox by phone (last time they were offered messages).",
"name": "TimeLastCall"
},
"DtmfNameLast": {
"minItems": 0,
"title": "Dtmf Name Last",
"type": "string",
"description": " 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.",
"name": "DtmfNameLast"
},
"FaxServerObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the FaxServer object for the subscriber.",
"format": "uri",
"minItems": 0,
"title": "Fax Server",
"name": "FaxServerObjectId",
"target_title": "FaxServerName",
"target_model_type": "device/cuc/FaxServer",
"choices": [],
"type": "string",
"target": "/api/device/cuc/FaxServer/choices/?choice_title=FaxServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LocationObjectId": {
"target_title": "DisplayName",
"description": "The name of the LocationVMS object to which this user belongs.",
"format": "uri",
"minItems": 0,
"title": "Location",
"name": "LocationObjectId",
"target_attr": "ObjectId",
"readonly": true,
"target_model_type": "device/cuc/Location",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TenantObjectId": {
"target_title": "Alias",
"description": "The name of the tenant to which the user belongs.",
"format": "uri",
"minItems": 0,
"title": "Tenant",
"name": "Tenant",
"target_attr": "ObjectId",
"readonly": true,
"target_model_type": "device/cuc/Tenant",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Tenant/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DtmfNameFirst": {
"minItems": 0,
"title": "Dtmf Name First",
"type": "string",
"description": " 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.",
"name": "DtmfNameFirst"
},
"PromptSpeed": {
"minItems": 0,
"title": "Prompt Speed",
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.",
"name": "PromptSpeed"
},
"EnAltGreetPreventSkip": {
"minItems": 0,
"title": "En Alt Greet Prevent Skip",
"type": "boolean",
"description": " A flag indicating whether callers can skip the greeting while it is playing when the alternate greeting is turned on.",
"name": "EnAltGreetPreventSkip"
},
"ContinuousAddMode": {
"minItems": 0,
"title": "Continuous Add Mode",
"type": "boolean",
"description": " 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.",
"name": "ContinuousAddMode"
},
"EnhancedSecurityAlias": {
"minItems": 0,
"title": "Enhanced Security Alias",
"type": "string",
"description": " The unique text name used to idenitify and authenticate the user with an RSA SecurID security system.",
"name": "EnhancedSecurityAlias"
},
"AssistantRowsPerPage": {
"minItems": 0,
"title": "Assistant Rows Per Page",
"type": "integer",
"description": " This controls the number of entries to display per page for all tables in the Unity Assistant, e.g. the Private List Members table.",
"name": "AssistantRowsPerPage"
},
"ConfirmDeleteMultipleMessages": {
"minItems": 0,
"title": "Confirm Delete Multiple Messages",
"type": "boolean",
"description": " 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.",
"name": "ConfirmDeleteMultipleMessages"
},
"InboxMessagesPerPage": {
"minItems": 0,
"title": "Inbox Messages Per Page",
"type": "integer",
"description": " The number of messages Unity Inbox displays in a page.",
"name": "InboxMessagesPerPage"
},
"EnableMessageBookmark": {
"minItems": 0,
"title": "Enable Message Bookmark",
"type": "boolean",
"description": " A flag indicating whether Message Bookmark is enabled for the subscriber",
"name": "EnableMessageBookmark"
},
"ConversationName": {
"minItems": 0,
"title": "Conversation Name",
"type": "string",
"description": " The name of the conversation the subscriber uses to set up, send, and retrieve messages.",
"name": "ConversationName"
},
"SayAltGreetWarning": {
"minItems": 0,
"title": "Say Alt Greet Warning",
"type": "boolean",
"description": " 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.",
"name": "SayAltGreetWarning"
},
"PabLastImported": {
"minItems": 0,
"title": "Pab Last Imported",
"type": "string",
"description": " The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.",
"name": "PabLastImported"
},
"PcaHomePage": {
"minItems": 0,
"title": "Pca Home Page",
"type": "string",
"description": " The Home Page is the first page that is displayed after logging in to the PCA. ",
"name": "PcaHomePage"
},
"UpdateBroadcastMsg": {
"minItems": 0,
"title": "Update Broadcast Msg",
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.",
"name": "UpdateBroadcastMsg"
},
"SayCopiedNames": {
"minItems": 0,
"title": "Say Copied Names",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the \"copied\" names during message playback for a subscriber. ",
"name": "SayCopiedNames"
},
"InboxAutoResolveMessageRecipients": {
"minItems": 0,
"title": "Inbox Auto Resolve Message Recipients",
"type": "boolean",
"description": " 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.",
"name": "InboxAutoResolveMessageRecipients"
},
"MwisURI": {
"name": "MwisURI",
"title": "Mwis URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserWebPasswordURI": {
"readonly": true,
"title": "User Web Password URI",
"type": "string",
"description": "The URI to change the web application password.",
"name": "UserWebPasswordURI"
},
"VideoServiceAccountsURI": {
"name": "VideoServiceAccountsURI",
"title": "Video Service Accounts URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SkipForwardTime": {
"minItems": 0,
"title": "Skip Forward Time",
"type": "integer",
"description": " 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.",
"name": "SkipForwardTime"
},
"SayMessageLengthAfter": {
"minItems": 0,
"title": "Say Message Length After",
"type": "boolean",
"description": " This flag works exactly the same as the SayMessageLength flag on a user, except the conversation plays the message length in the message footer.",
"name": "SayMessageLengthAfter"
},
"UseVui": {
"minItems": 0,
"title": "Use Vui",
"type": "boolean",
"description": " A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.",
"name": "UseVui"
},
"SpeechConfidenceThreshold": {
"minItems": 0,
"title": "Speech Confidence Threshold",
"type": "integer",
"description": " 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.",
"name": "SpeechConfidenceThreshold"
},
"FirstDigitTimeout": {
"minItems": 0,
"title": "First Digit Timeout",
"type": "integer",
"description": " The amount of time to wait (in milliseconds) for first digit when collecting touch tones.",
"name": "FirstDigitTimeout"
},
"AddressAfterRecord": {
"minItems": 0,
"title": "Address After Record",
"type": "boolean",
"description": " A flag indicating whether the subscriber will be prompted to address message before or after it is recorded.",
"name": "AddressAfterRecord"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"title": "Callhandler URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialablePhoneNumber": {
"minItems": 0,
"title": "Dialable Phone Number",
"type": "string",
"description": " A dialable version of the PhoneNumber column.",
"name": "DialablePhoneNumber"
},
"MediaSwitchObjectId": {
"target_attr": "ObjectId",
"description": "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.",
"format": "uri",
"minItems": 0,
"title": "Phone System",
"name": "MediaSwitchObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/PhoneSystem",
"choices": [],
"type": "string",
"target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ExitTargetConversation": {
"minItems": 0,
"title": "Exit Target Conversation",
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "ExitTargetConversation"
},
"SavedMessageSortOrder": {
"minItems": 0,
"title": "Saved Message Sort Order",
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort saved messages.",
"name": "SavedMessageSortOrder"
},
"PartitionURI": {
"name": "PartitionURI",
"title": "Partition URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"FirstName": {
"minItems": 0,
"title": "First Name",
"type": "string",
"description": " The first name (i.e., givenName) of this user. Not their surname nor middle name.",
"name": "FirstName"
},
"UseBriefPrompts": {
"minItems": 0,
"title": "Use Brief Prompts",
"type": "boolean",
"description": " A flag indicating whether the subscriber hears brief or full phone menus when accessing Cisco Unity Connection over the phone.",
"name": "UseBriefPrompts"
},
"SkipPasswordForKnownDevice": {
"minItems": 0,
"title": "Skip Password For Known Device",
"type": "boolean",
"description": " A flag indicating whether the subscriber will be asked for his/her PIN when attempting to sign-in from a known device.",
"name": "SkipPasswordForKnownDevice"
},
"LastName": {
"minItems": 0,
"title": "Last Name",
"type": "string",
"description": " The last name (i.e., surname or family name) of this user, by which a user is commonly known.",
"name": "LastName"
},
"Callhandler": {
"type": "object",
"properties": {
"VoiceName": {
"minItems": 0,
"title": "Voice Name",
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName"
},
"templateObjectId": {
"target_attr": "ObjectId",
"description": "Query parameter",
"title": "Template",
"format": "uri",
"required": false,
"name": "templateObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/CallhandlerTemplate",
"choices": [],
"type": "string",
"target": "/api/device/cuc/CallhandlerTemplate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PartitionURI": {
"name": "PartitionURI",
"title": "Partition URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Transfer": {
"items": {
"type": "object",
"properties": {
"TransferHoldingMode": {
"minItems": 0,
"title": "Transfer Holding Mode",
"type": "integer",
"description": " The action Cisco Unity Connection will take when the extension is busy.",
"name": "TransferHoldingMode"
},
"TransferOptionType": {
"description": " The type of transfer option, e.g. \"Standard,\" \"Off Hours,\" or \"Alternate.\" - template parameter [2]",
"title": "Transfer Option Type",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TransferOptionType"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferConfirm": {
"minItems": 0,
"title": "Transfer Confirm",
"type": "boolean",
"description": " 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. \n",
"name": "TransferConfirm"
},
"TransferRings": {
"minItems": 0,
"title": "Transfer Rings",
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings"
},
"TransferScreening": {
"minItems": 0,
"title": "Transfer Screening",
"type": "boolean",
"description": " 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.",
"name": "TransferScreening"
},
"RnaAction": {
"minItems": 0,
"title": "Rna Action",
"type": "integer",
"description": " 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.",
"name": "RnaAction"
},
"PersonalCallTransfer": {
"minItems": 0,
"title": "Personal Call Transfer",
"type": "boolean",
"description": " A flag indicating whether or not Personal Call Transfer Rules are used for the specific Transfer Option.",
"name": "PersonalCallTransfer"
},
"Extension": {
"minItems": 0,
"title": "Extension",
"type": "string",
"description": " The extension (phone number) to transfer to.",
"name": "Extension"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"title": "Callhandler URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Enabled": {
"title": "Enabled",
"type": "boolean",
"description": "If TimeExpires is set, this field is ignored.",
"name": "Enabled"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UsePrimaryExtension": {
"minItems": 0,
"title": "Use Primary Extension",
"type": "boolean",
"description": "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.",
"name": "UsePrimaryExtension"
},
"TransferAnnounce": {
"minItems": 0,
"title": "Transfer Announce",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays \"transferring call\" when the subscriber answers the phone. ",
"name": "TransferAnnounce"
},
"Action": {
"minItems": 0,
"title": "Action",
"type": "integer",
"description": " A flag indicating whether Cisco Unity Connection transfers the call to the call handler greeting or attempts to transfer the call to an extension.",
"name": "Action"
},
"TransferType": {
"minItems": 0,
"title": "Transfer Type",
"type": "integer",
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"name": "TransferType"
},
"CallHandlerObjectId": {
"description": " The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "CallHandlerObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/Callhandler",
"title": "Call Handler Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferDtDetect": {
"minItems": 0,
"title": "Transfer Dt Detect",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will check for dialtone before attempting to transfer the call.",
"name": "TransferDtDetect"
},
"PlayTransferPrompt": {
"minItems": 0,
"title": "Play Transfer Prompt",
"type": "boolean",
"description": " A flag indicating whether the \"Wait while I transfer your call\" prompt should be played prior to transferring a call. \n\n",
"name": "PlayTransferPrompt"
},
"TransferIntroduce": {
"minItems": 0,
"title": "Transfer Introduce",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will say \"call for <recorded name of the call handler>\" when the subscriber answers the phone. ",
"name": "TransferIntroduce"
},
"MediaSwitchObjectId": {
"minItems": 0,
"title": "Media Switch Object Id",
"type": "string",
"description": " The unique identifier of the MediaSwitch object that Cisco Unity Connection uses for transferring the call to the subscriber phone.",
"name": "MediaSwitchObjectId"
},
"TimeExpires": {
"minItems": 0,
"title": "Time Expires",
"type": [
"string",
"null"
],
"description": " 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.",
"name": "TimeExpires"
}
}
},
"type": "array",
"title": "Transfer"
},
"CreationTime": {
"description": " The date and time the handler is created.",
"title": "Creation Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CreationTime"
},
"CallHandlerOwnerURI": {
"readonly": true,
"title": "Call Handler Owner URI",
"type": "string",
"description": "The URI to fetch the call handler owners.",
"name": "CallHandlerOwnerURI"
},
"EnablePrependDigits": {
"minItems": 0,
"title": "Enable Prepend Digits",
"type": "boolean",
"description": " A flag to indicate weather or not to prepend digits when dialing a extension number to transfer too.\n\n",
"name": "EnablePrependDigits"
},
"UseDefaultTimeZone": {
"minItems": 0,
"title": "Use Default Time Zone",
"type": "boolean",
"description": "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.",
"name": "UseDefaultTimeZone"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientDistributionListURI": {
"name": "RecipientDistributionListURI",
"title": "Recipient Distribution List URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeZone": {
"minItems": 0,
"title": "Time Zone",
"type": "integer",
"description": " TimeZone this call handler is operating in.",
"name": "TimeZone"
},
"ScheduleSetURI": {
"name": "ScheduleSetURI",
"title": "Schedule Set URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PartitionObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.",
"format": "uri",
"minItems": 0,
"title": "Partition Name",
"name": "PartitionObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/Partition",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientSubscriberObjectId": {
"target_attr": "ObjectId",
"description": " 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.",
"format": "uri",
"minItems": 0,
"title": "User with Mailbox",
"name": "RecipientSubscriberObjectId",
"target_title": "Alias",
"target_model_type": "device/cuc/User",
"choices": [],
"type": "string",
"target": "/api/device/cuc/User/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallSearchSpaceObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the SearchSpace that is used limit visibility to dialable objects when searching by extension (dial string).",
"format": "uri",
"minItems": 0,
"title": "Call Search Space",
"name": "CallSearchSpaceObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/SearchSpace",
"choices": [],
"type": "string",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Language": {
"description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.",
"title": "Language",
"minItems": 0,
"choices": [
[
1033,
"English(UnitedStates)"
]
],
"type": "integer",
"name": "Language"
},
"UseCallLanguage": {
"minItems": 0,
"title": "Use Call Language",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.",
"name": "UseCallLanguage"
},
"TransferOptionsURI": {
"name": "TransferOptionsURI",
"title": "Transfer Options URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.",
"format": "uri",
"minItems": 0,
"title": "Schedule Set",
"name": "ScheduleSetObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/ScheduleSet",
"choices": [],
"type": "string",
"target": "/api/device/cuc/ScheduleSet/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"OneKeyDelay": {
"minItems": 0,
"title": "One Key Delay",
"type": "integer",
"description": " 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.",
"name": "OneKeyDelay"
},
"DispatchDelivery": {
"minItems": 0,
"title": "Dispatch Delivery",
"type": "boolean",
"description": " A flag indicating that all messages left for the call handler is for dispatch delivery. ",
"name": "DispatchDelivery"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"title": "Voice Name URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageAction": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "After Message Action",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
5,
"Skip Greeting"
],
[
6,
"Restart Greeting"
],
[
7,
"Transfer to Alternate Contact Number"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "AfterMessageAction"
},
"PostGreetingRecordingObjectId": {
"target_attr": "ObjectId",
"description": " A link to a PostGreetingRecording",
"format": "uri",
"minItems": 0,
"title": "Post Greeting Recording",
"name": "PostGreetingRecordingObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/PostGreetingRecording",
"choices": [],
"type": "string",
"target": "/api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DtmfAccessId": {
"minItems": 0,
"title": "Dtmf Access Id",
"type": "string",
"description": "The DTMF access id (i.e., extension) for the call handler. The dialable number.",
"name": "DtmfAccessId"
},
"MaxMsgLen": {
"minItems": 0,
"title": "Max Msg Len",
"type": "integer",
"description": " The maximum recording length (in seconds) for messages left by unidentified callers.",
"name": "MaxMsgLen"
},
"EditMsg": {
"minItems": 0,
"title": "Edit Msg",
"type": "boolean",
"description": " A flag that determines whether the caller can edit messages.",
"name": "EditMsg"
},
"MenuEntriesURI": {
"name": "MenuEntriesURI",
"title": "Menu Entries URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsPrimary": {
"description": " A flag indicating whether this is a \"primary\" call handler for a subscriber, or an \"application\" call handler.",
"title": "Is Primary",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsPrimary"
},
"PrependDigits": {
"minItems": 0,
"title": "Prepend Digits",
"type": "string",
"description": " Touch-Tone digits to prepended to extension when dialing transfer number ( #, 0,1...9,*).",
"name": "PrependDigits"
},
"LocationObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the Location object to which this handler belongs.",
"format": "uri",
"minItems": 0,
"title": "Location",
"name": "LocationObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Location",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"LocalizationKey": {
"title": "Localization Key",
"type": "string",
"description": "Localization Key for Timezone update.",
"name": "LocalizationKey"
},
"RecipientUserURI": {
"name": "RecipientUserURI",
"title": "Recipient User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsTemplate": {
"description": " A flag indicating whether this CallHandler is a \"template\" for creating new call handlers.",
"title": "Is Template",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsTemplate"
},
"PlayAfterMessageRecordingObjectId": {
"target_attr": "ObjectId",
"description": " A Link To a PostGreetingRecording that is used as After Message Recording",
"format": "uri",
"minItems": 0,
"title": "Play After Message Recording",
"name": "PlayAfterMessageRecordingObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/PostGreetingRecording",
"choices": [],
"type": "string",
"target": "/api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallSearchSpaceURI": {
"name": "CallSearchSpaceURI",
"title": "Call Search Space URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientContactURI": {
"name": "RecipientContactURI",
"title": "Recipient Contact URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UseDefaultLanguage": {
"minItems": 0,
"title": "Use Default Language",
"type": "boolean",
"description": "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.",
"name": "UseDefaultLanguage"
},
"PlayAfterMessage": {
"description": " Indicates whether the Sent Message Prompt Recording referenced by Post Greeting",
"title": "Play After Message",
"minItems": 0,
"choices": [
[
0,
"Do Not Play Recording"
],
[
1,
"System Default Recording"
]
],
"type": "integer",
"name": "PlayAfterMessage"
},
"GreetingsURI": {
"name": "GreetingsURI",
"title": "Greetings URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageTargetHandlerObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"format": "uri",
"minItems": 0,
"title": "After Message Target Handler",
"name": "AfterMessageTargetHandlerObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TenantObjectId": {
"minItems": 0,
"title": "Tenant Object Id",
"type": "string",
"description": " Unique ObjectId of the tbl_Tenant",
"name": "TenantObjectId"
},
"SendUrgentMsg": {
"description": " A flag indicating whether an unidentified caller can mark a message as \"urgent.\"",
"title": "Message Urgency",
"minItems": 0,
"choices": [
[
0,
"Mark Normal"
],
[
1,
"Mark Urgent"
],
[
2,
"Ask Callers"
]
],
"type": "integer",
"name": "SendUrgentMsg"
},
"CallhandlerMenuEntry": {
"items": {
"type": "object",
"properties": {
"Locked": {
"minItems": 0,
"title": "Locked",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key.\n\nValues:\n0: Additional input accepted\n1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key. \n",
"name": "Locked"
},
"TransferType": {
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"title": "Transfer Type",
"minItems": 0,
"choices": [
[
0,
"Release to Switch"
],
[
1,
"Supervise Transfer"
]
],
"type": "integer",
"name": "TransferType"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"TransferNumber": {
"minItems": 0,
"title": "Transfer Number",
"type": "string",
"description": " The phone number associated with the alternate contact",
"name": "TransferNumber"
},
"TransferRings": {
"minItems": 0,
"title": "Transfer Rings",
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"title": "Callhandler URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallHandlerObjectId": {
"target_attr": "ObjectId",
"description": " The unique identifier of the CallHandler object to which this menu entry belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "CallHandlerObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"title": "Call Handler",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TouchtoneKey": {
"description": " The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). - template parameter [2]",
"title": "Touchtone Key",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TouchtoneKey"
},
"TargetConversation": {
"minItems": 0,
"title": "Target Conversation",
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "TargetConversation"
},
"Action": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "Call Action",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
5,
"Skip Greeting"
],
[
6,
"Restart Greeting"
],
[
7,
"Transfer to Alternate Contact Number"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "Action"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": " The display name associated with the alternate contact number.",
"name": "DisplayName"
},
"TargetHandlerObjectId": {
"minItems": 0,
"title": "Target Handler Object Id",
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "TargetHandlerObjectId"
}
}
},
"type": "array",
"title": "Callhandler Menu Entry"
},
"Undeletable": {
"description": " 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.",
"title": "Undeletable",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "Undeletable"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"title": "Voice File URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageTargetConversation": {
"minItems": 0,
"title": "After Message Target Conversation",
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "AfterMessageTargetConversation"
},
"RecipientContactObjectId": {
"target_attr": "ObjectId",
"description": " 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.",
"format": "uri",
"minItems": 0,
"title": "Recipient Contact",
"name": "RecipientContactObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Contact",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Contact/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientDistributionListObjectId": {
"target_attr": "ObjectId",
"description": " 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.",
"format": "uri",
"minItems": 0,
"title": "Recipient Distribution List",
"name": "RecipientDistributionListObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/DistributionList",
"choices": [],
"type": "string",
"target": "/api/device/cuc/DistributionList/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SendPrivateMsg": {
"description": " Determines if an outside caller can mark their message as private.",
"title": "Message Sensitivity",
"minItems": 0,
"choices": [
[
0,
"Mark Normal"
],
[
1,
"Mark Urgent"
],
[
2,
"Ask Callers"
]
],
"type": "integer",
"name": "SendPrivateMsg"
},
"SendSecureMsg": {
"minItems": 0,
"title": "Send Secure Msg",
"type": "boolean",
"description": " A flag indicating whether an unidentified caller can mark a message as \"secure.\"",
"name": "SendSecureMsg"
},
"DisplayName": {
"description": " 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.\"",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"PlayPostGreetingRecording": {
"description": " Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.",
"title": "Play Post Greeting Recording",
"minItems": 0,
"choices": [
[
0,
"Do Not Play Recording"
],
[
1,
"Play Recording to All Callers"
],
[
2,
"Play Recording Only to Unidentified Callers"
]
],
"type": "integer",
"name": "PlayPostGreetingRecording"
},
"Owner": {
"items": {
"type": "object",
"properties": {
"DistributionListObjectId": {
"minItems": 0,
"title": "Distribution List Object Id",
"type": "string",
"description": " The unique identifier of the DistributionList object to which this distribution list member belongs.",
"name": "DistributionListObjectId"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a Call handler owner object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DistributionListURI": {
"name": "DistributionListURI",
"title": "Distribution List URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserObjectId": {
"minItems": 0,
"type": "string",
"name": "UserObjectId",
"title": "User Object Id"
},
"TargetHandlerObjectId": {
"description": " The unique identifier of the Call Handler object for which this distribution list is the owner. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "TargetHandlerObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/Callhandler",
"title": "Target Handler Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"maxItems": 1,
"title": "Owner"
},
"InheritSearchSpaceFromCall": {
"minItems": 0,
"title": "Inherit Search Space From Call",
"type": "boolean",
"description": " 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.",
"name": "InheritSearchSpaceFromCall"
},
"MediaSwitchObjectId": {
"target_attr": "ObjectId",
"description": " Default switch to use for transfers.",
"format": "uri",
"minItems": 0,
"title": "Phone System",
"name": "MediaSwitchObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/PhoneSystem",
"choices": [],
"type": "string",
"target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LocationURI": {
"name": "LocationURI",
"title": "Location URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"title": "Callhandler"
},
"SkipReverseTime": {
"minItems": 0,
"title": "Skip Reverse Time",
"type": "integer",
"description": " 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.",
"name": "SkipReverseTime"
},
"RouteNDRToSender": {
"minItems": 0,
"title": "Route NDR To Sender",
"type": "boolean",
"description": " A flag indicating, for an undeliverable message, whether NDR messages will appear in the subscriber's mailbox or are deleted by the system.",
"name": "RouteNDRToSender"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"title": "Voice Name URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayTimestampBefore": {
"minItems": 0,
"title": "Say Timestamp Before",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the timestamp before it plays back each for the subscriber.",
"name": "SayTimestampBefore"
},
"PrivateListsURI": {
"name": "PrivateListsURI",
"title": "Private Lists URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayMsgNumberAfter": {
"minItems": 0,
"title": "Say Msg Number After",
"type": "boolean",
"description": " This flag works exactly the same as the SayMsgNumber flag on a user, except the conversation plays the message number in the message footer.",
"name": "SayMsgNumberAfter"
},
"SpeechCompleteTimeout": {
"minItems": 0,
"title": "Speech Complete Timeout",
"type": "integer",
"description": " 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. \n\nA 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.",
"name": "SpeechCompleteTimeout"
},
"ForcedAuthorizationCode": {
"minItems": 0,
"title": "Forced Authorization Code",
"type": "string",
"description": " A valid authorization code that is entered prior to extending calls to classes of dialed numbers, for example, external, toll and international calls.",
"name": "ForcedAuthorizationCode"
},
"EnAltGreetPreventMsg": {
"minItems": 0,
"title": "En Alt Greet Prevent Msg",
"type": "boolean",
"description": " A flag indicating whether callers can leave a message after the greeting when the subscriber alternate greeting is turned on.",
"name": "EnAltGreetPreventMsg"
},
"AutoAdvanceMsgs": {
"minItems": 0,
"title": "Auto Advance Msgs",
"type": "boolean",
"description": " 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.",
"name": "AutoAdvanceMsgs"
},
"EnAltGreetDontRingPhone": {
"minItems": 0,
"title": "En Alt Greet Dont Ring Phone",
"type": "boolean",
"description": " A flag indicating whether a caller is prevented from being transferred to the subscriber phone when the subscriber alternate greeting is turned on.",
"name": "EnAltGreetDontRingPhone"
},
"templateAlias": {
"description": "Query parameter",
"title": "Template Alias",
"format": "uri",
"required": false,
"name": "templateAlias",
"target_attr": "Alias",
"target_model_type": "device/cuc/UserTemplate",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnableMessageLocator": {
"minItems": 0,
"title": "Enable Message Locator",
"type": "boolean",
"description": " A flag indicating whether the message locator feature is enabled for the subscriber.",
"name": "EnableMessageLocator"
},
"CreateSmtpProxyFromCorp": {
"minItems": 0,
"title": "Create Smtp Proxy From Corp",
"type": "boolean",
"description": " Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created for this User.",
"name": "CreateSmtpProxyFromCorp"
},
"IsSetForVmEnrollment": {
"minItems": 0,
"title": "Is Set For Vm Enrollment",
"type": "boolean",
"description": "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.",
"name": "IsSetForVmEnrollment"
},
"UseDynamicNameSearchWeight": {
"minItems": 0,
"title": "Use Dynamic Name Search Weight",
"type": "boolean",
"description": " Use dynamic name search weight. When this user addresses objects, the name search weight for those objects will automatically be incremented.",
"name": "UseDynamicNameSearchWeight"
},
"UserRoleURI": {
"readonly": true,
"title": "User Role URI",
"type": "string",
"description": "The URI to change the role of the user.",
"name": "UserRoleURI"
},
"ClockMode": {
"minItems": 0,
"title": "Clock Mode",
"type": "integer",
"description": " The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.",
"name": "ClockMode"
},
"IsTemplate": {
"description": " A flag indicating whether this instance of a User object is a \"template\" for creating new users. ",
"title": "Is Template",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsTemplate"
},
"LdapCcmUserId": {
"minItems": 0,
"title": "Ldap Ccm User Id",
"type": "string",
"description": " The userid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmUserId"
},
"ConversationTui": {
"minItems": 0,
"title": "Conversation Tui",
"type": "string",
"description": " The name of the conversation the subscriber uses to set up, send, and retrieve messages.",
"name": "ConversationTui"
},
"DtmfNameFirstLast": {
"minItems": 0,
"title": "Dtmf Name First Last",
"type": "string",
"description": " 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.",
"name": "DtmfNameFirstLast"
},
"PostalCode": {
"minItems": 0,
"title": "Postal Code",
"type": "string",
"description": " 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.",
"name": "PostalCode"
},
"XferString": {
"minItems": 0,
"title": "Xfer String",
"type": "string",
"description": " The cross-server transfer extension. If NULL, the user's primary extension is used.",
"name": "XferString"
},
"ConfirmationConfidenceThreshold": {
"minItems": 0,
"title": "Confirmation Confidence Threshold",
"type": "integer",
"description": " Voice Recognition Confirmation Confidence Threshold",
"name": "ConfirmationConfidenceThreshold"
},
"Undeletable": {
"description": " 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.",
"title": "Undeletable",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "Undeletable"
},
"DelayAfterGreeting": {
"minItems": 0,
"title": "Delay After Greeting",
"type": "integer",
"description": " The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting.",
"name": "DelayAfterGreeting"
},
"EncryptPrivateMessages": {
"minItems": 0,
"title": "Encrypt Private Messages",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection encrypts messages from the subscriber that are marked private.",
"name": "EncryptPrivateMessages"
},
"SayTotalReceipts": {
"minItems": 0,
"title": "Say Total Receipts",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new receipts in the subscriber mailbox.",
"name": "SayTotalReceipts"
},
"NewMessageStackOrder": {
"minItems": 0,
"title": "New Message Stack Order",
"type": "string",
"description": " The order in which Cisco Unity Connection plays the following types of \"new\" messages:\n* Urgent voice messages\n* Non-urgent voice messages\n* Urgent fax messages\n* Non-urgent fax messages\n* Urgent e-mail messages\n* Non-urgent e-mail messages\n* Receipts and notices",
"name": "NewMessageStackOrder"
},
"NotificationDevicesURI": {
"name": "NotificationDevicesURI",
"title": "Notification Devices URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MailboxStoreObjectId": {
"target_attr": "ObjectId",
"description": "Mailbox Store for the tenant.",
"title": "Mailbox Store",
"format": "uri",
"required": false,
"name": "MailboxStoreObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/MailboxStore",
"choices": [],
"type": "string",
"target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsVmEnrolled": {
"minItems": 0,
"title": "Is Vm Enrolled",
"type": "boolean",
"description": " 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.",
"name": "IsVmEnrolled"
},
"Inactive": {
"minItems": 0,
"title": "Inactive",
"type": "boolean",
"description": " A flag indicating whether this subscriber is inactive or not.",
"name": "Inactive"
},
"EmailAddress": {
"minItems": 0,
"title": "Email Address",
"type": "string",
"description": " The corporate email address of the user. ",
"name": "EmailAddress"
},
"EnableTts": {
"minItems": 0,
"title": "Enable Tts",
"type": "boolean",
"description": " A flag indicating whether TTS is enabled for the subscriber. Only relevant if TTS enabled in User's COS also.",
"name": "EnableTts"
},
"SearchByExtensionSearchSpaceObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).",
"format": "uri",
"minItems": 0,
"title": "Search By Extension Search Space",
"name": "SearchByExtensionSearchSpaceObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/SearchSpace",
"choices": [],
"type": "string",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UseDefaultLanguage": {
"minItems": 0,
"title": "Use Default Language",
"type": "boolean",
"description": "Set to true (1) if call handler is using default language from the location it belongs to.",
"name": "UseDefaultLanguage"
},
"PcaAddressBookRowsPerPage": {
"minItems": 0,
"title": "Pca Address Book Rows Per Page",
"type": "integer",
"description": " 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.",
"name": "PcaAddressBookRowsPerPage"
},
"LocationURI": {
"name": "LocationURI",
"title": "Location URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayDistributionList": {
"minItems": 0,
"title": "Say Distribution List",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the distribution list that sends a message, if applicable.",
"name": "SayDistributionList"
},
"City": {
"minItems": 0,
"title": "City",
"type": "string",
"description": " 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.",
"name": "City"
},
"SendBroadcastMsg": {
"minItems": 0,
"title": "Send Broadcast Msg",
"type": "boolean",
"description": " A flag indicating whether the subscriber may send broadcast messages.",
"name": "SendBroadcastMsg"
},
"ExitAction": {
"minItems": 0,
"title": "Exit Action",
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "ExitAction"
},
"VoiceNameRequired": {
"minItems": 0,
"title": "Voice Name Required",
"type": "boolean",
"description": " A flag indicating whether a recorded voice name is required for this subscriber.",
"name": "VoiceNameRequired"
},
"SearchByExtensionSearchSpaceURI": {
"name": "SearchByExtensionSearchSpaceURI",
"title": "Search By Extension Search Space URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SmtpProxyAddressesURI": {
"readonly": true,
"title": "Smtp Proxy Addresses URI",
"type": "string",
"description": "The URI to get the smtp proxy addresses of the user.",
"name": "SmtpProxyAddressesURI"
},
"MessageHandlersURI": {
"name": "MessageHandlersURI",
"title": "Message Handlers URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayTotalNewFax": {
"minItems": 0,
"title": "Say Total New Fax",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new fax messages in the subscriber mailbox.",
"name": "SayTotalNewFax"
},
"CallHandlerObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the primary CallHandler object for the subscriber.",
"format": "uri",
"minItems": 0,
"title": "Call Handler",
"name": "CallHandlerObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeZone": {
"minItems": 0,
"title": "Time Zone",
"type": "integer",
"description": " The time zone to which this user account is associated.",
"name": "TimeZone"
},
"SaySenderAfter": {
"minItems": 0,
"title": "Say Sender After",
"type": "boolean",
"description": " This flag works exactly the same as the SaySender flag on a user, except the conversation plays the sender in the message footer.",
"name": "SaySenderAfter"
},
"NameConfirmation": {
"minItems": 0,
"title": "Name Confirmation",
"type": "boolean",
"description": " 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.\n",
"name": "NameConfirmation"
},
"SearchByNameSearchSpaceURI": {
"name": "SearchByNameSearchSpaceURI",
"title": "Search By Name Search Space URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnablePersonalRules": {
"minItems": 0,
"title": "Enable Personal Rules",
"type": "boolean",
"description": " A flag indicating whether a subscriber's personal rules are enabled. Subscribers can use this setting to disable all personal rules at once.",
"name": "EnablePersonalRules"
},
"ConfirmDeleteMessage": {
"minItems": 0,
"title": "Confirm Delete Message",
"type": "boolean",
"description": " 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. ",
"name": "ConfirmDeleteMessage"
},
"SynchScheduleObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the Schedule object to use for synchronization Calendar information from groupware (such as Exchange).",
"format": "uri",
"minItems": 0,
"title": "Synch Schedule",
"name": "SynchScheduleObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Schedule",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Language": {
"minItems": 0,
"title": "Language",
"type": "integer",
"description": " 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. ",
"name": "Language"
},
"RecordUnknownCallerName": {
"minItems": 0,
"title": "Record Unknown Caller Name",
"type": "boolean",
"description": " A flag indicating whether a caller should be promoted to record his/her name if Unity does not receive caller id.",
"name": "RecordUnknownCallerName"
},
"Manager": {
"minItems": 0,
"title": "Manager",
"type": [
"string",
"null"
],
"description": " The name of the person who is the manager or supervisor of the user.",
"name": "Manager"
},
"CallAnswerTimeout": {
"minItems": 0,
"title": "Call Answer Timeout",
"type": "integer",
"description": " The number of rings to wait for a subscriber destination to answer before the call is forwarded to the subscriber's primary phone.",
"name": "CallAnswerTimeout"
},
"Volume": {
"minItems": 0,
"title": "Volume",
"type": "integer",
"description": " The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message.",
"name": "Volume"
},
"SayTotalSaved": {
"minItems": 0,
"title": "Say Total Saved",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of saved messages in the subscriber mailbox.",
"name": "SayTotalSaved"
},
"InterdigitDelay": {
"minItems": 0,
"title": "Interdigit Delay",
"type": "integer",
"description": " The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.",
"name": "InterdigitDelay"
},
"CosURI": {
"name": "CosURI",
"title": "Cos URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SmtpAddress": {
"minItems": 0,
"title": "Smtp Address",
"type": "string",
"description": "SMTP address The full SMTP address for this object.",
"name": "SmtpAddress"
},
"LocalizationKey": {
"title": "Localization Key",
"type": "string",
"description": "Localization Key.",
"name": "LocalizationKey"
},
"Country": {
"minItems": 0,
"title": "Country",
"type": "string",
"description": " The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated.",
"name": "Country"
},
"SayMessageLength": {
"minItems": 0,
"title": "Say Message Length",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.",
"name": "SayMessageLength"
},
"ListInDirectory": {
"minItems": 0,
"title": "List In Directory",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.",
"name": "ListInDirectory"
},
"cucpager": {
"items": {
"type": "object",
"properties": {
"SuccessRetryInterval": {
"minItems": 0,
"title": "Success Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.",
"name": "SuccessRetryInterval"
},
"DisplayName": {
"description": " 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. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"AfterDialDigits": {
"minItems": 0,
"title": "After Dial Digits",
"type": "string",
"description": " 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.",
"name": "AfterDialDigits"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RetriesOnSuccess": {
"minItems": 0,
"title": "Retries On Success",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is successful.",
"name": "RetriesOnSuccess"
},
"SendCount": {
"minItems": 0,
"title": "Send Count",
"type": "boolean",
"description": " 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. ",
"name": "SendCount"
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"RnaRetryInterval": {
"minItems": 0,
"title": "Rna Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.",
"name": "RnaRetryInterval"
},
"RetriesOnBusy": {
"minItems": 0,
"title": "Retries On Busy",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.",
"name": "RetriesOnBusy"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDevicePager object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"SendCallerId": {
"minItems": 0,
"title": "Send Caller Id",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialDelay": {
"minItems": 0,
"title": "Dial Delay",
"type": "integer",
"description": " 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.",
"name": "DialDelay"
},
"PhoneNumber": {
"minItems": 0,
"title": "Phone Number",
"type": [
"string",
"null"
],
"description": " The phone number to dial, including the trunk access code, to send a page.",
"name": "PhoneNumber"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"RingsToWait": {
"minItems": 0,
"title": "Rings To Wait",
"type": "integer",
"description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.",
"name": "RingsToWait"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"WaitConnect": {
"minItems": 0,
"title": "Wait Connect",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits. ",
"name": "WaitConnect"
},
"BusyRetryInterval": {
"minItems": 0,
"title": "Busy Retry Interval",
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.",
"name": "BusyRetryInterval"
},
"RetriesOnRna": {
"minItems": 0,
"title": "Retries On Rna",
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.",
"name": "RetriesOnRna"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
},
"MediaSwitchObjectId": {
"description": " The unique identifier of the MediaSwitch object to use for notification. ",
"format": "uri",
"minItems": 0,
"required": true,
"name": "MediaSwitchObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/PhoneSystem",
"title": "Media Switch Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"title": "Transmit Forced Authorization Code",
"type": "boolean",
"description": " A flag indicting whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.",
"name": "TransmitForcedAuthorizationCode"
}
}
},
"type": "array",
"title": "Cucpager"
},
"PartitionObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the Partition to which the DtmfAccessId is assigned.",
"format": "uri",
"minItems": 0,
"title": "Partition Name",
"name": "PartitionObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/Partition",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Alias": {
"description": " The unique text name for either a user, distribution list, or personal group.",
"title": "Alias",
"minItems": 0,
"required": true,
"type": "string",
"name": "Alias"
},
"PromptVolume": {
"minItems": 0,
"title": "Prompt Volume",
"type": "integer",
"description": " The volume level for playback of system prompts.",
"name": "PromptVolume"
},
"cuchtml": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " 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. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SendScheduledNotificationAt": {
"title": "Send Scheduled Notification At",
"type": "string",
"description": "Comma separated list of time slots at which scheduled notification will be triggered at daily basis.",
"name": "SendScheduledNotificationAt"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"DisableMobileNumberFromPCA": {
"minItems": 0,
"title": "Disable Mobile Number From PCA",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to change Mobile Number.",
"name": "DisableMobileNumberFromPCA"
},
"SmtpAddress": {
"minItems": 0,
"title": "Smtp Address",
"type": "string",
"description": " 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.",
"name": "SmtpAddress"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceHTML object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"DisableTemplateSelectionFromPCA": {
"minItems": 0,
"title": "Disable Template Selection From PCA",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to select notification templates.",
"name": "DisableTemplateSelectionFromPCA"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AllowVoiceMailAsAttachment": {
"minItems": 0,
"title": "Allow Voice Mail As Attachment",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will allow notifier to send voice mail recording with the notification.",
"name": "AllowVoiceMailAsAttachment"
},
"MessageCountInSummary": {
"minItems": 0,
"title": "Message Count In Summary",
"type": "integer",
"description": " Field to store number of messages to be sent in summary notification mail",
"name": "MessageCountInSummary"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"CallbackNumber": {
"minItems": 0,
"type": "string",
"name": "CallbackNumber",
"title": "Callback Number"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"NotificationTemplateID": {
"target": "/api/device/cuc/NotificationTemplate/choices/?field=NotificationTemplateID&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Notification Template ID",
"minItems": 0,
"format": "uri",
"name": "NotificationTemplateID",
"target_attr": "NotificationTemplateID",
"target_model_type": "device/cuc/NotificationTemplate",
"choices": [],
"type": [
"string"
],
"description": " The unique identifier of the Notification Template object which this notification device is using for HTML based notification"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
}
}
},
"type": "array",
"title": "Cuchtml"
},
"CosObjectId": {
"target_attr": "ObjectId",
"description": "The name of the Class of Service object with which this user account is associated.",
"format": "uri",
"minItems": 0,
"title": "Class of Service",
"name": "CosObjectId",
"target_title": "DisplayName",
"target_model_type": "device/cuc/Cos",
"choices": [],
"type": "string",
"target": "/api/device/cuc/Cos/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayTotalDraftMsg": {
"minItems": 0,
"title": "Say Total Draft Msg",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox",
"name": "SayTotalDraftMsg"
},
"SayTotalNew": {
"minItems": 0,
"title": "Say Total New",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new messages in the subscriber mailbox.",
"name": "SayTotalNew"
},
"SayTotalNewEmail": {
"minItems": 0,
"title": "Say Total New Email",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new e-mail messages in the subscriber mailbox.",
"name": "SayTotalNewEmail"
},
"SpeechIncompleteTimeout": {
"minItems": 0,
"title": "Speech Incomplete Timeout",
"type": "integer",
"description": " 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.\n\nA 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.\n\nThe 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.",
"name": "SpeechIncompleteTimeout"
},
"UserVoicePinURI": {
"readonly": true,
"title": "User Voice Pin URI",
"type": "string",
"description": "The URI to change the voice mail pin of the user.",
"name": "UserVoicePinURI"
},
"LdapCcmPkid": {
"minItems": 0,
"title": "Ldap Ccm Pkid",
"type": "string",
"description": " The pkid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmPkid"
},
"SendMessageOnHangup": {
"minItems": 0,
"title": "Send Message On Hangup",
"type": "integer",
"description": " 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.",
"name": "SendMessageOnHangup"
},
"AlternateExtensionsURI": {
"name": "AlternateExtensionsURI",
"title": "Alternate Extensions URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayAniAfter": {
"minItems": 0,
"title": "Say Ani After",
"type": "boolean",
"description": " This flag works exactly the same as the SayAni flag on a user, except the conversation plays the ani in the message footer.",
"name": "SayAniAfter"
},
"IsClockMode24Hour": {
"minItems": 0,
"title": "Is Clock Mode24Hour",
"type": "boolean",
"description": " The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.",
"name": "IsClockMode24Hour"
},
"UseShortPollForCache": {
"minItems": 0,
"title": "Use Short Poll For Cache",
"type": "boolean",
"description": " A flag indicating whether the user's polling cycle for retrieving calendar information will be the shorter \"power user\" polling cycle.",
"name": "UseShortPollForCache"
},
"DtmfAccessId": {
"description": "The DTMF access id (i.e., extension) of the subscriber. The dialable number.",
"title": "Dtmf Access Id",
"minItems": 0,
"required": true,
"type": "string",
"name": "DtmfAccessId"
},
"FaxServerURI": {
"name": "FaxServerURI",
"title": "Fax Server URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"BillingId": {
"minItems": 0,
"title": "Billing Id",
"type": "string",
"description": " Accounting information or project code associated with this user.",
"name": "BillingId"
},
"SearchByNameSearchSpaceObjectId": {
"target_attr": "ObjectId",
"description": "The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string).",
"format": "uri",
"minItems": 0,
"title": "Search By Name Search Space",
"name": "SearchByNameSearchSpaceObjectId",
"target_title": "Name",
"target_model_type": "device/cuc/SearchSpace",
"choices": [],
"type": "string",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DeletedMessageSortOrder": {
"minItems": 0,
"title": "Deleted Message Sort Order",
"type": "integer",
"description": " The order in which Cisco Unity Connection presents deleted messages to the subscriber.",
"name": "DeletedMessageSortOrder"
},
"SpeechSpeedVsAccuracy": {
"minItems": 0,
"title": "Speech Speed Vs Accuracy",
"type": "integer",
"description": " 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.\n",
"name": "SpeechSpeedVsAccuracy"
},
"cucsms": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " 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. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"SmppProviderObjectId": {
"description": " The unique identifier of the SMPPProvider object that is used by this notification device.",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SmppProviderObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/SmppProvider",
"title": "Smpp Provider Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientAddress": {
"minItems": 0,
"title": "Recipient Address",
"type": "string",
"description": " The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the \"To:\" field.",
"name": "RecipientAddress"
},
"SendCount": {
"minItems": 0,
"title": "Send Count",
"type": "boolean",
"description": " 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. ",
"name": "SendCount"
},
"MaxSubject": {
"minItems": 0,
"title": "Max Subject",
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScheduleSetObjectId": {
"title": "Schedule Set Object Id",
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId"
},
"SenderAddress": {
"minItems": 0,
"title": "Sender Address",
"type": "string",
"description": " 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.",
"name": "SenderAddress"
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active"
},
"RepeatInterval": {
"title": "Repeat Interval",
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"title": "Max Body",
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody"
},
"EventList": {
"title": "Event List",
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList"
},
"SendCallerId": {
"minItems": 0,
"title": "Send Caller Id",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"StaticText": {
"minItems": 0,
"title": "Static Text",
"type": "string",
"description": " 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.\nTypically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.",
"name": "StaticText"
},
"Undeletable": {
"minItems": 0,
"title": "Undeletable",
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable"
},
"FailDeviceObjectId": {
"title": "Fail Device Object Id",
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId"
},
"InitialDelay": {
"title": "Initial Delay",
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay"
},
"RepeatNotify": {
"title": "Repeat Notify",
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify"
}
}
},
"type": "array",
"title": "Cucsms"
},
"Speed": {
"minItems": 0,
"title": "Speed",
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back messages to the subscriber.",
"name": "Speed"
},
"cucpin": {
"type": "object",
"properties": {
"CredentialPolicyURI": {
"name": "CredentialPolicyURI",
"title": "Credential Policy URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DoesntExpire": {
"minItems": 0,
"title": "Doesnt Expire",
"type": "boolean",
"description": " 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). ",
"name": "DoesntExpire"
},
"Locked": {
"minItems": 0,
"title": "Locked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked.",
"name": "Locked"
},
"TimeHacked": {
"minItems": 0,
"title": "Time Hacked",
"type": "string",
"description": " 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.",
"name": "TimeHacked"
},
"TimeChanged": {
"minItems": 0,
"title": "Time Changed",
"type": "string",
"description": " 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.",
"name": "TimeChanged"
},
"CantChange": {
"minItems": 0,
"title": "Cant Change",
"type": "boolean",
"description": " A flag indicating whether the user can set this credential.",
"name": "CantChange"
},
"IsPrimary": {
"minItems": 0,
"title": "Is Primary",
"type": "boolean",
"description": " 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.",
"name": "IsPrimary"
},
"CredentialPolicyObjectId": {
"minItems": 0,
"title": "Credential Policy Object Id",
"type": "string",
"description": " The unique identifier of the CredentialPolicy object that is associated with this credential.",
"name": "CredentialPolicyObjectId"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CredentialType": {
"description": " The type of credential such as password, PIN, Windows or Domino credential. ",
"title": "Credential Type",
"minItems": 0,
"choices": [
[
3,
"Password"
],
[
4,
"PIN"
]
],
"type": "integer",
"name": "CredentialType"
},
"Alias": {
"minItems": 0,
"title": "Alias",
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias"
},
"HackCount": {
"minItems": 0,
"title": "Hack Count",
"type": "integer",
"description": " 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. ",
"name": "HackCount"
},
"Hacked": {
"minItems": 0,
"title": "Hacked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.",
"name": "Hacked"
},
"ObjectId": {
"description": " Surrogate key to support IMS",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"Credentials": {
"is_password": true,
"description": " The PIN or password, for a user. The credentials are stored in an encrypted format.",
"title": "PIN",
"minItems": 0,
"type": "string",
"name": "Credentials"
},
"UserObjectId": {
"description": " The unique identifier of the User object to which this credential belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"name": "UserObjectId",
"target_attr": "ObjectId",
"readonly": true,
"target_model_type": "device/cuc/User",
"title": "User Object Id",
"choices": [],
"type": [
"string"
],
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeLastHack": {
"minItems": 0,
"title": "Time Last Hack",
"type": "string",
"description": " The date and time of the last logon attempt with an invalid user credential.",
"name": "TimeLastHack"
},
"CredMustChange": {
"minItems": 0,
"title": "Cred Must Change",
"type": "boolean",
"description": " A flag indicating whether the user must change their credentials (PIN or password) at the next login.",
"name": "CredMustChange"
},
"TimeLockout": {
"minItems": 0,
"title": "Time Lockout",
"type": "string",
"description": " The date and time that the credential was locked by an administrator.",
"name": "TimeLockout"
}
},
"title": "Cucpin"
}
},
"schema_version": "2.0.1"
}