[Index]
Model ref.: device/cuc/UserTemplate
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"VoiceName": {
"minItems": 0,
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName",
"title": "Voice Name"
},
"AddressMode": {
"description": " The default method the subscriber will use to address messages to other subscribers.",
"title": "Address Mode",
"minItems": 0,
"choices": [
[
0,
"LastNameFirst"
],
[
1,
"Extension"
],
[
2,
"FirstNameFirst"
]
],
"type": "integer",
"name": "AddressMode"
},
"CommandDigitTimeout": {
"minItems": 0,
"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",
"title": "Command Digit Timeout"
},
"ExitTargetHandlerObjectId": {
"target_title": "DisplayName",
"description": "The name of the specific object to send along to the target conversation.",
"title": "Exit Target Handler",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"type": "string",
"name": "ExitTargetHandlerObjectId"
},
"UserTemplateRolesURI": {
"name": "UserTemplateRolesURI",
"format": "uri",
"minItems": 0,
"title": "User Template Roles URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayTimestampAfter": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the timestamp after it plays back each message for the subscriber.",
"name": "SayTimestampAfter",
"title": "Say Timestamp After"
},
"Department": {
"minItems": 0,
"type": "string",
"description": " The name or number for the department or subdivision of an organization to which a person belongs.",
"name": "Department",
"title": "Department"
},
"GreetByName": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber hears his/her name when they log into their mailbox over the phone.",
"name": "GreetByName",
"title": "Greet By Name"
},
"SavedMessageSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort saved messages.",
"name": "SavedMessageSortOrder",
"title": "Saved Message Sort Order"
},
"SpeechSensitivity": {
"minItems": 0,
"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",
"title": "Speech Sensitivity"
},
"LocationObjectId": {
"target_title": "DisplayName",
"description": "The name of the LocationVMS object to which this user belongs.",
"title": "Location",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Location",
"type": "string",
"name": "LocationObjectId"
},
"SaveMessageOnHangup": {
"minItems": 0,
"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",
"title": "Save Message On Hangup"
},
"EnableVisualMessageLocator": {
"minItems": 0,
"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",
"title": "Enable Visual Message Locator"
},
"RepeatMenu": {
"minItems": 0,
"type": "integer",
"description": " The number of times to repeat a menu in TUI.",
"name": "RepeatMenu",
"title": "Repeat Menu"
},
"Building": {
"minItems": 0,
"type": "string",
"description": " The name of the building where the user is based (e.g., SJ-21).",
"name": "Building",
"title": "Building"
},
"SearchByExtensionSearchSpaceURI": {
"name": "SearchByExtensionSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Search By Extension Search Space URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ConversationVui": {
"minItems": 0,
"type": "string",
"description": " The VUI conversation assigned to the subscriber.",
"name": "ConversationVui",
"title": "Conversation Vui"
},
"SayTotalSaved": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of saved messages in the subscriber mailbox.",
"name": "SayTotalSaved",
"title": "Say Total Saved"
},
"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"
},
"MessageAgingPolicyURI": {
"name": "MessageAgingPolicyURI",
"format": "uri",
"minItems": 0,
"title": "Message Aging Policy URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"JumpToMessagesOnLogin": {
"minItems": 0,
"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",
"title": "Jump To Messages On Login"
},
"SaySender": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the sender of a message during message playback for the subscriber.",
"name": "SaySender",
"title": "Say Sender"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PromptSpeed": {
"minItems": 0,
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.",
"name": "PromptSpeed",
"title": "Prompt Speed"
},
"MailboxDn": {
"minItems": 0,
"type": "string",
"description": " The distinguished name of the mailbox.",
"name": "MailboxDn",
"title": "Mailbox Dn"
},
"UserTemplateNotificationDevicesURI": {
"name": "UserTemplateNotificationDevicesURI",
"format": "uri",
"minItems": 0,
"title": "User Template Notification Devices URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SynchScheduleURI": {
"name": "SynchScheduleURI",
"format": "uri",
"minItems": 0,
"title": "Synch Schedule URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ClientMatterCode": {
"minItems": 0,
"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",
"title": "Client Matter Code"
},
"ConfirmDeleteDeletedMessage": {
"minItems": 0,
"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",
"title": "Confirm Delete Deleted Message"
},
"EnableSaveDraft": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the save draft message feature is enabled for the subscriber.",
"name": "EnableSaveDraft",
"title": "Enable Save Draft"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"format": "uri",
"minItems": 0,
"title": "Voice File URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CantChange": {
"description": " A flag indicating whether the user can set/change their credential (i.e., the credential specified by the associated credential policy).",
"title": "Cant Change",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "CantChange"
},
"ExitCallActionObjectId": {
"target_attr": "ObjectId",
"description": "The name of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out.",
"title": "Exit Call Action",
"minItems": 0,
"format": "uri",
"choices": [],
"target_title": "DisplayName",
"readonly": true,
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"type": "string",
"name": "ExitCallActionObjectId"
},
"SayMsgNumber": {
"minItems": 0,
"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",
"title": "Say Msg Number"
},
"SayTotalNewVoice": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new voice messages in the subscriber mailbox.",
"name": "SayTotalNewVoice",
"title": "Say Total New Voice"
},
"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"
},
"SaySenderExtension": {
"minItems": 0,
"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",
"title": "Say Sender Extension"
},
"SavedMessageStackOrder": {
"minItems": 0,
"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",
"title": "Saved Message Stack Order"
},
"SaySenderExtensionAfter": {
"minItems": 0,
"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",
"title": "Say Sender Extension After"
},
"DisplayName": {
"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.",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"InboxAutoRefresh": {
"minItems": 0,
"type": "integer",
"description": " The rate (in minutes) at which Unity Inbox performs a refresh.",
"name": "InboxAutoRefresh",
"title": "Inbox Auto Refresh"
},
"UseDefaultTimeZone": {
"minItems": 0,
"type": "boolean",
"description": "Set to true (1) if the TimeZone is derived from the location to which this call handler belongs.",
"name": "UseDefaultTimeZone",
"title": "Use Default Time Zone"
},
"WarningQuota": {
"minItems": 0,
"type": "integer",
"description": " The mailbox size (in bytes) warning limit.",
"name": "WarningQuota",
"title": "Warning Quota"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"State": {
"minItems": 0,
"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",
"title": "State"
},
"SearchByNameSearchSpaceObjectId": {
"target_title": "Name",
"description": "The name of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string).",
"title": "Search By Name Search Space",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/SearchSpace",
"type": "string",
"name": "SearchByNameSearchSpaceObjectId"
},
"DoesntExpire": {
"description": " A flag indicating whether or not the user credential will automatically expire (and the user required to change the credential upon its expiration) based on a defined schedule. Regardless, the user still may change the credential (if allowed by CantChange). ",
"title": "Doesnt Expire",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "DoesntExpire"
},
"AnnounceUpcomingMeetings": {
"minItems": 0,
"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",
"title": "Announce Upcoming Meetings"
},
"SayAni": {
"minItems": 0,
"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",
"title": "Say Ani"
},
"NewMessageSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort new messages.",
"name": "NewMessageSortOrder",
"title": "New Message Sort Order"
},
"NotificationType": {
"description": " The notification type to use for this mailbox created with this subscriber. See definitions under custom type - NotificationType for more details.",
"title": "Notification Type",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "NotificationType"
},
"FaxServerObjectId": {
"target_title": "FaxServerName",
"description": "The name of the FaxServer object for the subscriber.",
"title": "Fax Server",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/FaxServer/choices/?choice_title=FaxServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/FaxServer",
"type": "string",
"name": "FaxServerObjectId"
},
"LdapType": {
"description": " The LDAP configuration information for the user.",
"title": "Ldap Type",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "LdapType"
},
"Country": {
"minItems": 0,
"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",
"title": "Country"
},
"MessageLocatorSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort messages when the \"Message Locator\" feature is enabled.",
"name": "MessageLocatorSortOrder",
"title": "Message Locator Sort Order"
},
"EnAltGreetPreventSkip": {
"minItems": 0,
"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",
"title": "En Alt Greet Prevent Skip"
},
"ContinuousAddMode": {
"minItems": 0,
"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",
"title": "Continuous Add Mode"
},
"PartitionObjectId": {
"target_title": "Name",
"description": "The name of the Partition to which a subscriber's DtmfAccessId created with this template will be assigned.",
"title": "Partition Name",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Partition",
"type": "string",
"name": "PartitionObjectId"
},
"ConfirmDeleteMultipleMessages": {
"minItems": 0,
"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",
"title": "Confirm Delete Multiple Messages"
},
"EnableMessageBookmark": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Message Bookmark is enabled for the subscriber",
"name": "EnableMessageBookmark",
"title": "Enable Message Bookmark"
},
"InboxMessagesPerPage": {
"minItems": 0,
"type": "integer",
"description": " The number of messages Unity Inbox displays in a page.",
"name": "InboxMessagesPerPage",
"title": "Inbox Messages Per Page"
},
"PabLastImported": {
"minItems": 0,
"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",
"title": "Pab Last Imported"
},
"PcaHomePage": {
"minItems": 0,
"type": "string",
"description": " The Home Page is the first page that is displayed after logging in to the PCA. ",
"name": "PcaHomePage",
"title": "Pca Home Page"
},
"UpdateBroadcastMsg": {
"minItems": 0,
"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",
"title": "Update Broadcast Msg"
},
"SayCopiedNames": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the \"copied\" names during message playback for a subscriber. ",
"name": "SayCopiedNames",
"title": "Say Copied Names"
},
"SpeechCompleteTimeout": {
"minItems": 0,
"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",
"title": "Speech Complete Timeout"
},
"SkipForwardTime": {
"minItems": 0,
"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",
"title": "Skip Forward Time"
},
"SayMessageLengthAfter": {
"minItems": 0,
"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",
"title": "Say Message Length After"
},
"UseVui": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.",
"name": "UseVui",
"title": "Use Vui"
},
"SpeechConfidenceThreshold": {
"minItems": 0,
"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",
"title": "Speech Confidence Threshold"
},
"FirstDigitTimeout": {
"minItems": 0,
"type": "integer",
"description": " The amount of time to wait (in milliseconds) for first digit when collecting touch tones.",
"name": "FirstDigitTimeout",
"title": "First Digit Timeout"
},
"AddressAfterRecord": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber will be prompted to address message before or after it is recorded.",
"name": "AddressAfterRecord",
"title": "Address After Record"
},
"MediaSwitchObjectId": {
"target_title": "DisplayName",
"description": "The name of the MediaSwitch object to be used for subscriber Telephone Record and Playback (TRAP) sessions and to dial MWI on or off requests when the CUC system has a dual switch integration.",
"title": "Phone System",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/PhoneSystem",
"type": "string",
"name": "MediaSwitchObjectId"
},
"ExitTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "ExitTargetConversation",
"title": "Exit Target Conversation"
},
"SendQuota": {
"minItems": 0,
"type": "integer",
"description": " The mailbox size (in bytes) send limit.",
"name": "SendQuota",
"title": "Send Quota"
},
"PartitionURI": {
"name": "PartitionURI",
"format": "uri",
"minItems": 0,
"title": "Partition URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UseBriefPrompts": {
"minItems": 0,
"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",
"title": "Use Brief Prompts"
},
"SkipPasswordForKnownDevice": {
"minItems": 0,
"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",
"title": "Skip Password For Known Device"
},
"MessageTypeMenu": {
"minItems": 0,
"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",
"title": "Message Type Menu"
},
"SkipReverseTime": {
"minItems": 0,
"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",
"title": "Skip Reverse Time"
},
"RouteNDRToSender": {
"minItems": 0,
"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",
"title": "Route NDR To Sender"
},
"templateAlias": {
"description": "Query parameter",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "Alias",
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/UserTemplate",
"title": "Template Alias",
"type": [
"string"
],
"name": "templateAlias"
},
"SayTimestampBefore": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the timestamp before it plays back each for the subscriber.",
"name": "SayTimestampBefore",
"title": "Say Timestamp Before"
},
"SendReadReceipts": {
"description": " A flag indicating whether the mailbox created with this subscriber allows the system to send read receipts on its behalf.",
"title": "Send Read Receipts",
"minItems": 0,
"choices": [
[
0,
"Disable"
],
[
1,
"Enable"
]
],
"type": "integer",
"name": "SendReadReceipts"
},
"UserTemplateVideoServiceAccountsURI": {
"name": "UserTemplateVideoServiceAccountsURI",
"format": "uri",
"minItems": 0,
"title": "User Template Video Service Accounts URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AssistantRowsPerPage": {
"minItems": 0,
"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",
"title": "Assistant Rows Per Page"
},
"SayMsgNumberAfter": {
"minItems": 0,
"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",
"title": "Say Msg Number After"
},
"InboxAutoResolveMessageRecipients": {
"minItems": 0,
"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",
"title": "Inbox Auto Resolve Message Recipients"
},
"ForcedAuthorizationCode": {
"minItems": 0,
"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",
"title": "Forced Authorization Code"
},
"EnAltGreetPreventMsg": {
"minItems": 0,
"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",
"title": "En Alt Greet Prevent Msg"
},
"AutoAdvanceMsgs": {
"minItems": 0,
"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",
"title": "Auto Advance Msgs"
},
"EnAltGreetDontRingPhone": {
"minItems": 0,
"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",
"title": "En Alt Greet Dont Ring Phone"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"format": "uri",
"minItems": 0,
"title": "Voice Name URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnableMessageLocator": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the message locator feature is enabled for the subscriber.",
"name": "EnableMessageLocator",
"title": "Enable Message Locator"
},
"CreateSmtpProxyFromCorp": {
"minItems": 0,
"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",
"title": "Create Smtp Proxy From Corp"
},
"DisplayNameRule": {
"description": " The format for generating the user display name. ",
"title": "Display Name Rule",
"minItems": 0,
"choices": [
[
1,
"FirstLast"
],
[
2,
"LastFirst"
]
],
"type": "integer",
"name": "DisplayNameRule"
},
"IsSetForVmEnrollment": {
"minItems": 0,
"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",
"title": "Is Set For Vm Enrollment"
},
"CreationTime": {
"description": " The date and time the user account was created. ",
"title": "Creation Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CreationTime"
},
"DefaultUserTemplateURI": {
"readonly": true,
"type": "string",
"description": "The URI to change default usertemplate.",
"name": "DefaultUserTemplateURI",
"title": "Default User Template URI"
},
"ClockMode": {
"description": " The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.",
"title": "Clock Mode",
"minItems": 0,
"choices": [
[
0,
"SystemDefaultClock"
],
[
1,
"HourClock12"
],
[
2,
"HourClock24"
]
],
"type": "integer",
"name": "ClockMode"
},
"CosObjectId": {
"target_title": "DisplayName",
"description": "The name of the Class of Service object with which this user account is associated.",
"title": "Class of Service",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Cos/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Cos",
"type": "string",
"name": "CosObjectId"
},
"LdapCcmUserId": {
"minItems": 0,
"type": "string",
"description": " The userid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmUserId",
"title": "Ldap Ccm User Id"
},
"ConversationTui": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation the subscriber uses to set up, send, and retrieve messages.",
"name": "ConversationTui",
"title": "Conversation Tui"
},
"RingPrimaryPhoneFirst": {
"minItems": 0,
"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",
"title": "Ring Primary Phone First"
},
"PostalCode": {
"minItems": 0,
"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",
"title": "Postal Code"
},
"XferString": {
"minItems": 0,
"type": "string",
"description": " The alternate transfer option. If null the primary dtmf id will be used.",
"name": "XferString",
"title": "Xfer String"
},
"ConfirmationConfidenceThreshold": {
"minItems": 0,
"type": "integer",
"description": " Voice Recognition Confirmation Confidence Threshold",
"name": "ConfirmationConfidenceThreshold",
"title": "Confirmation Confidence Threshold"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"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.",
"name": "Undeletable",
"title": "Undeletable"
},
"DelayAfterGreeting": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting.",
"name": "DelayAfterGreeting",
"title": "Delay After Greeting"
},
"EncryptPrivateMessages": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection encrypts messages from the subscriber that are marked private.",
"name": "EncryptPrivateMessages",
"title": "Encrypt Private Messages"
},
"UserTemplateNotificationDeviceURI": {
"readonly": true,
"type": "string",
"description": "The URI to change NotificationDevices of the template.",
"name": "UserTemplateNotificationDeviceURI",
"title": "User Template Notification Device URI"
},
"SayTotalReceipts": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new receipts in the subscriber mailbox.",
"name": "SayTotalReceipts",
"title": "Say Total Receipts"
},
"NewMessageStackOrder": {
"minItems": 0,
"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",
"title": "New Message Stack Order"
},
"UserTemplateWebPasswordURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the web application password.",
"name": "UserTemplateWebPasswordURI",
"title": "User Template Web Password URI"
},
"UserTemplateVoicePinURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the voice mail pin of the template.",
"name": "UserTemplateVoicePinURI",
"title": "User Template Voice Pin URI"
},
"IsVmEnrolled": {
"minItems": 0,
"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",
"title": "Is Vm Enrolled"
},
"EnableTts": {
"minItems": 0,
"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",
"title": "Enable Tts"
},
"MailboxStoreObjectId": {
"target_title": "DisplayName",
"description": "The name of the MailboxStore object where a mailbox is created for a new subscriber created with this template.",
"title": "Mailbox Store",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/MailboxStore",
"type": "string",
"name": "MailboxStoreObjectId"
},
"SearchByExtensionSearchSpaceObjectId": {
"target_title": "Name",
"description": "The name of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).",
"title": "Search By Extension Search Space",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/SearchSpace",
"type": "string",
"name": "SearchByExtensionSearchSpaceObjectId"
},
"PcaAddressBookRowsPerPage": {
"minItems": 0,
"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",
"title": "Pca Address Book Rows Per Page"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayDistributionList": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the distribution list that sends a message, if applicable.",
"name": "SayDistributionList",
"title": "Say Distribution List"
},
"City": {
"minItems": 0,
"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",
"title": "City"
},
"SendBroadcastMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber may send broadcast messages.",
"name": "SendBroadcastMsg",
"title": "Send Broadcast Msg"
},
"ExitAction": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "ExitAction",
"title": "Exit Action"
},
"VoiceNameRequired": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a recorded voice name is required for this subscriber.",
"name": "VoiceNameRequired",
"title": "Voice Name Required"
},
"ReceiveQuota": {
"minItems": 0,
"type": "integer",
"description": " The mailbox size (in bytes) receive limit.",
"name": "ReceiveQuota",
"title": "Receive Quota"
},
"SayTotalNewFax": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new fax messages in the subscriber mailbox.",
"name": "SayTotalNewFax",
"title": "Say Total New Fax"
},
"CallHandlerObjectId": {
"target_title": "DisplayName",
"description": "The name of the primary CallHandler object for the subscriber.",
"title": "Call Handler",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"type": "string",
"name": "CallHandlerObjectId"
},
"TimeZone": {
"minItems": 0,
"type": "integer",
"description": " The time zone to which this user account is associated.",
"name": "TimeZone",
"title": "Time Zone"
},
"SaySenderAfter": {
"minItems": 0,
"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",
"title": "Say Sender After"
},
"UseShortPollForCache": {
"minItems": 0,
"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",
"title": "Use Short Poll For Cache"
},
"NameConfirmation": {
"minItems": 0,
"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",
"title": "Name Confirmation"
},
"SearchByNameSearchSpaceURI": {
"name": "SearchByNameSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Search By Name Search Space URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnablePersonalRules": {
"minItems": 0,
"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",
"title": "Enable Personal Rules"
},
"ConfirmDeleteMessage": {
"minItems": 0,
"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",
"title": "Confirm Delete Message"
},
"SynchScheduleObjectId": {
"target_title": "DisplayName",
"description": "The name of the Schedule object to use for synchronization Calendar information from groupware (such as Exchange).",
"title": "Synch Schedule",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Schedule",
"type": "string",
"name": "SynchScheduleObjectId"
},
"Language": {
"minItems": 0,
"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",
"title": "Language"
},
"TemplateExternalServiceAccountsURI": {
"name": "TemplateExternalServiceAccountsURI",
"format": "uri",
"minItems": 0,
"title": "Template External Service Accounts URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"FaxServerURI": {
"name": "FaxServerURI",
"format": "uri",
"minItems": 0,
"title": "Fax Server URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallAnswerTimeout": {
"minItems": 0,
"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",
"title": "Call Answer Timeout"
},
"Volume": {
"minItems": 0,
"type": "integer",
"description": " The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message.",
"name": "Volume",
"title": "Volume"
},
"Address": {
"minItems": 0,
"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",
"title": "Address"
},
"InterdigitDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.",
"name": "InterdigitDelay",
"title": "Interdigit Delay"
},
"Speed": {
"minItems": 0,
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back messages to the subscriber.",
"name": "Speed",
"title": "Speed"
},
"CosURI": {
"name": "CosURI",
"format": "uri",
"minItems": 0,
"title": "Cos URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LocalizationKey": {
"type": "string",
"description": "Localization Key.",
"name": "LocalizationKey",
"title": "Localization Key"
},
"RetainUrgentMessageFlag": {
"minItems": 0,
"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",
"title": "Retain Urgent Message Flag"
},
"SayMessageLength": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.",
"name": "SayMessageLength",
"title": "Say Message Length"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"format": "uri",
"minItems": 0,
"title": "Callhandler URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayAltGreetWarning": {
"minItems": 0,
"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",
"title": "Say Alt Greet Warning"
},
"UserTemplateMessageActionURI": {
"readonly": true,
"type": "string",
"description": "The URI to change MessageAction of the template.",
"name": "UserTemplateMessageActionURI",
"title": "User Template Message Action URI"
},
"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,
"type": "integer",
"description": " The volume level for playback of system prompts.",
"name": "PromptVolume",
"title": "Prompt Volume"
},
"TenantObjectId": {
"target_attr": "ObjectId",
"description": "The name of the tenant to which the user belongs.",
"title": "Tenant",
"minItems": 0,
"format": "uri",
"choices": [],
"target_title": "Alias",
"target": "/api/device/cuc/Tenant/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Tenant",
"type": "string",
"name": "TenantObjectId"
},
"SayTotalDraftMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox",
"name": "SayTotalDraftMsg",
"title": "Say Total Draft Msg"
},
"SayTotalNew": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the total number of new messages in the subscriber mailbox.",
"name": "SayTotalNew",
"title": "Say Total New"
},
"SayTotalNewEmail": {
"minItems": 0,
"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",
"title": "Say Total New Email"
},
"UseDynamicNameSearchWeight": {
"minItems": 0,
"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",
"title": "Use Dynamic Name Search Weight"
},
"LdapCcmPkid": {
"minItems": 0,
"type": "string",
"description": " The pkid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmPkid",
"title": "Ldap Ccm Pkid"
},
"SendMessageOnHangup": {
"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.",
"title": "Send Message On Hangup",
"minItems": 0,
"choices": [
[
0,
"Discard"
],
[
1,
"Send"
],
[
2,
"Save"
]
],
"type": "integer",
"name": "SendMessageOnHangup"
},
"SayAniAfter": {
"minItems": 0,
"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",
"title": "Say Ani After"
},
"IsClockMode24Hour": {
"minItems": 0,
"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",
"title": "Is Clock Mode24Hour"
},
"MessageAgingPolicyObjectId": {
"target_title": "DisplayName",
"description": "The name of the MessageAgingPolicy object that applies to the mailbox created for a new subscriber created with this template.",
"title": "Message Aging Policy",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/MessageAgingPolicy/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/MessageAgingPolicy",
"type": "string",
"name": "MessageAgingPolicyObjectId"
},
"RecordUnknownCallerName": {
"minItems": 0,
"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",
"title": "Record Unknown Caller Name"
},
"Manager": {
"minItems": 0,
"type": "string",
"description": " The name of the person who is the manager or supervisor of the user.",
"name": "Manager",
"title": "Manager"
},
"BillingId": {
"minItems": 0,
"type": "string",
"description": " Accounting information or project code associated with this user.",
"name": "BillingId",
"title": "Billing Id"
},
"ListInDirectory": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.",
"name": "ListInDirectory",
"title": "List In Directory"
},
"DeletedMessageSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection presents deleted messages to the subscriber.",
"name": "DeletedMessageSortOrder",
"title": "Deleted Message Sort Order"
},
"SpeechSpeedVsAccuracy": {
"minItems": 0,
"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",
"title": "Speech Speed Vs Accuracy"
},
"UseDefaultLanguage": {
"minItems": 0,
"type": "boolean",
"description": "Set to true (1) if call handler is using default language from the location it belongs to.",
"name": "UseDefaultLanguage",
"title": "Use Default Language"
},
"SpeechIncompleteTimeout": {
"minItems": 0,
"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",
"title": "Speech Incomplete Timeout"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/UserTemplate/add/ |
|
The GUI Add form of device/cuc/UserTemplate as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cuc/UserTemplate | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cuc/UserTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/UserTemplate/[pkid1]", "/api/device/cuc/UserTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/UserTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/UserTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplate/[pkid1]", "/api/v0/device/cuc/UserTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplate |
|
{"hrefs": ["/api/device/cuc/UserTemplate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplate |
|
{"hrefs": ["/api/device/cuc/UserTemplate/[pkid1]", "/api/device/cuc/UserTemplate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/UserTemplate/export/ |
|
{ "hrefs":["/api/device/cuc/UserTemplate/[pkid1]", "/api/device/cuc/UserTemplate/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/UserTemplate and the JSON format can be used to import instances of device/cuc/UserTemplate.
GET http://[host-proxy]/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplate | POST | /api/device/cuc/UserTemplate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/UserTemplate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/UserTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/UserTemplate/ |
|
The device/cuc/UserTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/UserTemplate instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/UserTemplate/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cuc/UserTemplate/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/UserTemplate/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplate/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cuc/UserTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/UserTemplate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/UserTemplate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplate",
"model_specific_actions": [
"add",
"list",
"update",
"get",
"remove",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3aeb3cce894e001206bc0d",
"meta": {
"tags": [],
"cached": true,
"title": "Voice mail for AB_Group",
"business_key": {},
"schema_version": "11.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3aeb3cce894e001206bc0d",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3aeb3cce894e001206bc0d/?model_type=device/cuc/UserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3aeb3cce894e001206bc0d"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ExitTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"AddressMode": 0,
"CreationTime": "2020-08-17T20:40:29Z",
"UserTemplateRolesURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplateroles",
"SayTimestampAfter": true,
"GreetByName": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"SendQuota": -2,
"SpeechSensitivity": 50,
"LdapType": 0,
"SaveMessageOnHangup": false,
"EnableVisualMessageLocator": false,
"RepeatMenu": 1,
"SearchByExtensionSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"ConversationVui": "VuiStart",
"ObjectId": "acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"MessageAgingPolicyURI": "/vmrest/messageagingpolicies/06afe135-ba1b-4416-8084-b1bc735f2a6c",
"JumpToMessagesOnLogin": true,
"SaySender": true,
"URI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"MessageLocatorSortOrder": 1,
"UserTemplateNotificationDevicesURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatenotificationdevices",
"ConfirmDeleteDeletedMessage": false,
"EnableSaveDraft": false,
"CantChange": false,
"ExitCallActionObjectId": "75668173-fe33-436e-8bb3-1732dc39c55d",
"SayMsgNumber": true,
"SayTotalNewVoice": true,
"ReadOnly": false,
"SaySenderExtension": false,
"SavedMessageStackOrder": "1234567",
"SaySenderExtensionAfter": false,
"DisplayName": "Voice mail for AB_Group",
"InboxAutoRefresh": 15,
"UseDefaultTimeZone": true,
"WarningQuota": -2,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"hierarchy_friendly_name": "AB_Group (Customer)",
"SearchByNameSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"DoesntExpire": false,
"AnnounceUpcomingMeetings": 60,
"SayAni": false,
"NewMessageSortOrder": 1,
"NotificationType": 0,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"PromptSpeed": 100,
"EnAltGreetPreventSkip": false,
"ContinuousAddMode": false,
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ConfirmDeleteMultipleMessages": true,
"EnableMessageBookmark": false,
"InboxMessagesPerPage": 20,
"UpdateBroadcastMsg": false,
"SayCopiedNames": true,
"SpeechCompleteTimeout": 0,
"IsVmEnrolled": true,
"SayMessageLengthAfter": false,
"UseVui": false,
"SpeechConfidenceThreshold": 40,
"FirstDigitTimeout": 5000,
"AddressAfterRecord": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"ExitTargetConversation": "PHGreeting",
"SavedMessageSortOrder": 2,
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"UseBriefPrompts": false,
"SkipPasswordForKnownDevice": false,
"MessageTypeMenu": false,
"SkipReverseTime": 5000,
"RouteNDRToSender": true,
"SayTimestampBefore": false,
"SendReadReceipts": 1,
"UserTemplateVideoServiceAccountsURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatevideoserviceaccounts",
"AssistantRowsPerPage": 5,
"SayMsgNumberAfter": false,
"InboxAutoResolveMessageRecipients": true,
"EnAltGreetPreventMsg": false,
"AutoAdvanceMsgs": false,
"EnAltGreetDontRingPhone": false,
"templateAlias": "voicemailusertemplate",
"EnableMessageLocator": false,
"CreateSmtpProxyFromCorp": false,
"DisplayNameRule": 1,
"IsSetForVmEnrollment": true,
"DefaultUserTemplateURI": "/vmrest/defaultusertemplates",
"ClockMode": 0,
"RetainUrgentMessageFlag": false,
"ConversationTui": "SubMenu",
"RingPrimaryPhoneFirst": false,
"ConfirmationConfidenceThreshold": 60,
"Undeletable": false,
"EncryptPrivateMessages": false,
"SayTotalReceipts": false,
"NewMessageStackOrder": "1234567",
"UserTemplateWebPasswordURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/password",
"UserTemplateVoicePinURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/pin",
"SkipForwardTime": 5000,
"EnableTts": true,
"MailboxStoreObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804",
"SearchByExtensionSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"PcaAddressBookRowsPerPage": 5,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"SayDistributionList": true,
"SendBroadcastMsg": false,
"ExitAction": 2,
"VoiceNameRequired": false,
"ReceiveQuota": -2,
"SayTotalNewFax": false,
"CallHandlerObjectId": "eefc6142-1e31-4b51-95be-98fc2e36feb6",
"TimeZone": 140,
"NameConfirmation": false,
"UseShortPollForCache": false,
"SaySenderAfter": false,
"CommandDigitTimeout": 1500,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"SearchByNameSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"EnablePersonalRules": true,
"ConfirmDeleteMessage": false,
"Language": 1033,
"RecordUnknownCallerName": true,
"CallAnswerTimeout": 4,
"Volume": 50,
"SayTotalSaved": true,
"InterdigitDelay": 3000,
"CosURI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"CosObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"SayMessageLength": false,
"CallhandlerURI": "/vmrest/callhandlerprimarytemplates/eefc6142-1e31-4b51-95be-98fc2e36feb6",
"SayAltGreetWarning": false,
"UserTemplateMessageActionURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatemessageactions",
"Alias": "Cu1-BasicVoiceMail-UT",
"PromptVolume": 50,
"SayTotalDraftMsg": false,
"SayTotalNew": false,
"SayTotalNewEmail": false,
"SpeechIncompleteTimeout": 750,
"UseDynamicNameSearchWeight": false,
"SendMessageOnHangup": 1,
"SayAniAfter": false,
"IsClockMode24Hour": false,
"MessageAgingPolicyObjectId": "06afe135-ba1b-4416-8084-b1bc735f2a6c",
"TemplateExternalServiceAccountsURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/templateexternalserviceaccounts",
"ListInDirectory": true,
"DeletedMessageSortOrder": 2,
"SpeechSpeedVsAccuracy": 50,
"UseDefaultLanguage": true,
"Speed": 100
}
},
{
"pkid": "5f3ae7e8ce894e001205b866",
"meta": {
"tags": [],
"cached": true,
"title": "Voice Mail User Template",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae7e8ce894e001205b866",
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae7e8ce894e001205b866/?model_type=device/cuc/UserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/UserTemplate/5f3ae7e8ce894e001205b866/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/UserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae7e8ce894e001205b866"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ExitTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"AddressMode": 0,
"CreationTime": "2018-02-15T15:05:49Z",
"UserTemplateRolesURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplateroles",
"SayTimestampAfter": true,
"GreetByName": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"SavedMessageSortOrder": 2,
"SpeechSensitivity": 50,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"SaveMessageOnHangup": false,
"EnableVisualMessageLocator": false,
"RepeatMenu": 1,
"SearchByExtensionSearchSpaceURI": "/vmrest/searchspaces/74b4757d-3e96-4776-8749-037c094a6d3c",
"ConversationVui": "VuiStart",
"ObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"MessageAgingPolicyURI": "/vmrest/messageagingpolicies/06afe135-ba1b-4416-8084-b1bc735f2a6c",
"JumpToMessagesOnLogin": true,
"SaySender": true,
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813",
"PromptSpeed": 100,
"UserTemplateNotificationDevicesURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatenotificationdevices",
"ConfirmDeleteDeletedMessage": false,
"EnableSaveDraft": false,
"CantChange": false,
"ExitCallActionObjectId": "f7a37b72-9e79-447a-84df-00ca6625f8c7",
"SayMsgNumber": true,
"SayTotalNewVoice": true,
"ReadOnly": false,
"SaySenderExtension": false,
"SavedMessageStackOrder": "1234567",
"SaySenderExtensionAfter": false,
"MessageAgingPolicyObjectId": "06afe135-ba1b-4416-8084-b1bc735f2a6c",
"DisplayName": "Voice Mail User Template",
"InboxAutoRefresh": 15,
"UseDefaultTimeZone": true,
"WarningQuota": -2,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"hierarchy_friendly_name": "AB_Group (Customer)",
"DoesntExpire": false,
"AnnounceUpcomingMeetings": 60,
"SayAni": false,
"NewMessageSortOrder": 1,
"NotificationType": 0,
"LdapType": 0,
"MessageLocatorSortOrder": 1,
"EnAltGreetPreventSkip": false,
"ContinuousAddMode": false,
"AssistantRowsPerPage": 5,
"ConfirmDeleteMultipleMessages": true,
"EnableMessageBookmark": false,
"InboxMessagesPerPage": 20,
"UpdateBroadcastMsg": false,
"SayCopiedNames": true,
"InboxAutoResolveMessageRecipients": true,
"IsVmEnrolled": true,
"SayMessageLengthAfter": false,
"UseVui": false,
"SpeechConfidenceThreshold": 40,
"FirstDigitTimeout": 5000,
"AddressAfterRecord": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"ExitTargetConversation": "PHGreeting",
"SendQuota": -2,
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"UseBriefPrompts": false,
"SkipPasswordForKnownDevice": false,
"MessageTypeMenu": false,
"SkipReverseTime": 5000,
"RouteNDRToSender": true,
"InterdigitDelay": 3000,
"SayTimestampBefore": false,
"SendReadReceipts": 1,
"UserTemplateVideoServiceAccountsURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatevideoserviceaccounts",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"SayMsgNumberAfter": false,
"SpeechCompleteTimeout": 0,
"EnAltGreetPreventMsg": false,
"AutoAdvanceMsgs": false,
"EnAltGreetDontRingPhone": false,
"EnableMessageLocator": false,
"CreateSmtpProxyFromCorp": false,
"DisplayNameRule": 1,
"IsSetForVmEnrollment": true,
"DefaultUserTemplateURI": "/vmrest/defaultusertemplates",
"ClockMode": 0,
"RetainUrgentMessageFlag": false,
"ConversationTui": "SubMenu",
"RingPrimaryPhoneFirst": false,
"ConfirmationConfidenceThreshold": 60,
"Undeletable": true,
"EncryptPrivateMessages": false,
"SayTotalReceipts": false,
"NewMessageStackOrder": "1234567",
"UserTemplateWebPasswordURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/credential/password",
"UserTemplateVoicePinURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/credential/pin",
"SkipForwardTime": 5000,
"EnableTts": true,
"MailboxStoreObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804",
"SearchByExtensionSearchSpaceObjectId": "74b4757d-3e96-4776-8749-037c094a6d3c",
"PcaAddressBookRowsPerPage": 5,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"SayDistributionList": true,
"SendBroadcastMsg": false,
"ExitAction": 2,
"VoiceNameRequired": false,
"SayTotalNewFax": false,
"CallHandlerObjectId": "0fb417df-beed-49dd-860f-0032a8ddea18",
"TimeZone": 140,
"NameConfirmation": false,
"SaySenderAfter": false,
"CommandDigitTimeout": 1500,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"SearchByNameSearchSpaceURI": "/vmrest/searchspaces/74b4757d-3e96-4776-8749-037c094a6d3c",
"EnablePersonalRules": true,
"ConfirmDeleteMessage": false,
"Language": 1033,
"RecordUnknownCallerName": true,
"CallAnswerTimeout": 4,
"Volume": 50,
"SayTotalSaved": true,
"ReceiveQuota": -2,
"Speed": 100,
"CosURI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"CosObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"SayMessageLength": false,
"ListInDirectory": true,
"CallhandlerURI": "/vmrest/callhandlerprimarytemplates/0fb417df-beed-49dd-860f-0032a8ddea18",
"SayAltGreetWarning": false,
"UserTemplateMessageActionURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/usertemplatemessageactions",
"Alias": "voicemailusertemplate",
"PromptVolume": 50,
"SayTotalDraftMsg": false,
"SayTotalNew": false,
"SayTotalNewEmail": false,
"UseDynamicNameSearchWeight": false,
"SendMessageOnHangup": 1,
"SayAniAfter": false,
"IsClockMode24Hour": false,
"UseShortPollForCache": false,
"TemplateExternalServiceAccountsURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/templateexternalserviceaccounts",
"SearchByNameSearchSpaceObjectId": "74b4757d-3e96-4776-8749-037c094a6d3c",
"DeletedMessageSortOrder": 2,
"SpeechSpeedVsAccuracy": 50,
"UseDefaultLanguage": true,
"SpeechIncompleteTimeout": 750
}
}
]
}
(Show the first instance)
{
"pkid": "5f3aeb3cce894e001206bc0d",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Voice mail for AB_Group",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3aeb3cce894e001206bc0d",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3aeb3cce894e001206bc0d/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/UserTemplate/5f3aeb3cce894e001206bc0d/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/UserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3aeb3cce894e001206bc0d"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ExitTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"AddressMode": 0,
"CreationTime": "2020-08-17T20:40:29Z",
"UserTemplateRolesURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplateroles",
"SayTimestampAfter": true,
"GreetByName": true,
"SendQuota": -2,
"SpeechSensitivity": 50,
"LdapType": 0,
"SaveMessageOnHangup": false,
"EnableVisualMessageLocator": false,
"RepeatMenu": 1,
"SearchByExtensionSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"ConversationVui": "VuiStart",
"ObjectId": "acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"MessageAgingPolicyURI": "/vmrest/messageagingpolicies/06afe135-ba1b-4416-8084-b1bc735f2a6c",
"JumpToMessagesOnLogin": true,
"SaySender": true,
"URI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"MessageLocatorSortOrder": 1,
"UserTemplateNotificationDevicesURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatenotificationdevices",
"ConfirmDeleteDeletedMessage": false,
"EnableSaveDraft": false,
"CantChange": false,
"ExitCallActionObjectId": "75668173-fe33-436e-8bb3-1732dc39c55d",
"SayMsgNumber": true,
"SayTotalNewVoice": true,
"ReadOnly": false,
"SaySenderExtension": false,
"SavedMessageStackOrder": "1234567",
"SaySenderExtensionAfter": false,
"DisplayName": "Voice mail for AB_Group",
"InboxAutoRefresh": 15,
"UseDefaultTimeZone": true,
"WarningQuota": -2,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"SearchByNameSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"DoesntExpire": false,
"AnnounceUpcomingMeetings": 60,
"SayAni": false,
"NewMessageSortOrder": 1,
"NotificationType": 0,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"PromptSpeed": 100,
"EnAltGreetPreventSkip": false,
"ContinuousAddMode": false,
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ConfirmDeleteMultipleMessages": true,
"EnableMessageBookmark": false,
"InboxMessagesPerPage": 20,
"UpdateBroadcastMsg": false,
"SayCopiedNames": true,
"InboxAutoResolveMessageRecipients": true,
"IsVmEnrolled": true,
"SayMessageLengthAfter": false,
"UseVui": false,
"SpeechConfidenceThreshold": 40,
"FirstDigitTimeout": 5000,
"AddressAfterRecord": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"ExitTargetConversation": "PHGreeting",
"SavedMessageSortOrder": 2,
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"UseBriefPrompts": false,
"SkipPasswordForKnownDevice": false,
"MessageTypeMenu": false,
"SkipReverseTime": 5000,
"RouteNDRToSender": true,
"SayTimestampBefore": false,
"SendReadReceipts": 1,
"UserTemplateVideoServiceAccountsURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatevideoserviceaccounts",
"AssistantRowsPerPage": 5,
"SayMsgNumberAfter": false,
"SpeechCompleteTimeout": 0,
"EnAltGreetPreventMsg": false,
"AutoAdvanceMsgs": false,
"EnAltGreetDontRingPhone": false,
"templateAlias": "voicemailusertemplate",
"EnableMessageLocator": false,
"CreateSmtpProxyFromCorp": false,
"DisplayNameRule": 1,
"IsSetForVmEnrollment": true,
"DefaultUserTemplateURI": "/vmrest/defaultusertemplates",
"ClockMode": 0,
"CosObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"ConversationTui": "SubMenu",
"RingPrimaryPhoneFirst": false,
"ConfirmationConfidenceThreshold": 60,
"Undeletable": false,
"EncryptPrivateMessages": false,
"SayTotalReceipts": false,
"NewMessageStackOrder": "1234567",
"UserTemplateWebPasswordURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/password",
"UserTemplateVoicePinURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/pin",
"SkipForwardTime": 5000,
"EnableTts": true,
"MailboxStoreObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804",
"SearchByExtensionSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"PcaAddressBookRowsPerPage": 5,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"SayDistributionList": true,
"SendBroadcastMsg": false,
"ExitAction": 2,
"VoiceNameRequired": false,
"ReceiveQuota": -2,
"SayTotalNewFax": false,
"CallHandlerObjectId": "eefc6142-1e31-4b51-95be-98fc2e36feb6",
"TimeZone": 140,
"NameConfirmation": false,
"UseShortPollForCache": false,
"SaySenderAfter": false,
"CommandDigitTimeout": 1500,
"SearchByNameSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"EnablePersonalRules": true,
"ConfirmDeleteMessage": false,
"Language": 1033,
"RecordUnknownCallerName": true,
"CallAnswerTimeout": 4,
"Volume": 50,
"SayTotalSaved": true,
"InterdigitDelay": 3000,
"CosURI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"RetainUrgentMessageFlag": false,
"SayMessageLength": false,
"CallhandlerURI": "/vmrest/callhandlerprimarytemplates/eefc6142-1e31-4b51-95be-98fc2e36feb6",
"SayAltGreetWarning": false,
"UserTemplateMessageActionURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/usertemplatemessageactions",
"Alias": "Cu1-BasicVoiceMail-UT",
"PromptVolume": 50,
"SayTotalDraftMsg": false,
"SayTotalNew": false,
"SayTotalNewEmail": false,
"SpeechIncompleteTimeout": 750,
"UseDynamicNameSearchWeight": false,
"SendMessageOnHangup": 1,
"SayAniAfter": false,
"IsClockMode24Hour": false,
"MessageAgingPolicyObjectId": "06afe135-ba1b-4416-8084-b1bc735f2a6c",
"TemplateExternalServiceAccountsURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/templateexternalserviceaccounts",
"ListInDirectory": true,
"DeletedMessageSortOrder": 2,
"SpeechSpeedVsAccuracy": 50,
"UseDefaultLanguage": true,
"Speed": 100
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/UserTemplate. | GET | /api/device/cuc/UserTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/UserTemplate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/UserTemplate/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/UserTemplate/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/UserTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/UserTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplate | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/UserTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/UserTemplate/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cuc/UserTemplate and the JSON format can be used to import instances of device/cuc/UserTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/UserTemplate/[pkid] | hierarchy=[hierarchy] | The device/cuc/UserTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/UserTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/UserTemplate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplate/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |