[Index]
Model ref.: relation/GS_HuntGroupVoicemail_MWI_Rel
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": {
"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",
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"choices": []
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"choices": []
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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",
"type": "string",
"target": "/api/device/cuc/FaxServer/choices/?choice_title=FaxServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/FaxServer",
"choices": []
},
"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,
"type": "string",
"target": "/api/device/cuc/Location/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Location",
"choices": []
},
"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"
},
"PrivateListsURI": {
"name": "PrivateListsURI",
"title": "Private Lists URI",
"minItems": 0,
"format": "uri",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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"
},
"EnableMessageBookmark": {
"minItems": 0,
"title": "Enable Message Bookmark",
"type": "boolean",
"description": " A flag indicating whether Message Bookmark is enabled for the subscriber",
"name": "EnableMessageBookmark"
},
"InboxMessagesPerPage": {
"minItems": 0,
"title": "Inbox Messages Per Page",
"type": "integer",
"description": " The number of messages Unity Inbox displays in a page.",
"name": "InboxMessagesPerPage"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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",
"type": "string",
"target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/PhoneSystem",
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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",
"type": "string",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Partition",
"choices": []
},
"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"
},
"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"
},
"templateAlias": {
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Template Alias",
"format": "uri",
"required": false,
"name": "templateAlias",
"target_attr": "Alias",
"type": [
"string"
],
"description": "Query parameter",
"target_model_type": "device/cuc/UserTemplate",
"choices": []
},
"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"
},
"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",
"type": "string",
"target": "/api/device/cuc/Cos/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Cos",
"choices": []
},
"LdapCcmUserId": {
"minItems": 0,
"title": "Ldap Ccm User Id",
"type": "string",
"description": " The userid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmUserId"
},
"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"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"MailboxStoreObjectId": {
"target_attr": "ObjectId",
"target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"name": "MailboxStoreObjectId",
"target_title": "DisplayName",
"title": "Mailbox Store",
"type": "string",
"description": "Mailbox Store for the tenant.",
"target_model_type": "device/cuc/MailboxStore",
"choices": []
},
"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",
"type": "string",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/SearchSpace",
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"type": "string",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Callhandler",
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"type": "string",
"target": "/api/device/cuc/Schedule/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Schedule",
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"title": "Callhandler URI",
"minItems": 0,
"format": "uri",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"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"
},
"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,
"type": "string",
"target": "/api/device/cuc/Tenant/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Tenant",
"choices": []
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"DialablePhoneNumber": {
"minItems": 0,
"title": "Dialable Phone Number",
"type": "string",
"description": " A dialable version of the PhoneNumber column.",
"name": "DialablePhoneNumber"
},
"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",
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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",
"type": "string",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/SearchSpace",
"choices": []
},
"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"
},
"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"
},
"Speed": {
"minItems": 0,
"title": "Speed",
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back messages to the subscriber.",
"name": "Speed"
},
"cucMwi": {
"title": "Cuc Mwi",
"type": "array",
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " The unique text name of this notification MWI to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Office Phone\" or \" Lab Phone.\" ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationMwi object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MwiOn": {
"minItems": 0,
"title": "Mwi On",
"type": "boolean",
"description": " A flag indicating whether the MWI is on or off. This is the state of the MWI from the perspective of Cisco Unity Connection.",
"name": "MwiOn"
},
"IncludeVoiceMessages": {
"minItems": 0,
"title": "Include Voice Messages",
"type": "boolean",
"description": " A flag indicating whether the MWI should be set for a voice message.",
"name": "IncludeVoiceMessages"
},
"IncludeFaxMessages": {
"minItems": 0,
"title": "Include Fax Messages",
"type": "boolean",
"description": " A flag indicating whether the MWI should be set for a FAX message.",
"name": "IncludeFaxMessages"
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"UserURI": {
"minItems": 0,
"title": "User URI",
"type": "string",
"name": "UserURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"UsePrimaryExtension": {
"minItems": 0,
"title": "Use Primary Extension",
"type": "boolean",
"description": "If set to true (1), the subscriber's primary extension is used (and will be the value contained in MwiExtension)",
"name": "UsePrimaryExtension"
},
"PhoneSystemURI": {
"minItems": 0,
"title": "Phone System URI",
"type": "string",
"name": "PhoneSystemURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"PortURI": {
"minItems": 0,
"title": "Port URI",
"type": "string",
"name": "PortURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "SubscriberObjectId",
"target_attr": "ObjectId",
"title": "Subscriber Object Id",
"type": [
"string"
],
"description": " The unique identifier of the Subscriber object to which this MWI belongs. - template parameter [1]",
"target_model_type": "device/cuc/User",
"choices": []
},
"MwiExtension": {
"description": " The phone number (extension) of the MWI to activate.",
"title": "Mwi Extension",
"minItems": 0,
"required": true,
"type": "string",
"name": "MwiExtension"
},
"MediaSwitchDisplayName": {
"minItems": 0,
"title": "Media Switch Display Name",
"type": "string",
"description": "The text name of the Media Switch.",
"name": "MediaSwitchDisplayName"
},
"MediaPortObjectId": {
"minItems": 0,
"title": "Media Port Object Id",
"type": "string",
"description": " The unique identifier of the MediaPort object Cisco Unity Connection uses to set MWI.",
"name": "MediaPortObjectId"
},
"IncludeTextMessages": {
"minItems": 0,
"title": "Include Text Messages",
"type": "boolean",
"description": " A flag indicating whether the MWI should be set for a text message.",
"name": "IncludeTextMessages"
},
"MediaSwitchObjectId": {
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "MediaSwitchObjectId",
"target_attr": "ObjectId",
"title": "Media Switch Object Id",
"type": [
"string"
],
"description": " The unique identifier of the MediaSwitch object to use for activating/deactivating the MWI.",
"target_model_type": "device/cuc/PhoneSystem",
"choices": []
},
"Active": {
"minItems": 0,
"title": "Active",
"type": "boolean",
"description": " Is this active?",
"name": "Active"
}
}
}
},
"hgData": {
"title": "Hg Data",
"type": "array",
"items": {
"type": "object",
"properties": {
"huntListName": {
"type": "string",
"title": "Hunt List"
},
"HgPilot": {
"type": "string",
"title": "Hunt Group Pilot"
},
"searchScope": {
"type": "string",
"title": "Search Scope"
},
"cos": {
"type": "string",
"title": "Class Of Service"
},
"phoneSystem": {
"type": "string",
"title": "Phone System"
},
"voicemailPilot": {
"type": "string",
"title": "Voicemail Pilot"
},
"cucUserOid": {
"type": "string",
"title": "CUC User OID"
},
"pin": {
"is_password": true,
"type": "string",
"title": "Mailbox PIN"
},
"autoUpdate": {
"type": "boolean",
"description": "If set, MWI members will be synced with Line Group members",
"title": "Automatically update MWI members"
},
"autoAlternateExt": {
"type": "boolean",
"description": "If set, alternate extensions will be synced with Line Group members or MWI Members",
"title": "Automatically update alternate extensions"
},
"syncAlternateExtToMwi": {
"type": "boolean",
"description": "If set, alternate extensions will be synced with MWI Members. If not set, alternate extensions will be synced with Line Group Members. If MWI's are synced to the line group, alternate extensions can only be synced to the line group or manually managed",
"title": "Sync Alternate Extensions with MWI"
},
"message": {
"type": "string",
"title": "Status"
},
"hnType": {
"type": "string",
"title": "Hierarchy Node Type"
},
"cucBkey": {
"type": "string",
"title": "CUC Cluster"
},
"cucmBkey": {
"type": "string",
"title": "CUCM Cluster"
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/GS_HuntGroupVoicemail_MWI_Rel | POST | /api/relation/GS_HuntGroupVoicemail_MWI_Rel/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/GS_HuntGroupVoicemail_MWI_Rel/ |
|
The relation/GS_HuntGroupVoicemail_MWI_Rel schema and all instances as JSON. |
(The list will return 0 to 3 relation/GS_HuntGroupVoicemail_MWI_Rel instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 119,
"total_limit": null,
"order_by": "Alias",
"direction": "asc",
"current": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/?skip=0&limit=3&order_by=Alias&direction=asc&traversal=down"
},
"operations": [
"configuration_template",
"export_bulkload_template",
"bulk_update",
"add",
"update",
"help",
"remove",
"list",
"export",
"get",
"field_display_policy"
],
"meta": {
"model_type": "relation/GS_HuntGroupVoicemail_MWI_Rel",
"summary_attrs": [
{
"name": "Alias",
"title": "Alias"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "EmailAddress",
"title": "Email Address"
},
{
"name": "TimeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"add",
"update",
"remove",
"list",
"get",
"export_bulkload_template",
"export"
],
"schema_version": null,
"actions": [
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": [
{
"data": {
"DisplayName": "PatchBundle 02",
"VoiceNameRequired": false,
"FirstName": "PatchBundle",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20593b4c84-5075-4a1a-8c71-5481a43874a9)",
"LastName": "02",
"MessageHandlersURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/messagehandlers",
"CreationTime": "2018-10-22T12:06:47Z",
"CallHandlerObjectId": "8ad83256-bbd3-495a-9ebf-b8fefcf3e5f3",
"PhoneSystemURI": "/vmrest/phonesystems/e53d7010-0053-469d-bae1-c8b1c584f3cb",
"TimeZone": 140,
"PartitionURI": "/vmrest/partitions/5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"PartitionObjectId": "5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"Language": 1033,
"MailboxStoreName": "Unity Messaging Database -1",
"LocationObjectId": "42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"ExternalServiceAccountsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/externalserviceaccounts",
"UserRoleURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/userroles",
"CosURI": "/vmrest/coses/a1170324-ca86-4570-8519-90f2cddf0a68",
"UserMailboxURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/mailboxattributes",
"ObjectId": "593b4c84-5075-4a1a-8c71-5481a43874a9",
"PrivateListsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/privatelists",
"CallhandlerURI": "/vmrest/handlers/callhandlers/8ad83256-bbd3-495a-9ebf-b8fefcf3e5f3",
"CosObjectId": "a1170324-ca86-4570-8519-90f2cddf0a68",
"URI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9",
"Alias": "18.1.2",
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20593b4c84-5075-4a1a-8c71-5481a43874a9)",
"UserVoicePinURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/credential/pin",
"MwisURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/mwis",
"UserWebPasswordURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/credential/password",
"VideoServiceAccountsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/videoserviceaccounts",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/notificationdevices",
"AlternateExtensionsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/alternateextensions",
"DtmfAccessId": "8211232",
"EmailAddress": "patchbundle02@ab_group.com",
"ListInDirectory": true,
"MediaSwitchObjectId": "e53d7010-0053-469d-bae1-c8b1c584f3cb",
"LocationURI": "/vmrest/locations/connectionlocations/42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"summary_device": "Dedicated CUCxn, 192.168.100.24, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "CL1-AB-C-Berlin (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Berlin"
},
"meta": {
"model_type": "relation/GS_HuntGroupVoicemail_MWI_Rel",
"summary_attrs": [
{
"name": "Alias",
"title": "Alias"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "EmailAddress",
"title": "Email Address"
},
{
"name": "TimeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "18.1.2",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5a86cde9939cd122e185c871",
"pkid": "5a86cde9939cd122e185c871"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a86d2bb67ea6f2039948528",
"href": "/api/data/HierarchyNode/5a86d2bb67ea6f2039948528"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/",
"pkid": "5bcdbd4e142896c1be0aff07"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86704db12a1c20228be944",
"5a86cc291360b6206c49e71e",
"5a86cee1939cd122e185cb08",
"5a86d2bb67ea6f2039948528",
"5bcdbd4e142896c1be0aff07"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5bcdbd4e142896c1be0aff07"
},
{
"data": {
"City": "",
"DisplayName": "Andy Cain",
"VoiceNameRequired": false,
"FirstName": "Andy",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20ca320e6a-9a0c-4860-9297-5059130ee3c2)",
"LastName": "",
"MessageHandlersURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/messagehandlers",
"CreationTime": "2018-02-16T12:08:13Z",
"CallHandlerObjectId": "cad93d9b-c54f-402a-bb3e-5f881564881e",
"PhoneSystemURI": "/vmrest/phonesystems/e441fb60-f19b-4591-bfbf-34902ff04262",
"TimeZone": 140,
"Department": "Engineering",
"PartitionURI": "/vmrest/partitions/7d55dbb4-3661-4f96-b7d4-6305650c59e3",
"PrivateListsURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/privatelists",
"Language": 1033,
"MailboxStoreName": "Unity Messaging Database -1",
"LocationObjectId": "8af86e8c-1c25-4af7-9dc3-5368fc70166f",
"ExternalServiceAccountsURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/externalserviceaccounts",
"UserRoleURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/userroles",
"CosURI": "/vmrest/coses/0293d572-d0e4-458d-8e56-c3dfd8d2173e",
"UserMailboxURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/mailboxattributes",
"ObjectId": "ca320e6a-9a0c-4860-9297-5059130ee3c2",
"PartitionObjectId": "7d55dbb4-3661-4f96-b7d4-6305650c59e3",
"CallhandlerURI": "/vmrest/handlers/callhandlers/cad93d9b-c54f-402a-bb3e-5f881564881e",
"CosObjectId": "0293d572-d0e4-458d-8e56-c3dfd8d2173e",
"URI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2",
"Alias": "acain04",
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20ca320e6a-9a0c-4860-9297-5059130ee3c2)",
"UserVoicePinURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/credential/pin",
"MwisURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/mwis",
"UserWebPasswordURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/credential/password",
"VideoServiceAccountsURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/videoserviceaccounts",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/notificationdevices",
"AlternateExtensionsURI": "/vmrest/users/ca320e6a-9a0c-4860-9297-5059130ee3c2/alternateextensions",
"DtmfAccessId": "50401",
"EmailAddress": "acain04@aaaglobal.net",
"ListInDirectory": true,
"MediaSwitchObjectId": "e441fb60-f19b-4591-bfbf-34902ff04262",
"LocationURI": "/vmrest/locations/connectionlocations/8af86e8c-1c25-4af7-9dc3-5368fc70166f",
"summary_device": "Partitioned CUCxn, 192.168.100.23, 8443, hcs.CS-P",
"hierarchy_friendly_name": "AAA-Boston (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston"
},
"meta": {
"model_type": "relation/GS_HuntGroupVoicemail_MWI_Rel",
"summary_attrs": [
{
"name": "Alias",
"title": "Alias"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "EmailAddress",
"title": "Email Address"
},
{
"name": "TimeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "acain04",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5a86738067ea6f20399339ad",
"pkid": "5a86738067ea6f20399339ad"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a86743967ea6f2039933bc1",
"href": "/api/data/HierarchyNode/5a86743967ea6f2039933bc1"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a86c9ab939cd122e185a824/",
"pkid": "5a86c9ab939cd122e185a824"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86702067ea6f203993285d",
"5a8673030085ec1f7f30e906",
"5a86743967ea6f2039933bc1",
"5a86c9ab939cd122e185a824"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a86c9ab939cd122e185a824/",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a86c9ab939cd122e185a824/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5a86c9ab939cd122e185a824"
},
{
"data": {
"ExitTargetHandlerObjectId": "bd456062-5955-4e66-98dc-d52a5d8ee548",
"Title": "VIP_Worker",
"AddressMode": 0,
"RingPrimaryPhoneFirst": false,
"CommandDigitTimeout": 1500,
"SayTimestampAfter": true,
"Department": "Finance",
"GreetByName": true,
"SavedMessageSortOrder": 2,
"SpeechSensitivity": 50,
"LdapType": 3,
"ExternalServiceAccountsURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/externalserviceaccounts",
"SaveMessageOnHangup": false,
"EnableVisualMessageLocator": false,
"RepeatMenu": 1,
"UserMailboxURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/mailboxattributes",
"ConversationVui": "VuiStart",
"ObjectId": "5e922c40-0cf1-4b51-873e-77fe9881a4ea",
"CreationTime": "2018-02-18 11:33:09.41",
"JumpToMessagesOnLogin": true,
"SaySender": true,
"URI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea",
"MessageLocatorSortOrder": 1,
"SynchScheduleURI": "/vmrest/schedules/e67855a6-e60e-4ebb-a494-5d5cf2820819",
"ConfirmDeleteDeletedMessage": false,
"EnableSaveDraft": false,
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%205e922c40-0cf1-4b51-873e-77fe9881a4ea)",
"ExitCallActionObjectId": "5ba89c2d-64a8-4c4f-b0cc-792e9de0b372",
"SayMsgNumber": true,
"SayTotalNewVoice": true,
"ReadOnly": false,
"SaySenderExtension": false,
"SavedMessageStackOrder": "1234567",
"SaySenderExtensionAfter": false,
"DisplayName": "Andy Carstel",
"InboxAutoRefresh": 15,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/e53d7010-0053-469d-bae1-c8b1c584f3cb",
"AnnounceUpcomingMeetings": 60,
"MailboxStoreName": "Unity Messaging Database -1",
"SayAni": false,
"NewMessageSortOrder": 1,
"DtmfNameLast": "2277835",
"LocationObjectId": "42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"DtmfNameFirst": "2639",
"PromptSpeed": 100,
"EnAltGreetPreventSkip": false,
"ContinuousAddMode": false,
"PrivateListsURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/privatelists",
"ConfirmDeleteMultipleMessages": true,
"InboxMessagesPerPage": 20,
"EnableMessageBookmark": false,
"ConversationName": "SubMenu",
"UpdateBroadcastMsg": false,
"SayCopiedNames": true,
"SpeechCompleteTimeout": 0,
"MwisURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/mwis",
"VideoServiceAccountsURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/videoserviceaccounts",
"SkipForwardTime": 5000,
"SayMessageLengthAfter": false,
"UseVui": false,
"SpeechConfidenceThreshold": 40,
"FirstDigitTimeout": 5000,
"AddressAfterRecord": false,
"MediaSwitchObjectId": "e53d7010-0053-469d-bae1-c8b1c584f3cb",
"ExitTargetConversation": "PHGreeting",
"DtmfNameLastFirst": "22778352639",
"PartitionURI": "/vmrest/partitions/5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"FirstName": "Andy",
"UseBriefPrompts": false,
"SkipPasswordForKnownDevice": false,
"LastName": "Carstel",
"MessageTypeMenu": false,
"SkipReverseTime": 5000,
"RouteNDRToSender": true,
"SayTimestampBefore": false,
"PartitionObjectId": "5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"SayMsgNumberAfter": false,
"InboxAutoResolveMessageRecipients": true,
"UserWebPasswordURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/credential/password",
"EnAltGreetPreventMsg": false,
"AutoAdvanceMsgs": false,
"EnAltGreetDontRingPhone": false,
"EnableMessageLocator": false,
"CreateSmtpProxyFromCorp": false,
"IsSetForVmEnrollment": true,
"UseDynamicNameSearchWeight": false,
"UserRoleURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/userroles",
"ClockMode": 0,
"RetainUrgentMessageFlag": false,
"LdapCcmUserId": "acarstel01",
"ConversationTui": "SubMenu",
"DtmfNameFirstLast": "26392277835",
"ConfirmationConfidenceThreshold": 60,
"Undeletable": false,
"SendMessageOnHangup": 1,
"EncryptPrivateMessages": false,
"SayTotalReceipts": false,
"NewMessageStackOrder": "1234567",
"NotificationDevicesURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/notificationdevices",
"IsVmEnrolled": true,
"EmailAddress": "acarstel01@ab-group.com",
"EnableTts": true,
"SearchByExtensionSearchSpaceObjectId": "843f5350-8156-4152-91c6-b25feea632fa",
"PcaAddressBookRowsPerPage": 5,
"LocationURI": "/vmrest/locations/connectionlocations/42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"SayDistributionList": true,
"SendBroadcastMsg": false,
"ExitAction": 2,
"VoiceNameRequired": false,
"SearchByExtensionSearchSpaceURI": "/vmrest/searchspaces/843f5350-8156-4152-91c6-b25feea632fa",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%205e922c40-0cf1-4b51-873e-77fe9881a4ea)",
"MessageHandlersURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/messagehandlers",
"SayTotalNewFax": false,
"AssistantRowsPerPage": 5,
"CallHandlerObjectId": "af77ef53-e9c7-41b6-b56d-a61e0d553cbf",
"TimeZone": 140,
"SaySenderAfter": false,
"NameConfirmation": false,
"SearchByNameSearchSpaceURI": "/vmrest/searchspaces/843f5350-8156-4152-91c6-b25feea632fa",
"EnablePersonalRules": true,
"ConfirmDeleteMessage": false,
"SynchScheduleObjectId": "e67855a6-e60e-4ebb-a494-5d5cf2820819",
"Language": 1033,
"RecordUnknownCallerName": true,
"CallAnswerTimeout": 4,
"Volume": 50,
"SayTotalSaved": true,
"InterdigitDelay": 3000,
"CosURI": "/vmrest/coses/a1170324-ca86-4570-8519-90f2cddf0a68",
"SmtpAddress": "acarstel01@cuc",
"IsTemplate": false,
"SayMessageLength": false,
"ListInDirectory": true,
"CallhandlerURI": "/vmrest/handlers/callhandlers/af77ef53-e9c7-41b6-b56d-a61e0d553cbf",
"SayAltGreetWarning": false,
"Alias": "acarstel01",
"PromptVolume": 50,
"CosObjectId": "a1170324-ca86-4570-8519-90f2cddf0a68",
"SayTotalDraftMsg": false,
"SayTotalNew": false,
"SayTotalNewEmail": false,
"UserVoicePinURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/credential/pin",
"SpeechIncompleteTimeout": 750,
"AlternateExtensionsURI": "/vmrest/users/5e922c40-0cf1-4b51-873e-77fe9881a4ea/alternateextensions",
"SayAniAfter": false,
"IsClockMode24Hour": false,
"UseShortPollForCache": false,
"DtmfAccessId": "8201102",
"SearchByNameSearchSpaceObjectId": "843f5350-8156-4152-91c6-b25feea632fa",
"DeletedMessageSortOrder": 2,
"SpeechSpeedVsAccuracy": 50,
"UseDefaultLanguage": true,
"Speed": 100,
"summary_device": "Dedicated CUCxn, 192.168.100.24, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "CL1-AB-C-Hannover (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Hannover"
},
"meta": {
"model_type": "relation/GS_HuntGroupVoicemail_MWI_Rel",
"summary_attrs": [
{
"name": "Alias",
"title": "Alias"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "EmailAddress",
"title": "Email Address"
},
{
"name": "TimeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "acarstel01",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5a86cde9939cd122e185c871",
"pkid": "5a86cde9939cd122e185c871"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a86d27567ea6f20399484e7",
"href": "/api/data/HierarchyNode/5a86d27567ea6f20399484e7"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a896474142896209a61c001/",
"pkid": "5a896474142896209a61c001"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86704db12a1c20228be944",
"5a86cc291360b6206c49e71e",
"5a86cee1939cd122e185cb08",
"5a86d27567ea6f20399484e7",
"5a896474142896209a61c001"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a896474142896209a61c001/",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5a896474142896209a61c001/",
"support_async": false,
"title": "Get"
}
}
],
"summary": "false"
},
"pkid": "5a896474142896209a61c001"
}
]
}
(Show the first instance)
{
"data": {
"DisplayName": "PatchBundle 02",
"VoiceNameRequired": false,
"FirstName": "PatchBundle",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20593b4c84-5075-4a1a-8c71-5481a43874a9)",
"LastName": "02",
"MessageHandlersURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/messagehandlers",
"CreationTime": "2018-10-22T12:06:47Z",
"CallHandlerObjectId": "8ad83256-bbd3-495a-9ebf-b8fefcf3e5f3",
"PhoneSystemURI": "/vmrest/phonesystems/e53d7010-0053-469d-bae1-c8b1c584f3cb",
"TimeZone": 140,
"PartitionURI": "/vmrest/partitions/5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"PartitionObjectId": "5eeac02d-5c48-4f19-90a5-c32fa02f903d",
"Language": 1033,
"MailboxStoreName": "Unity Messaging Database -1",
"LocationObjectId": "42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"ExternalServiceAccountsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/externalserviceaccounts",
"UserRoleURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/userroles",
"CosURI": "/vmrest/coses/a1170324-ca86-4570-8519-90f2cddf0a68",
"UserMailboxURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/mailboxattributes",
"ObjectId": "593b4c84-5075-4a1a-8c71-5481a43874a9",
"PrivateListsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/privatelists",
"CallhandlerURI": "/vmrest/handlers/callhandlers/8ad83256-bbd3-495a-9ebf-b8fefcf3e5f3",
"CosObjectId": "a1170324-ca86-4570-8519-90f2cddf0a68",
"URI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9",
"Alias": "18.1.2",
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20593b4c84-5075-4a1a-8c71-5481a43874a9)",
"UserVoicePinURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/credential/pin",
"MwisURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/mwis",
"UserWebPasswordURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/credential/password",
"VideoServiceAccountsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/videoserviceaccounts",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/notificationdevices",
"AlternateExtensionsURI": "/vmrest/users/593b4c84-5075-4a1a-8c71-5481a43874a9/alternateextensions",
"DtmfAccessId": "8211232",
"EmailAddress": "patchbundle02@ab_group.com",
"ListInDirectory": true,
"MediaSwitchObjectId": "e53d7010-0053-469d-bae1-c8b1c584f3cb",
"LocationURI": "/vmrest/locations/connectionlocations/42e33827-bb72-4c5b-8116-d7c5e1ff2c22",
"cucMwi": [],
"hgData": []
},
"meta": {
"model_type": "relation/GS_HuntGroupVoicemail_MWI_Rel",
"summary_attrs": [
{
"name": "Alias",
"title": "Alias"
},
{
"name": "FirstName",
"title": "First Name"
},
{
"name": "LastName",
"title": "Last Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "EmailAddress",
"title": "Email Address"
},
{
"name": "TimeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "18.1.2",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5a86cde9939cd122e185c871",
"pkid": "5a86cde9939cd122e185c871"
}
],
"children": [],
"parent": [
{
"pkid": "5a86d2bb67ea6f2039948528",
"href": "/api/data/HierarchyNode/5a86d2bb67ea6f2039948528"
}
],
"self": [
{
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/",
"pkid": "5bcdbd4e142896c1be0aff07"
}
]
},
"schema_version": null,
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/GS_HuntGroupVoicemail_MWI_Rel/5bcdbd4e142896c1be0aff07/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
}
]
},
"pkid": "5bcdbd4e142896c1be0aff07"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/GS_HuntGroupVoicemail_MWI_Rel/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/GS_HuntGroupVoicemail_MWI_Rel/[pkid] | hierarchy=[hierarchy] | The relation/GS_HuntGroupVoicemail_MWI_Rel instance with [pkid]. |