[Index]
doc
Model ref.: relation/Voicemail
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_title": "DisplayName",
"description": "The unique identifier 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"
},
"Title": {
"minItems": 0,
"type": "string",
"description": " The position or function of a user within an organization, such as 'Vice President.'",
"name": "Title",
"title": "Title"
},
"AddressMode": {
"minItems": 0,
"type": "integer",
"description": " The default method the subscriber will use to address messages to other subscribers.",
"name": "AddressMode",
"title": "Address Mode"
},
"DtmfNameFirstLast": {
"minItems": 0,
"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",
"title": "Dtmf Name First Last"
},
"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"
},
"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"
},
"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"
},
"cucsmtp": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"StaticText": {
"minItems": 0,
"type": "string",
"description": " The actual text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Send:\" field.\n",
"name": "StaticText",
"title": "Static Text"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SendCount": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ",
"name": "SendCount",
"title": "Send Count"
},
"MaxSubject": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject",
"title": "Max Subject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"UrgentOnly": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends voice message transcripted in urgent mode or not",
"name": "UrgentOnly",
"title": "Urgent Only"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"HeaderText": {
"minItems": 0,
"type": "string",
"description": " The actual header text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Header Text:\" field.",
"name": "HeaderText",
"title": "Header Text"
},
"FooterText": {
"minItems": 0,
"type": "string",
"description": " The actual footer text message that the subscriber wants to receive in a Text Pager notification. The SA refers to this as the \"Footer Text:\" field.",
"name": "FooterText",
"title": "Footer Text"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"SmtpAddress": {
"minItems": 0,
"type": [
"string",
"null"
],
"description": " The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the \"To:\" field.",
"name": "SmtpAddress",
"title": "Smtp Address"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMTP object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody",
"title": "Max Body"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"SendCallerId": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId",
"title": "Send Caller Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PhoneNumber": {
"minItems": 0,
"type": "string",
"description": " The phone number or alphanumeric text (as applicable) for sending a notification message to a text-compatible cell phone or pager. In the SA, this is referred to as the \"From:\" field. Typically, this field contains the number that the subscriber calls to check messages. ",
"name": "PhoneNumber",
"title": "Phone Number"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable",
"title": "Undeletable"
},
"VoiceMessage": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection sends transcription of voice message",
"name": "VoiceMessage",
"title": "Voice Message"
},
"SendPcaLink": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a link to the PCA with the notification message. ",
"name": "SendPcaLink",
"title": "Send Pca Link"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
}
}
},
"type": "array",
"title": "Cucsmtp"
},
"cucphone": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"AfterDialDigits": {
"minItems": 0,
"type": "string",
"description": " The extra digits (if any) that Cisco Unity Connection will dial after the phone number.",
"name": "AfterDialDigits",
"title": "After Dial Digits"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MaxSubject": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject",
"title": "Max Subject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"RnaRetryInterval": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.",
"name": "RnaRetryInterval",
"title": "Rna Retry Interval"
},
"RetriesOnBusy": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.",
"name": "RetriesOnBusy",
"title": "Retries On Busy"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceConversation object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody",
"title": "Max Body"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"DetectTransferLoop": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Unity can do a loop detect transfer to this device.",
"name": "DetectTransferLoop",
"title": "Detect Transfer Loop"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.\n",
"name": "DialDelay",
"title": "Dial Delay"
},
"Conversation": {
"description": " The name of the Conversation Cisco Unity Connection will use when calling the subscriber to notify of new messages. This maps to one of the conversations in tbl_Conversation.",
"title": "Conversation",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "Conversation"
},
"PromptForId": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether to prompt a subscriber for their Cisco Unity Connection ID, or just their password.",
"name": "PromptForId",
"title": "Prompt For Id"
},
"PhoneNumber": {
"minItems": 0,
"type": [
"string",
"null"
],
"description": " The phone number to dial, including the trunk access code (if any), of the device.",
"name": "PhoneNumber",
"title": "Phone Number"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Notification device is undeletable.",
"name": "Undeletable",
"title": "Undeletable"
},
"RingsToWait": {
"minItems": 0,
"type": "integer",
"description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.",
"name": "RingsToWait",
"title": "Rings To Wait"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"WaitConnect": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits. \n",
"name": "WaitConnect",
"title": "Wait Connect"
},
"BusyRetryInterval": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.",
"name": "BusyRetryInterval",
"title": "Busy Retry Interval"
},
"RetriesOnRna": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.",
"name": "RetriesOnRna",
"title": "Retries On Rna"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
},
"MediaSwitchObjectId": {
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the MediaSwitch object to use for notification. ",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/PhoneSystem",
"title": "Media Switch Object Id",
"type": [
"string"
],
"name": "MediaSwitchObjectId"
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.",
"name": "TransmitForcedAuthorizationCode",
"title": "Transmit Forced Authorization Code"
}
}
},
"type": "array",
"title": "Cucphone"
},
"DtmfNameLastFirst": {
"minItems": 0,
"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",
"title": "Dtmf Name Last First"
},
"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"
},
"cucuma": {
"items": {
"type": "object",
"properties": {
"UserProfileNumber": {
"minItems": 0,
"type": "string",
"description": " Number that identifies a MeetingPlace Express 2.x user profile. Used to authenticate to Cisco Unified MeetingPlace Express from a touch-tone phone.",
"name": "UserProfileNumber",
"title": "User Profile Number"
},
"EnableTtsOfEmailCapability": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the capability to access an email store for the purpose of playing the email via TTS is enabled for the user. ",
"name": "EnableTtsOfEmailCapability",
"title": "Enable Tts Of Email Capability"
},
"EnableMailboxSynchCapability": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether synchronization of mailbox contents between Connection and an external/third-party mail system is enabled.",
"name": "EnableMailboxSynchCapability",
"title": "Enable Mailbox Synch Capability"
},
"IsPrimaryMeetingService": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this external service is the user's primary meeting service. A user is only allowed to schedule meetings on the MeetingPlace server that is designated as the user?s primary meeting service. This column applies only to a ServerType of MeetingPlace and EnableMeetingCapability must be enabled.",
"name": "IsPrimaryMeetingService",
"title": "Is Primary Meeting Service"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier\nfor an subscriber external service map object.\n - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"UserPassword": {
"minItems": 0,
"type": "string",
"description": " The user password for logon to the external service.",
"name": "UserPassword",
"title": "User Password"
},
"ExternalServiceObjectId": {
"target_attr": "ObjectId",
"description": "The Unified Messaging Service associated with this Unified Messaging Account",
"title": "Unified Messaging Service",
"minItems": 0,
"format": "uri",
"choices": [],
"target_title": "DisplayName",
"readonly": false,
"target": "/api/device/cuc/ExternalService/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/ExternalService",
"type": "string",
"name": "ExternalServiceObjectId"
},
"UserId": {
"minItems": 0,
"type": "string",
"description": " The unique text name (e.g., logon name) used by the User to logon to the service.\n",
"name": "UserId",
"title": "User Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EnableCalendarCapability": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the capabilities to access calendar information such as appointments, information for free/busy based PCTR rules, and for Exchange servers only, the capability to import a user's contacts from Exchange is enabled for the user. ",
"name": "EnableCalendarCapability",
"title": "Enable Calendar Capability"
},
"EmailAddress": {
"minItems": 0,
"type": "string",
"description": " The user's primary SMTP address on the selected external service. It's possible the user has other email addresses on other email servers, but in this case it has to be their primary email address on this specific server.",
"name": "EmailAddress",
"title": "Email Address"
},
"LoginType": {
"description": " Type of login to use",
"title": "Sign-In Type",
"minItems": 0,
"choices": [
[
0,
"Use Connection Alias"
],
[
2,
"Use User ID Provided Below"
]
],
"type": "integer",
"name": "LoginType"
},
"EmailAddressUseCorp": {
"minItems": 0,
"type": "boolean",
"description": " Flag indicating whether to use the EmailAddress specified in this row or the corporate e-mail address specified on the owning User.",
"name": "EmailAddressUseCorp",
"title": "Email Address Use Corp"
},
"UserExternalServiceResetURI": {
"type": "string",
"description": "The URI to reset external service.",
"name": "UserExternalServiceResetURI",
"title": "User External Service Reset URI"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " A foreign key to a Subscriber. The unique identifier of the subscriber object that is associated with the external service. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"EnableMeetingCapability": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the capability to access meeting information from a server is enabled for the user. For example, allowing a user to receive notification of a meeting about ready to start, providing join meeting and cancel meeting capabilities on the server, and allowing a user to schedule a meeting on the server.",
"name": "EnableMeetingCapability",
"title": "Enable Meeting Capability"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Cucuma"
},
"CcmId": {
"minItems": 0,
"type": "string",
"description": " Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager",
"name": "CcmId",
"title": "Ccm Id"
},
"LocationObjectId": {
"target_attr": "ObjectId",
"description": "The name of the LocationVMS object to which this user belongs.",
"title": "Location",
"minItems": 0,
"format": "uri",
"choices": [],
"target_title": "DisplayName",
"readonly": true,
"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"
},
"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"
},
"ExternalServiceAccountsURI": {
"name": "ExternalServiceAccountsURI",
"format": "uri",
"minItems": 0,
"title": "External Service Accounts URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"UserMailboxURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the mailbox settings.",
"name": "UserMailboxURI",
"title": "User Mailbox URI"
},
"ConversationVui": {
"minItems": 0,
"type": "string",
"description": " The VUI conversation assigned to the subscriber.",
"name": "ConversationVui",
"title": "Conversation Vui"
},
"EmployeeId": {
"minItems": 0,
"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",
"title": "Employee Id"
},
"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,
"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]
},
"cucpass": {
"type": "object",
"properties": {
"CredentialPolicyURI": {
"name": "CredentialPolicyURI",
"format": "uri",
"minItems": 0,
"title": "Credential Policy URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DoesntExpire": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = \"1\"), the user still may change the credential (if allowed by CantChange). ",
"name": "DoesntExpire",
"title": "Doesnt Expire"
},
"Locked": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked.",
"name": "Locked",
"title": "Locked"
},
"TimeHacked": {
"minItems": 0,
"type": "string",
"description": " The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.",
"name": "TimeHacked",
"title": "Time Hacked"
},
"TimeChanged": {
"minItems": 0,
"type": "string",
"description": " The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.",
"name": "TimeChanged",
"title": "Time Changed"
},
"CantChange": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the user can set this credential.",
"name": "CantChange",
"title": "Cant Change"
},
"Credentials": {
"is_password": true,
"description": " The PIN or password, for a user. The credentials are stored in an encrypted format.",
"title": "Password",
"minItems": 0,
"type": "string",
"name": "Credentials"
},
"CredentialPolicyObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the CredentialPolicy object that is associated with this credential.",
"name": "CredentialPolicyObjectId",
"title": "Credential Policy Object Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CredentialType": {
"description": " The type of credential such as password, PIN, Windows or Domino credential. ",
"title": "Credential Type",
"minItems": 0,
"choices": [
[
3,
"Password"
],
[
4,
"PIN"
]
],
"type": "integer",
"name": "CredentialType"
},
"Alias": {
"minItems": 0,
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias",
"title": "Alias"
},
"Hacked": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.",
"name": "Hacked",
"title": "Hacked"
},
"ObjectId": {
"description": " Surrogate key to support IMS",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"HackCount": {
"minItems": 0,
"type": "integer",
"description": " The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid. ",
"name": "HackCount",
"title": "Hack Count"
},
"UserObjectId": {
"target_model_type": "device/cuc/User",
"description": " The unique identifier of the User object to which this credential belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"readonly": true,
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "User Object Id",
"type": [
"string"
],
"name": "UserObjectId"
},
"TimeLastHack": {
"minItems": 0,
"type": "string",
"description": " The date and time of the last logon attempt with an invalid user credential.",
"name": "TimeLastHack",
"title": "Time Last Hack"
},
"CredMustChange": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the user must change their credentials (PIN or password) at the next login.",
"name": "CredMustChange",
"title": "Cred Must Change"
},
"IsPrimary": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.",
"name": "IsPrimary",
"title": "Is Primary"
},
"TimeLockout": {
"minItems": 0,
"type": "string",
"description": " The date and time that the credential was locked by an administrator.",
"name": "TimeLockout",
"title": "Time Lockout"
}
},
"title": "Cucpass"
},
"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"
},
"cucalt": {
"items": {
"type": "object",
"properties": {
"PartitionObjectId": {
"target_title": "Name",
"description": "The name of the associated partition",
"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"
},
"PartitionURI": {
"name": "PartitionURI",
"format": "uri",
"minItems": 0,
"title": "Partition URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DtmfAccessId object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"IdIndex": {
"description": " An index into the alternate extensions for a subscriber.",
"title": "Phone Type",
"minItems": 0,
"required": true,
"choices": [
[
1,
"Work Phone"
],
[
2,
"Work Phone 2"
],
[
3,
"Home Phone"
],
[
4,
"Home Phone 2"
],
[
5,
"Mobile Phone"
],
[
6,
"Mobile Phone 2"
],
[
7,
"Work Fax"
],
[
8,
"Work Fax 2"
],
[
9,
"Home Fax"
],
[
38,
"Directory URI"
]
],
"type": "integer",
"name": "IdIndex"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AlternateExtensionAdvancedURI": {
"type": "string",
"description": "The URI to get the advanced setting of the alternate extension.",
"name": "AlternateExtensionAdvancedURI",
"title": "Alternate Extension Advanced URI"
},
"DtmfAccessId": {
"description": " The dialable number.",
"title": "Dtmf Access Id",
"minItems": 0,
"required": true,
"type": "string",
"name": "DtmfAccessId"
},
"LocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Location object to which this location (denormalized) belongs.",
"name": "LocationObjectId",
"title": "Location Object Id"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The text name of this DtmfAccessId to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"UserObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "User Object Id",
"format": "uri",
"required": true,
"name": "UserObjectId",
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"choices": [],
"type": [
"string"
],
"description": "template parameter [1]"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"title": "Cucalt"
},
"MailboxDn": {
"minItems": 0,
"type": "string",
"description": " The distinguished name of the mailbox.",
"name": "MailboxDn",
"title": "Mailbox Dn"
},
"PhoneNumber": {
"description": " A phone number.",
"title": "Phone Number",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "PhoneNumber"
},
"CcmIdType": {
"minItems": 0,
"type": "integer",
"description": " Type of CCM user/object this id refers to (end user, application user, or directory number)",
"name": "CcmIdType",
"title": "Ccm Id Type"
},
"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"
},
"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"
},
"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"
},
"AlternateNamesURI": {
"readonly": true,
"type": "string",
"description": "The URI to get the alternate names of the user.",
"name": "AlternateNamesURI",
"title": "Alternate Names URI"
},
"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]
},
"Initials": {
"minItems": 0,
"type": "string",
"description": " The initial letters of some or all of the names of this user.",
"name": "Initials",
"title": "Initials"
},
"AltFirstName": {
"minItems": 0,
"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",
"title": "Alt First Name"
},
"ExitCallActionObjectId": {
"target_title": "DisplayName",
"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.",
"title": "Exit Call Action",
"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": "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"
},
"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"
},
"ReadOnly": {
"description": " If set to 1 (true) user is read-only and cannot be modified.",
"title": "Read Only",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "ReadOnly"
},
"cucmsghandler": {
"type": "object",
"properties": {
"ObjectId": {
"description": " The primary key for this table. A globally unique system-generated identifier for a MessageHandler object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this message handler belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EmailAction": {
"description": " The action to take for email messages.",
"title": "Email",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "EmailAction"
},
"RelayAddress": {
"minItems": 0,
"type": "string",
"description": " The SMTP address to which messages should be relayed.",
"name": "RelayAddress",
"title": "Relay Address"
},
"FaxAction": {
"description": " The action to take for fax messages.",
"title": "Fax",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "FaxAction"
},
"VoicemailAction": {
"description": " The action to take for voicemail messages.",
"title": "Voicemail",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "VoicemailAction"
},
"DeliveryReceiptAction": {
"description": " The action to take for delivery receipt messages.",
"title": "Receipt",
"minItems": 0,
"choices": [
[
0,
"Reject the Message"
],
[
1,
"Accept the Message"
],
[
2,
"Relay the Message"
],
[
3,
"Accept and Relay the Message"
]
],
"type": "integer",
"name": "DeliveryReceiptAction"
}
},
"title": "Cucmsghandler"
},
"SaySenderExtension": {
"minItems": 0,
"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": {
"minItems": 0,
"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",
"title": "Display Name"
},
"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": "Indicates if the default timezone is being used.",
"name": "UseDefaultTimeZone",
"title": "Use Default Time Zone"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"readonly": true,
"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"
},
"AltLastName": {
"minItems": 0,
"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",
"title": "Alt Last Name"
},
"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"
},
"MailboxStoreName": {
"readonly": true,
"type": "string",
"description": "The Mailbox store name of user.",
"name": "MailboxStoreName",
"title": "Mailbox Store Name"
},
"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"
},
"DtmfNameLast": {
"minItems": 0,
"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",
"title": "Dtmf Name Last"
},
"FaxServerObjectId": {
"target_title": "FaxServerName",
"description": "The unique identifier 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,
"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"
},
"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",
"readonly": true,
"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": "Tenant"
},
"DtmfNameFirst": {
"minItems": 0,
"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",
"title": "Dtmf Name First"
},
"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"
},
"EnhancedSecurityAlias": {
"minItems": 0,
"type": "string",
"description": " The unique text name used to idenitify and authenticate the user with an RSA SecurID security system.",
"name": "EnhancedSecurityAlias",
"title": "Enhanced Security Alias"
},
"PartitionObjectId": {
"target_title": "Name",
"description": "The unique identifier of the Partition to which the DtmfAccessId is 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"
},
"InboxMessagesPerPage": {
"minItems": 0,
"type": "integer",
"description": " The number of messages Unity Inbox displays in a page.",
"name": "InboxMessagesPerPage",
"title": "Inbox Messages Per Page"
},
"EnableMessageBookmark": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Message Bookmark is enabled for the subscriber",
"name": "EnableMessageBookmark",
"title": "Enable Message Bookmark"
},
"ConversationName": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation the subscriber uses to set up, send, and retrieve messages.",
"name": "ConversationName",
"title": "Conversation Name"
},
"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"
},
"SearchByNameSearchSpaceObjectId": {
"target_title": "Name",
"description": "The unique identifier 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"
},
"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"
},
"MwisURI": {
"name": "MwisURI",
"format": "uri",
"minItems": 0,
"title": "Mwis URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"VideoServiceAccountsURI": {
"name": "VideoServiceAccountsURI",
"format": "uri",
"minItems": 0,
"title": "Video Service Accounts URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"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]
},
"DialablePhoneNumber": {
"minItems": 0,
"type": "string",
"description": " A dialable version of the PhoneNumber column.",
"name": "DialablePhoneNumber",
"title": "Dialable Phone Number"
},
"MediaSwitchObjectId": {
"target_title": "DisplayName",
"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.",
"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"
},
"SavedMessageSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection will sort saved messages.",
"name": "SavedMessageSortOrder",
"title": "Saved Message Sort Order"
},
"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]
},
"FirstName": {
"minItems": 0,
"type": "string",
"description": " The first name (i.e., givenName) of this user. Not their surname nor middle name.",
"name": "FirstName",
"title": "First Name"
},
"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"
},
"LastName": {
"minItems": 0,
"type": "string",
"description": " The last name (i.e., surname or family name) of this user, by which a user is commonly known.",
"name": "LastName",
"title": "Last Name"
},
"Callhandler": {
"type": "object",
"properties": {
"SendPrivateMsg": {
"description": " Determines if an outside caller can mark their message as private.",
"title": "Message Sensitivity",
"minItems": 0,
"choices": [
[
0,
"Mark Normal"
],
[
1,
"Mark Urgent"
],
[
2,
"Ask Callers"
]
],
"type": "integer",
"name": "SendPrivateMsg"
},
"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"
},
"templateObjectId": {
"target_title": "DisplayName",
"target": "/api/device/cuc/CallhandlerTemplate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "Query parameter",
"required": false,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/CallhandlerTemplate",
"title": "Template",
"type": "string",
"name": "templateObjectId"
},
"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]
},
"PlayPostGreetingRecording": {
"description": " Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.",
"title": "Play Post Greeting Recording",
"minItems": 0,
"choices": [
[
0,
"Do Not Play Recording"
],
[
1,
"Play Recording to All Callers"
],
[
2,
"Play Recording Only to Unidentified Callers"
]
],
"type": "integer",
"name": "PlayPostGreetingRecording"
},
"Transfer": {
"items": {
"type": "object",
"properties": {
"TransferHoldingMode": {
"minItems": 0,
"type": "integer",
"description": " The action Cisco Unity Connection will take when the extension is busy.",
"name": "TransferHoldingMode",
"title": "Transfer Holding Mode"
},
"TransferOptionType": {
"description": " The type of transfer option, e.g. \"Standard,\" \"Off Hours,\" or \"Alternate.\" - template parameter [2]",
"title": "Transfer Option Type",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TransferOptionType"
},
"CallHandlerObjectId": {
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/Callhandler",
"title": "Call Handler Object Id",
"type": [
"string"
],
"name": "CallHandlerObjectId"
},
"TransferConfirm": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection prompts the subscriber to accept or refuse a call (\"Press 1 to take the call or 2 and I'll take a message\"). If the call is accepted, it is transferred to the subscriber phone. If the call is refused, Cisco Unity Connection plays the applicable subscriber greeting. \n",
"name": "TransferConfirm",
"title": "Transfer Confirm"
},
"TransferRings": {
"minItems": 0,
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings",
"title": "Transfer Rings"
},
"TransferScreening": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will prompt callers to say their names. When the phone is answered, the subscriber hears \"Call from...\" before Cisco Unity Connection transfers the call.",
"name": "TransferScreening",
"title": "Transfer Screening"
},
"RnaAction": {
"minItems": 0,
"type": "integer",
"description": " The action Cisco Unity Connection takes for a \"Ring-No-Answer\" (RNA) condition. Cisco Unity Connection will either transfer the call to the appropriate greeting or releases the call to the phone system.",
"name": "RnaAction",
"title": "Rna Action"
},
"PersonalCallTransfer": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether or not Personal Call Transfer Rules are used for the specific Transfer Option.",
"name": "PersonalCallTransfer",
"title": "Personal Call Transfer"
},
"Extension": {
"minItems": 0,
"type": "string",
"description": " The extension (phone number) to transfer to.",
"name": "Extension",
"title": "Extension"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"format": "uri",
"minItems": 0,
"title": "Callhandler URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Enabled": {
"type": "boolean",
"description": "If TimeExpires is set, this field is ignored.",
"name": "Enabled",
"title": "Enabled"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UsePrimaryExtension": {
"minItems": 0,
"type": "boolean",
"description": "If extension is null this will be set to 1 (true) to indicate we are using instead the DtmfAccessId for the owning handler or subscriber.",
"name": "UsePrimaryExtension",
"title": "Use Primary Extension"
},
"TransferAnnounce": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays \"transferring call\" when the subscriber answers the phone. ",
"name": "TransferAnnounce",
"title": "Transfer Announce"
},
"Action": {
"minItems": 0,
"type": "integer",
"description": " A flag indicating whether Cisco Unity Connection transfers the call to the call handler greeting or attempts to transfer the call to an extension.",
"name": "Action",
"title": "Action"
},
"TransferType": {
"minItems": 0,
"type": "integer",
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"name": "TransferType",
"title": "Transfer Type"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferDtDetect": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will check for dialtone before attempting to transfer the call.",
"name": "TransferDtDetect",
"title": "Transfer Dt Detect"
},
"PlayTransferPrompt": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the \"Wait while I transfer your call\" prompt should be played prior to transferring a call. \n\n",
"name": "PlayTransferPrompt",
"title": "Play Transfer Prompt"
},
"TransferIntroduce": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will say \"call for <recorded name of the call handler>\" when the subscriber answers the phone. ",
"name": "TransferIntroduce",
"title": "Transfer Introduce"
},
"MediaSwitchObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the MediaSwitch object that Cisco Unity Connection uses for transferring the call to the subscriber phone.",
"name": "MediaSwitchObjectId",
"title": "Media Switch Object Id"
},
"TimeExpires": {
"minItems": 0,
"type": [
"string",
"null"
],
"description": " The date and time when this transfer option expires. If the transfer rule is enabled, the value is NULL or a date in the future. If the transfer rule is disable, the value is a past date.",
"name": "TimeExpires",
"title": "Time Expires"
}
}
},
"type": "array",
"title": "Transfer"
},
"CreationTime": {
"description": " The date and time the handler is created.",
"title": "Creation Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CreationTime"
},
"CallHandlerOwnerURI": {
"readonly": true,
"type": "string",
"description": "The URI to fetch the call handler owners.",
"name": "CallHandlerOwnerURI",
"title": "Call Handler Owner URI"
},
"EnablePrependDigits": {
"minItems": 0,
"type": "boolean",
"description": " A flag to indicate weather or not to prepend digits when dialing a extension number to transfer too.\n\n",
"name": "EnablePrependDigits",
"title": "Enable Prepend Digits"
},
"UseDefaultTimeZone": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether the timezone for this call handler is derived from the call handler object attribute or the default timezone from the location to which the call handler belongs. Always use the Timezone column - if this is set, then the column Timezone is being derived directly from the location.",
"name": "UseDefaultTimeZone",
"title": "Use Default Time Zone"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientDistributionListURI": {
"name": "RecipientDistributionListURI",
"format": "uri",
"minItems": 0,
"title": "Recipient Distribution List URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeZone": {
"minItems": 0,
"type": "integer",
"description": " TimeZone this call handler is operating in.",
"name": "TimeZone",
"title": "Time Zone"
},
"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]
},
"PartitionObjectId": {
"target_title": "Name",
"description": " The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is 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"
},
"RecipientSubscriberObjectId": {
"target_title": "Alias",
"description": " The recipient for this call handler. If the recipient is a subscriber, the DignetObjectId of the User object to which the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL.",
"title": "User with Mailbox",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/User/choices/?choice_title=Alias&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/User",
"type": "string",
"name": "RecipientSubscriberObjectId"
},
"CallSearchSpaceObjectId": {
"target_title": "Name",
"description": " The unique identifier of the SearchSpace that is used limit visibility to dialable objects when searching by extension (dial string).",
"title": "Call 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": "CallSearchSpaceObjectId"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"UseCallLanguage": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.",
"name": "UseCallLanguage",
"title": "Use Call Language"
},
"ScheduleSetObjectId": {
"target_title": "DisplayName",
"description": " The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.",
"title": "Schedule Set",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/ScheduleSet/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/ScheduleSet",
"type": "string",
"name": "ScheduleSetObjectId"
},
"OneKeyDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key.",
"name": "OneKeyDelay",
"title": "One Key Delay"
},
"DispatchDelivery": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating that all messages left for the call handler is for dispatch delivery. ",
"name": "DispatchDelivery",
"title": "Dispatch Delivery"
},
"ScheduleSetURI": {
"name": "ScheduleSetURI",
"format": "uri",
"minItems": 0,
"title": "Schedule Set URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageAction": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "After Message Action",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
5,
"Skip Greeting"
],
[
6,
"Restart Greeting"
],
[
7,
"Transfer to Alternate Contact Number"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "AfterMessageAction"
},
"MaxMsgLen": {
"minItems": 0,
"type": "integer",
"description": " The maximum recording length (in seconds) for messages left by unidentified callers.",
"name": "MaxMsgLen",
"title": "Max Msg Len"
},
"EditMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag that determines whether the caller can edit messages.",
"name": "EditMsg",
"title": "Edit Msg"
},
"MenuEntriesURI": {
"name": "MenuEntriesURI",
"format": "uri",
"minItems": 0,
"title": "Menu Entries URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsPrimary": {
"description": " A flag indicating whether this is a \"primary\" call handler for a subscriber, or an \"application\" call handler.",
"title": "Is Primary",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsPrimary"
},
"PrependDigits": {
"minItems": 0,
"type": "string",
"description": " Touch-Tone digits to prepended to extension when dialing transfer number ( #, 0,1...9,*).",
"name": "PrependDigits",
"title": "Prepend Digits"
},
"LocationObjectId": {
"target_title": "DisplayName",
"description": " The unique identifier of the Location object to which this handler 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"
},
"Language": {
"description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.",
"title": "Language",
"minItems": 0,
"choices": [
[
1033,
"English(UnitedStates)"
]
],
"type": "integer",
"name": "Language"
},
"TransferOptionsURI": {
"name": "TransferOptionsURI",
"format": "uri",
"minItems": 0,
"title": "Transfer Options URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsTemplate": {
"description": " A flag indicating whether this CallHandler is a \"template\" for creating new call handlers.",
"title": "Is Template",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsTemplate"
},
"RecipientUserURI": {
"name": "RecipientUserURI",
"format": "uri",
"minItems": 0,
"title": "Recipient User URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallSearchSpaceURI": {
"name": "CallSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Call Search Space URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientContactURI": {
"name": "RecipientContactURI",
"format": "uri",
"minItems": 0,
"title": "Recipient Contact URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PlayAfterMessage": {
"description": " Indicates whether the Sent Message Prompt Recording referenced by Post Greeting",
"title": "Play After Message",
"minItems": 0,
"choices": [
[
0,
"Do Not Play Recording"
],
[
1,
"System Default Recording"
]
],
"type": "integer",
"name": "PlayAfterMessage"
},
"GreetingsURI": {
"name": "GreetingsURI",
"format": "uri",
"minItems": 0,
"title": "Greetings URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageTargetHandlerObjectId": {
"target_title": "DisplayName",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"title": "After Message 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": "AfterMessageTargetHandlerObjectId"
},
"TenantObjectId": {
"minItems": 0,
"type": "string",
"description": " Unique ObjectId of the tbl_Tenant",
"name": "TenantObjectId",
"title": "Tenant Object Id"
},
"PlayAfterMessageRecordingObjectId": {
"target_title": "DisplayName",
"description": " A Link To a PostGreetingRecording that is used as After Message Recording",
"title": "Play After Message Recording",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/PostGreetingRecording",
"type": "string",
"name": "PlayAfterMessageRecordingObjectId"
},
"CallhandlerMenuEntry": {
"items": {
"type": "object",
"properties": {
"Locked": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key.\n\nValues:\n0: Additional input accepted\n1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key. \n",
"name": "Locked",
"title": "Locked"
},
"TransferType": {
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"title": "Transfer Type",
"minItems": 0,
"choices": [
[
0,
"Release to Switch"
],
[
1,
"Supervise Transfer"
]
],
"type": "integer",
"name": "TransferType"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"TransferNumber": {
"minItems": 0,
"type": "string",
"description": " The phone number associated with the alternate contact",
"name": "TransferNumber",
"title": "Transfer Number"
},
"TransferRings": {
"minItems": 0,
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings",
"title": "Transfer Rings"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"format": "uri",
"minItems": 0,
"title": "Callhandler URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallHandlerObjectId": {
"target_title": "DisplayName",
"target_model_type": "device/cuc/Callhandler",
"description": " The unique identifier of the CallHandler object to which this menu entry belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Call Handler",
"type": "string",
"name": "CallHandlerObjectId"
},
"TouchtoneKey": {
"description": " The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). - template parameter [2]",
"title": "Touchtone Key",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TouchtoneKey"
},
"TargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "TargetConversation",
"title": "Target Conversation"
},
"Action": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "Call Action",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
5,
"Skip Greeting"
],
[
6,
"Restart Greeting"
],
[
7,
"Transfer to Alternate Contact Number"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "Action"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The display name associated with the alternate contact number.",
"name": "DisplayName",
"title": "Display Name"
},
"TargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "TargetHandlerObjectId",
"title": "Target Handler Object Id"
}
}
},
"type": "array",
"title": "Callhandler Menu Entry"
},
"Undeletable": {
"description": " A flag indicating whether this handler can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.",
"title": "Undeletable",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "Undeletable"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"format": "uri",
"minItems": 0,
"title": "Voice File URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "AfterMessageTargetConversation",
"title": "After Message Target Conversation"
},
"InheritSearchSpaceFromCall": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the call handler inherits the search space from the call or uses the call handler CallSearchSpaceObject. The default value is true ? inherit the search space from the call thereby ignoring the call handler's CallSeachSpaceObjectId.",
"name": "InheritSearchSpaceFromCall",
"title": "Inherit Search Space From Call"
},
"RecipientContactObjectId": {
"target_title": "DisplayName",
"description": " The recipient for this call handler. If the recipient is a contact, the unique identifier of the Subscriber object where the recorded message of a call handler should be routed. Otherwise, this attribute is set to NULL.",
"title": "Recipient Contact",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Contact/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Contact",
"type": "string",
"name": "RecipientContactObjectId"
},
"RecipientDistributionListObjectId": {
"target_title": "DisplayName",
"description": " The recipient for this call handler. If the recipient is a distribution list, the unique identifier of the DistributionList object where the recorded message of a call handler should be routed. Otherwise, this attribute is set ot NULL.",
"title": "Recipient Distribution List",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/DistributionList/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/DistributionList",
"type": "string",
"name": "RecipientDistributionListObjectId"
},
"DtmfAccessId": {
"minItems": 0,
"type": "string",
"description": "The DTMF access id (i.e., extension) for the call handler. The dialable number.",
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
"SendSecureMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether an unidentified caller can mark a message as \"secure.\"",
"name": "SendSecureMsg",
"title": "Send Secure Msg"
},
"DisplayName": {
"description": " The text name of the handler to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting call handler is \"Opening Greeting.\"",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"PostGreetingRecordingObjectId": {
"target_title": "DisplayName",
"description": " A link to a PostGreetingRecording",
"title": "Post Greeting Recording",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/PostGreetingRecording/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/PostGreetingRecording",
"type": "string",
"name": "PostGreetingRecordingObjectId"
},
"SendUrgentMsg": {
"description": " A flag indicating whether an unidentified caller can mark a message as \"urgent.\"",
"title": "Message Urgency",
"minItems": 0,
"choices": [
[
0,
"Mark Normal"
],
[
1,
"Mark Urgent"
],
[
2,
"Ask Callers"
]
],
"type": "integer",
"name": "SendUrgentMsg"
},
"Owner": {
"items": {
"type": "object",
"properties": {
"DistributionListObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the DistributionList object to which this distribution list member belongs.",
"name": "DistributionListObjectId",
"title": "Distribution List Object Id"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a Call handler owner object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DistributionListURI": {
"name": "DistributionListURI",
"format": "uri",
"minItems": 0,
"title": "Distribution List URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserObjectId": {
"minItems": 0,
"type": "string",
"name": "UserObjectId",
"title": "User Object Id"
},
"TargetHandlerObjectId": {
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Call Handler object for which this distribution list is the owner. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/Callhandler",
"title": "Target Handler Object Id",
"type": [
"string"
],
"name": "TargetHandlerObjectId"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Owner"
},
"UseDefaultLanguage": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether the language for this call handler is derived from the call handler object attribute or the default language from the location to which the call handler belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.",
"name": "UseDefaultLanguage",
"title": "Use Default Language"
},
"MediaSwitchObjectId": {
"target_title": "DisplayName",
"description": " Default switch to use for transfers.",
"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"
},
"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]
}
},
"title": "Callhandler"
},
"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"
},
"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"
},
"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": {
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "Query parameter",
"required": false,
"choices": [],
"target_attr": "Alias",
"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"
},
"PrivateListsURI": {
"name": "PrivateListsURI",
"format": "uri",
"minItems": 0,
"title": "Private Lists URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"UserWebPasswordURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the web application password.",
"name": "UserWebPasswordURI",
"title": "User Web Password URI"
},
"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"
},
"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"
},
"UserVoicePinURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the voice mail pin of the user.",
"name": "UserVoicePinURI",
"title": "User Voice Pin URI"
},
"UserRoleURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the role of the user.",
"name": "UserRoleURI",
"title": "User Role URI"
},
"ClockMode": {
"minItems": 0,
"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",
"title": "Clock Mode"
},
"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"
},
"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 cross-server transfer extension. If NULL, the user's primary extension is used.",
"name": "XferString",
"title": "Xfer String"
},
"ConfirmationConfidenceThreshold": {
"minItems": 0,
"type": "integer",
"description": " Voice Recognition Confirmation Confidence Threshold",
"name": "ConfirmationConfidenceThreshold",
"title": "Confirmation Confidence Threshold"
},
"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,
"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"
},
"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"
},
"NotificationDevicesURI": {
"name": "NotificationDevicesURI",
"format": "uri",
"minItems": 0,
"title": "Notification Devices URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MailboxStoreObjectId": {
"target_title": "DisplayName",
"target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"description": "Mailbox Store for the tenant.",
"required": false,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/MailboxStore",
"title": "Mailbox Store",
"type": "string",
"name": "MailboxStoreObjectId"
},
"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"
},
"Inactive": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this subscriber is inactive or not.",
"name": "Inactive",
"title": "Inactive"
},
"EmailAddress": {
"minItems": 0,
"type": "string",
"description": " The corporate email address of the user. ",
"name": "EmailAddress",
"title": "Email Address"
},
"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"
},
"SearchByExtensionSearchSpaceObjectId": {
"target_title": "Name",
"description": "The unique identifier 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"
},
"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"
},
"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"
},
"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]
},
"SmtpProxyAddressesURI": {
"readonly": true,
"type": "string",
"description": "The URI to get the smtp proxy addresses of the user.",
"name": "SmtpProxyAddressesURI",
"title": "Smtp Proxy Addresses URI"
},
"MessageHandlersURI": {
"name": "MessageHandlersURI",
"format": "uri",
"minItems": 0,
"title": "Message Handlers URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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 unique identifier 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"
},
"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 unique identifier 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"
},
"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"
},
"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]
},
"SmtpAddress": {
"minItems": 0,
"type": "string",
"description": "SMTP address The full SMTP address for this object.",
"name": "SmtpAddress",
"title": "Smtp Address"
},
"TimeLastCall": {
"minItems": 0,
"type": "string",
"description": " The date and time when the subscriber last accessed their mailbox by phone (last time they were offered messages).",
"name": "TimeLastCall",
"title": "Time Last Call"
},
"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"
},
"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"
},
"cucpager": {
"items": {
"type": "object",
"properties": {
"SuccessRetryInterval": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.",
"name": "SuccessRetryInterval",
"title": "Success Retry Interval"
},
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"AfterDialDigits": {
"minItems": 0,
"type": "string",
"description": " The extra digits (if any) that Cisco Unity Connection will dial after the phone number. For numeric pagers, the extra digits are shown on the pager display.",
"name": "AfterDialDigits",
"title": "After Dial Digits"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"BusyRetryInterval": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.",
"name": "BusyRetryInterval",
"title": "Busy Retry Interval"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"format": "uri",
"minItems": 0,
"title": "Phone System URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RetriesOnSuccess": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is successful.",
"name": "RetriesOnSuccess",
"title": "Retries On Success"
},
"SendCount": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicting whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ",
"name": "SendCount",
"title": "Send Count"
},
"MaxSubject": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject",
"title": "Max Subject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"RnaRetryInterval": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.",
"name": "RnaRetryInterval",
"title": "Rna Retry Interval"
},
"RetriesOnBusy": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if it is busy.",
"name": "RetriesOnBusy",
"title": "Retries On Busy"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDevicePager object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody",
"title": "Max Body"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"SendCallerId": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId",
"title": "Send Caller Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DialDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.",
"name": "DialDelay",
"title": "Dial Delay"
},
"PhoneNumber": {
"minItems": 0,
"type": [
"string",
"null"
],
"description": " The phone number to dial, including the trunk access code, to send a page.",
"name": "PhoneNumber",
"title": "Phone Number"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable",
"title": "Undeletable"
},
"RingsToWait": {
"minItems": 0,
"type": "integer",
"description": " The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.",
"name": "RingsToWait",
"title": "Rings To Wait"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"WaitConnect": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection waits until it detects a connection before dialing the digits in AfterDialDigits. ",
"name": "WaitConnect",
"title": "Wait Connect"
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"RetriesOnRna": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will retry the notification device if the device does not answer.",
"name": "RetriesOnRna",
"title": "Retries On Rna"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
},
"MediaSwitchObjectId": {
"target": "/api/device/cuc/PhoneSystem/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the MediaSwitch object to use for notification. ",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/PhoneSystem",
"title": "Media Switch Object Id",
"type": [
"string"
],
"name": "MediaSwitchObjectId"
},
"TransmitForcedAuthorizationCode": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicting whether an authorization code should be transmitted to Cisco Call Manager after this number is dialed during an outbound call.",
"name": "TransmitForcedAuthorizationCode",
"title": "Transmit Forced Authorization Code"
}
}
},
"type": "array",
"title": "Cucpager"
},
"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"
},
"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"
},
"cuchtml": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SendScheduledNotificationAt": {
"type": "string",
"description": "Comma separated list of time slots at which scheduled notification will be triggered at daily basis.",
"name": "SendScheduledNotificationAt",
"title": "Send Scheduled Notification At"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"DisableMobileNumberFromPCA": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to change Mobile Number.",
"name": "DisableMobileNumberFromPCA",
"title": "Disable Mobile Number From PCA"
},
"SmtpAddress": {
"minItems": 0,
"type": "string",
"description": " The e-mail address of the text pager, text-compatible cell phone, or another e-mail account (such as a home e-mail address) to which the notification message is to be sent. In the SA, this is referred to as the \"To:\" field.",
"name": "SmtpAddress",
"title": "Smtp Address"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceHTML object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"DisableTemplateSelectionFromPCA": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will not allow PCA to select notification templates.",
"name": "DisableTemplateSelectionFromPCA",
"title": "Disable Template Selection From PCA"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AllowVoiceMailAsAttachment": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will allow notifier to send voice mail recording with the notification.",
"name": "AllowVoiceMailAsAttachment",
"title": "Allow Voice Mail As Attachment"
},
"MessageCountInSummary": {
"minItems": 0,
"type": "integer",
"description": " Field to store number of messages to be sent in summary notification mail",
"name": "MessageCountInSummary",
"title": "Message Count In Summary"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable",
"title": "Undeletable"
},
"CallbackNumber": {
"minItems": 0,
"type": "string",
"name": "CallbackNumber",
"title": "Callback Number"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"NotificationTemplateID": {
"description": " The unique identifier of the Notification Template object which this notification device is using for HTML based notification",
"format": "uri",
"minItems": 0,
"title": "Notification Template ID",
"choices": [],
"target_attr": "NotificationTemplateID",
"target": "/api/device/cuc/NotificationTemplate/choices/?field=NotificationTemplateID&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/NotificationTemplate",
"type": [
"string"
],
"name": "NotificationTemplateID"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
}
}
},
"type": "array",
"title": "Cuchtml"
},
"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"
},
"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"
},
"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"
},
"AlternateExtensionsURI": {
"name": "AlternateExtensionsURI",
"format": "uri",
"minItems": 0,
"title": "Alternate Extensions URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"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"
},
"SendMessageOnHangup": {
"minItems": 0,
"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",
"title": "Send Message On Hangup"
},
"Manager": {
"minItems": 0,
"type": [
"string",
"null"
],
"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"
},
"cucsms": {
"items": {
"type": "object",
"properties": {
"DisplayName": {
"description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ",
"title": "Display Name",
"minItems": 0,
"required": true,
"type": "string",
"name": "DisplayName"
},
"SmppProviderObjectId": {
"target": "/api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the SMPPProvider object that is used by this notification device.",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/SmppProvider",
"title": "Smpp Provider Object Id",
"type": [
"string"
],
"name": "SmppProviderObjectId"
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RecipientAddress": {
"minItems": 0,
"type": "string",
"description": " The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the \"To:\" field.",
"name": "RecipientAddress",
"title": "Recipient Address"
},
"SendCount": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ",
"name": "SendCount",
"title": "Send Count"
},
"MaxSubject": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'subject' of a notification message.",
"name": "MaxSubject",
"title": "Max Subject"
},
"DeviceName": {
"description": " The \"DeviceName\" of the notification device.",
"title": "Device Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceName"
},
"SubscriberObjectId": {
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/User",
"title": "Subscriber Object Id",
"type": [
"string"
],
"name": "SubscriberObjectId"
},
"ScheduleSetObjectId": {
"type": "string",
"description": "ObjectId of the ScheduleSet for when the notification rule is active.",
"name": "ScheduleSetObjectId",
"title": "Schedule Set Object Id"
},
"SenderAddress": {
"minItems": 0,
"type": "string",
"description": " The return phone number for the message notification. Typically, this column contains the number that the subscriber calls to check messages (i.e., pilot number for Cisco Unity Connection voice mail). If the SMPP Provider requires a source address for the server sending the message, the SMSC will overwrite this data with an IP address. In CUSA, this is referred to as the \"From:\" field.",
"name": "SenderAddress",
"title": "Sender Address"
},
"Active": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the device is active or inactive (enabled/disabled).",
"name": "Active",
"title": "Active"
},
"RepeatInterval": {
"type": "integer",
"description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.",
"name": "RepeatInterval",
"title": "Repeat Interval"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxBody": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of characters allowed in the 'body' of a notification message.",
"name": "MaxBody",
"title": "Max Body"
},
"EventList": {
"type": "string",
"description": "Comma separated list of events that trigger notification rules to be evaluated.",
"name": "EventList",
"title": "Event List"
},
"SendCallerId": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ",
"name": "SendCallerId",
"title": "Send Caller Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"StaticText": {
"minItems": 0,
"type": "string",
"description": " The text message that the subscriber wants to receive in a Text Pager notification. For Text Pager notifications only. The SA refers to this as the \"Send:\" field.\nTypically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.",
"name": "StaticText",
"title": "Static Text"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": "Device cannot be deleted.",
"name": "Undeletable",
"title": "Undeletable"
},
"FailDeviceObjectId": {
"type": "string",
"description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.",
"name": "FailDeviceObjectId",
"title": "Fail Device Object Id"
},
"InitialDelay": {
"type": "integer",
"description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.",
"name": "InitialDelay",
"title": "Initial Delay"
},
"RepeatNotify": {
"type": "boolean",
"description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.",
"name": "RepeatNotify",
"title": "Repeat Notify"
}
}
},
"type": "array",
"title": "Cucsms"
},
"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"
},
"cucpin": {
"type": "object",
"properties": {
"CredentialPolicyURI": {
"name": "CredentialPolicyURI",
"format": "uri",
"minItems": 0,
"title": "Credential Policy URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DoesntExpire": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = \"1\"), the user still may change the credential (if allowed by CantChange). ",
"name": "DoesntExpire",
"title": "Doesnt Expire"
},
"Locked": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked.",
"name": "Locked",
"title": "Locked"
},
"TimeHacked": {
"minItems": 0,
"type": "string",
"description": " The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.",
"name": "TimeHacked",
"title": "Time Hacked"
},
"TimeChanged": {
"minItems": 0,
"type": "string",
"description": " The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.",
"name": "TimeChanged",
"title": "Time Changed"
},
"CantChange": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the user can set this credential.",
"name": "CantChange",
"title": "Cant Change"
},
"Credentials": {
"is_password": true,
"description": " The PIN or password, for a user. The credentials are stored in an encrypted format.",
"title": "PIN",
"minItems": 0,
"type": "string",
"name": "Credentials"
},
"CredentialPolicyObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the CredentialPolicy object that is associated with this credential.",
"name": "CredentialPolicyObjectId",
"title": "Credential Policy Object Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CredentialType": {
"description": " The type of credential such as password, PIN, Windows or Domino credential. ",
"title": "Credential Type",
"minItems": 0,
"choices": [
[
3,
"Password"
],
[
4,
"PIN"
]
],
"type": "integer",
"name": "CredentialType"
},
"Alias": {
"minItems": 0,
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias",
"title": "Alias"
},
"Hacked": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.",
"name": "Hacked",
"title": "Hacked"
},
"ObjectId": {
"description": " Surrogate key to support IMS",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"HackCount": {
"minItems": 0,
"type": "integer",
"description": " The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid. ",
"name": "HackCount",
"title": "Hack Count"
},
"UserObjectId": {
"target_model_type": "device/cuc/User",
"description": " The unique identifier of the User object to which this credential belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"readonly": true,
"target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "User Object Id",
"type": [
"string"
],
"name": "UserObjectId"
},
"TimeLastHack": {
"minItems": 0,
"type": "string",
"description": " The date and time of the last logon attempt with an invalid user credential.",
"name": "TimeLastHack",
"title": "Time Last Hack"
},
"CredMustChange": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the user must change their credentials (PIN or password) at the next login.",
"name": "CredMustChange",
"title": "Cred Must Change"
},
"IsPrimary": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.",
"name": "IsPrimary",
"title": "Is Primary"
},
"TimeLockout": {
"minItems": 0,
"type": "string",
"description": " The date and time that the credential was locked by an administrator.",
"name": "TimeLockout",
"title": "Time Lockout"
}
},
"title": "Cucpin"
}
},
"schema_version": "1.9"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/Voicemail/add/ |
|
The GUI Add form of relation/Voicemail 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/relation/Voicemail/ | 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/relation/Voicemail/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/Voicemail/[pkid1]", "/api/relation/Voicemail/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/Voicemail/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/Voicemail |
|
{"hrefs": ["/api/relation/Voicemail/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/Voicemail |
|
{"hrefs": ["/api/relation/Voicemail/[pkid1]", "/api/relation/Voicemail/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/Voicemail; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/Voicemail/export/ |
|
{ "hrefs":["/api/relation/Voicemail/[pkid1]", "/api/relation/Voicemail/[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 relation/Voicemail and the JSON format can be used to import instances of relation/Voicemail.
GET http://[host-proxy]/api/relation/Voicemail/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/Voicemail | POST | /api/relation/Voicemail/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/Voicemail/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/Voicemail/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/Voicemail/ |
|
The relation/Voicemail schema and all instances as JSON. |
(The list will return 0 to 3 relation/Voicemail instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "Alias",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/Voicemail/?skip=0&limit=3&order_by=Alias&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 23
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.9",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/Voicemail/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/Voicemail/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/Voicemail/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/Voicemail",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/Voicemail/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/Voicemail/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/Voicemail/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/Voicemail/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/Voicemail/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/Voicemail/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/Voicemail",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"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"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd310d8192d40018f7844b",
"meta": {
"tags": [],
"cached": true,
"title": "drich01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"self": [
{
"pkid": "5dcd310d8192d40018f7844b",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd310d8192d40018f7844b/?model_type=relation/Voicemail",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/help",
"method": "GET",
"title": "Help"
}
},
{
"Addcucalt": {
"title": "Addcucalt",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Addcuchtml": {
"title": "Addcuchtml",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Addcucpager": {
"title": "Addcucpager",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Addcucphone": {
"title": "Addcucphone",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Addcucsms": {
"title": "Addcucsms",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Addcucsmtp": {
"title": "Addcucsmtp",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
},
{
"Delcucalt": {
"title": "Delcucalt",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Delcuchtml": {
"title": "Delcuchtml",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Delcucpager": {
"title": "Delcucpager",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Delcucphone": {
"title": "Delcucphone",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Delcucsms": {
"title": "Delcucsms",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Delcucsmtp": {
"title": "Delcucsmtp",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
}
],
"model_type": "relation/Voicemail",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd310d8192d40018f7844b"
],
"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"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"VoiceNameRequired": false,
"FirstName": "Don",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20db83873f-bb81-4529-b901-46e8c6318f0f)",
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"LastName": "Rich",
"MessageHandlersURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/messagehandlers",
"CreationTime": "2018-12-18T13:26:28Z",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "Don Rich",
"hierarchy_friendly_name": "Overton (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"Language": 1033,
"MailboxStoreName": "Unity Messaging Database -1",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"ExternalServiceAccountsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/externalserviceaccounts",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"UserRoleURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/userroles",
"CosURI": "/vmrest/coses/3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"UserMailboxURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/mailboxattributes",
"ObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"PrivateListsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/privatelists",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"CosObjectId": "3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"Alias": "drich01",
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20db83873f-bb81-4529-b901-46e8c6318f0f)",
"UserVoicePinURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/pin",
"MwisURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/mwis",
"UserWebPasswordURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/password",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices",
"VideoServiceAccountsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/videoserviceaccounts",
"AlternateExtensionsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/alternateextensions",
"DtmfAccessId": "4000",
"ListInDirectory": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
},
{
"pkid": "5dced0589d77dd0018b5f239",
"meta": {
"tags": [],
"cached": true,
"title": "grantcuc",
"business_key": {},
"schema_version": "12.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd18514544b7001860529a",
"href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dced0589d77dd0018b5f239",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/"
}
],
"parent": [
{
"pkid": "5dcd194fe186e30018eb7c58",
"href": "/api/data/HierarchyNode/5dcd194fe186e30018eb7c58"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dced0589d77dd0018b5f239/?model_type=relation/Voicemail",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"Addcucalt": {
"title": "Addcucalt",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Addcuchtml": {
"title": "Addcuchtml",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Addcucpager": {
"title": "Addcucpager",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Addcucphone": {
"title": "Addcucphone",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Addcucsms": {
"title": "Addcucsms",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Addcucsmtp": {
"title": "Addcucsmtp",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Addcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
},
{
"Delcucalt": {
"title": "Delcucalt",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Delcuchtml": {
"title": "Delcuchtml",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Delcucpager": {
"title": "Delcucpager",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Delcucphone": {
"title": "Delcucphone",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Delcucsms": {
"title": "Delcucsms",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Delcucsmtp": {
"title": "Delcucsmtp",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dced0589d77dd0018b5f239/+Delcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
}
],
"model_type": "relation/Voicemail",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd194fe186e30018eb7c58",
"5dced0589d77dd0018b5f239"
],
"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"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"ExitTargetHandlerObjectId": "704e0105-8a32-4b5e-bc96-3ee173b0dcad",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20af568440-8c00-4aae-b349-75ceb1eeaa8b)",
"AddressMode": 0,
"RingPrimaryPhoneFirst": false,
"CreationTime": "2019-11-15T16:20:41Z",
"SayTimestampAfter": true,
"GreetByName": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"SavedMessageSortOrder": 2,
"SpeechSensitivity": 50,
"LdapType": 0,
"ExternalServiceAccountsURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/externalserviceaccounts",
"SaveMessageOnHangup": false,
"EnableVisualMessageLocator": false,
"RepeatMenu": 1,
"UserMailboxURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/mailboxattributes",
"ConversationVui": "VuiStart",
"ObjectId": "af568440-8c00-4aae-b349-75ceb1eeaa8b",
"CommandDigitTimeout": 1500,
"JumpToMessagesOnLogin": true,
"SaySender": true,
"URI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b",
"MessageLocatorSortOrder": 1,
"SynchScheduleURI": "/vmrest/schedules/0e93d77b-9730-48c0-b576-52c1ae5b7524",
"ConfirmDeleteDeletedMessage": false,
"EnableSaveDraft": false,
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20af568440-8c00-4aae-b349-75ceb1eeaa8b)",
"ExitCallActionObjectId": "4f46a966-0019-4bd7-841f-539fe82960f5",
"SayMsgNumber": true,
"SayTotalNewVoice": true,
"ReadOnly": false,
"SaySenderExtension": false,
"SavedMessageStackOrder": "1234567",
"SaySenderExtensionAfter": false,
"DisplayName": "grantcuc",
"InboxAutoRefresh": 15,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"hierarchy_friendly_name": "LOC001 (Site)",
"AnnounceUpcomingMeetings": 60,
"MailboxStoreName": "Unity Messaging Database -1",
"SayAni": false,
"NewMessageSortOrder": 1,
"DtmfNameLast": "5278",
"LocationObjectId": "e21cf6d2-ae77-4cf0-bb98-f94b8550c291",
"PromptSpeed": 100,
"EnAltGreetPreventSkip": false,
"ContinuousAddMode": false,
"PrivateListsURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/privatelists",
"ConfirmDeleteMultipleMessages": true,
"InboxMessagesPerPage": 20,
"EnableMessageBookmark": false,
"ConversationName": "SubMenu",
"UpdateBroadcastMsg": false,
"SayCopiedNames": true,
"SpeechCompleteTimeout": 0,
"MwisURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/mwis",
"VideoServiceAccountsURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/videoserviceaccounts",
"SkipForwardTime": 5000,
"SayMessageLengthAfter": false,
"UseVui": false,
"SpeechConfidenceThreshold": 40,
"FirstDigitTimeout": 5000,
"AddressAfterRecord": false,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"ExitTargetConversation": "PHGreeting",
"DtmfNameLastFirst": "5278",
"PartitionURI": "/vmrest/partitions/99867ff9-d9ae-4470-98b5-6013a2f87793",
"UseBriefPrompts": false,
"SkipPasswordForKnownDevice": false,
"LastName": "last",
"MessageTypeMenu": false,
"SkipReverseTime": 5000,
"RouteNDRToSender": true,
"SayTimestampBefore": false,
"PartitionObjectId": "99867ff9-d9ae-4470-98b5-6013a2f87793",
"SayMsgNumberAfter": false,
"InboxAutoResolveMessageRecipients": true,
"UserWebPasswordURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/credential/password",
"EnAltGreetPreventMsg": false,
"AutoAdvanceMsgs": false,
"EnAltGreetDontRingPhone": false,
"templateAlias": "voicemailusertemplate",
"EnableMessageLocator": false,
"CreateSmtpProxyFromCorp": false,
"IsSetForVmEnrollment": true,
"UseDynamicNameSearchWeight": false,
"UserRoleURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/userroles",
"ClockMode": 0,
"IsTemplate": false,
"ConversationTui": "SubMenu",
"DtmfNameFirstLast": "5278",
"ConfirmationConfidenceThreshold": 60,
"Undeletable": false,
"SendMessageOnHangup": 1,
"EncryptPrivateMessages": false,
"SayTotalReceipts": false,
"NewMessageStackOrder": "1234567",
"NotificationDevicesURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/notificationdevices",
"IsVmEnrolled": true,
"EnableTts": true,
"SearchByExtensionSearchSpaceObjectId": "bec6f1a2-1297-4974-a365-24cf3ce094db",
"PcaAddressBookRowsPerPage": 5,
"LocationURI": "/vmrest/locations/connectionlocations/e21cf6d2-ae77-4cf0-bb98-f94b8550c291",
"SayDistributionList": true,
"SendBroadcastMsg": false,
"ExitAction": 2,
"VoiceNameRequired": false,
"SearchByExtensionSearchSpaceURI": "/vmrest/searchspaces/bec6f1a2-1297-4974-a365-24cf3ce094db",
"MessageHandlersURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/messagehandlers",
"SayTotalNewFax": false,
"CallHandlerObjectId": "74d8c367-f7f2-4ca8-b2ce-bf0b4539b019",
"TimeZone": 140,
"SaySenderAfter": false,
"NameConfirmation": false,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001",
"SearchByNameSearchSpaceURI": "/vmrest/searchspaces/bec6f1a2-1297-4974-a365-24cf3ce094db",
"EnablePersonalRules": true,
"ConfirmDeleteMessage": false,
"SynchScheduleObjectId": "0e93d77b-9730-48c0-b576-52c1ae5b7524",
"Language": 1033,
"RecordUnknownCallerName": true,
"CallAnswerTimeout": 4,
"Volume": 50,
"SayTotalSaved": true,
"InterdigitDelay": 3000,
"CosURI": "/vmrest/coses/bd71db3f-e79f-40a7-89b0-fea1578b77ad",
"SmtpAddress": "grantcuc@cucm",
"RetainUrgentMessageFlag": false,
"SayMessageLength": false,
"ListInDirectory": true,
"CallhandlerURI": "/vmrest/handlers/callhandlers/74d8c367-f7f2-4ca8-b2ce-bf0b4539b019",
"SayAltGreetWarning": false,
"Alias": "grantcuc",
"PromptVolume": 50,
"CosObjectId": "bd71db3f-e79f-40a7-89b0-fea1578b77ad",
"SayTotalDraftMsg": false,
"SayTotalNew": false,
"SayTotalNewEmail": false,
"SpeechIncompleteTimeout": 750,
"UserVoicePinURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/credential/pin",
"Speed": 100,
"AlternateExtensionsURI": "/vmrest/users/af568440-8c00-4aae-b349-75ceb1eeaa8b/alternateextensions",
"SayAniAfter": false,
"IsClockMode24Hour": false,
"UseShortPollForCache": false,
"DtmfAccessId": "3016",
"SearchByNameSearchSpaceObjectId": "bec6f1a2-1297-4974-a365-24cf3ce094db",
"DeletedMessageSortOrder": 2,
"SpeechSpeedVsAccuracy": 50,
"UseDefaultLanguage": true,
"AssistantRowsPerPage": 5
}
},
{
"pkid": "5dcd311c8192d40018f786bb",
"meta": {
"tags": [],
"cached": true,
"title": "Jones",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"self": [
{
"pkid": "5dcd311c8192d40018f786bb",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/",
"class": "delete",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd311c8192d40018f786bb/?model_type=relation/Voicemail",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/help",
"class": "help",
"title": "Help"
}
},
{
"Addcucalt": {
"title": "Addcucalt",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Addcuchtml": {
"title": "Addcuchtml",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Addcucpager": {
"title": "Addcucpager",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Addcucphone": {
"title": "Addcucphone",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Addcucsms": {
"title": "Addcucsms",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Addcucsmtp": {
"title": "Addcucsmtp",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Addcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
},
{
"Delcucalt": {
"title": "Delcucalt",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcucalt/",
"method": "POST",
"schema": "cucalt"
}
},
{
"Delcuchtml": {
"title": "Delcuchtml",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcuchtml/",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Delcucpager": {
"title": "Delcucpager",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcucpager/",
"method": "POST",
"schema": "cucpager"
}
},
{
"Delcucphone": {
"title": "Delcucphone",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcucphone/",
"method": "POST",
"schema": "cucphone"
}
},
{
"Delcucsms": {
"title": "Delcucsms",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcucsms/",
"method": "POST",
"schema": "cucsms"
}
},
{
"Delcucsmtp": {
"title": "Delcucsmtp",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd311c8192d40018f786bb/+Delcucsmtp/",
"method": "POST",
"schema": "cucsmtp"
}
}
],
"model_type": "relation/Voicemail",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd311c8192d40018f786bb"
],
"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"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"VoiceNameRequired": false,
"FirstName": "Adam",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20533a6851-0472-4a2c-b644-8a4cd2187a14)",
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"LastName": "Pjones",
"MessageHandlersURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/messagehandlers",
"CreationTime": "2018-12-18 07:32:17.52",
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "Adam Pjones",
"hierarchy_friendly_name": "Overton (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"Language": 1033,
"MailboxStoreName": "Unity Messaging Database -1",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"ExternalServiceAccountsURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/externalserviceaccounts",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"UserRoleURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/userroles",
"CosURI": "/vmrest/coses/3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"UserMailboxURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/mailboxattributes",
"ObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"PrivateListsURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/privatelists",
"CallhandlerURI": "/vmrest/handlers/callhandlers/f4cbb4c7-a7d8-4585-91f1-1b0dcde329f3",
"CosObjectId": "3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"URI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14",
"Alias": "Jones",
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20533a6851-0472-4a2c-b644-8a4cd2187a14)",
"UserVoicePinURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/credential/pin",
"MwisURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/mwis",
"UserWebPasswordURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/credential/password",
"CallHandlerObjectId": "f4cbb4c7-a7d8-4585-91f1-1b0dcde329f3",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/notificationdevices",
"VideoServiceAccountsURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/videoserviceaccounts",
"AlternateExtensionsURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14/alternateextensions",
"DtmfAccessId": "3002",
"EmailAddress": "",
"ListInDirectory": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd310d8192d40018f7844b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "drich01",
"business_key": {},
"schema_version": "1.9",
"references": {
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"self": [
{
"pkid": "5dcd310d8192d40018f7844b",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/"
}
],
"children": [],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd310d8192d40018f7844b/?hierarchy=[hierarchy]&model_type=relation/Voicemail",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"Addcucalt": {
"title": "Addcucalt",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucalt/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucalt"
}
},
{
"Addcuchtml": {
"title": "Addcuchtml",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcuchtml/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Addcucpager": {
"title": "Addcucpager",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucpager/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucpager"
}
},
{
"Addcucphone": {
"title": "Addcucphone",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucphone/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucphone"
}
},
{
"Addcucsms": {
"title": "Addcucsms",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucsms/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucsms"
}
},
{
"Addcucsmtp": {
"title": "Addcucsmtp",
"support_async": true,
"submit": "payload",
"class": "add",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Addcucsmtp/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucsmtp"
}
},
{
"Delcucalt": {
"title": "Delcucalt",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucalt/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucalt"
}
},
{
"Delcuchtml": {
"title": "Delcuchtml",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcuchtml/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cuchtml"
}
},
{
"Delcucpager": {
"title": "Delcucpager",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucpager/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucpager"
}
},
{
"Delcucphone": {
"title": "Delcucphone",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucphone/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucphone"
}
},
{
"Delcucsms": {
"title": "Delcucsms",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucsms/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucsms"
}
},
{
"Delcucsmtp": {
"title": "Delcucsmtp",
"support_async": true,
"submit": "payload",
"class": "delete",
"href": "/api/relation/Voicemail/5dcd310d8192d40018f7844b/+Delcucsmtp/?hierarchy=[hierarchy]",
"method": "POST",
"schema": "cucsmtp"
}
}
],
"model_type": "relation/Voicemail",
"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"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"VoiceNameRequired": false,
"FirstName": "Don",
"SmtpProxyAddressesURI": "/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20db83873f-bb81-4529-b901-46e8c6318f0f)",
"LastName": "Rich",
"MessageHandlersURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/messagehandlers",
"CreationTime": "2018-12-18T13:26:28Z",
"Callhandler": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/callhandlerowners",
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"Transfer": [
{
"TransferHoldingMode": 0,
"TransferOptionType": "Alternate",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TransferConfirm": false,
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"PersonalCallTransfer": false,
"Extension": "4000",
"Enabled": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions/Alternate",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 1,
"TransferType": 0,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"TransferHoldingMode": 0,
"TransferOptionType": "Off Hours",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TransferConfirm": false,
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"PersonalCallTransfer": false,
"Extension": "4000",
"Enabled": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions/Off%20Hours",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 1,
"TransferType": 0,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"Action": 1,
"TransferHoldingMode": 0,
"PersonalCallTransfer": false,
"Extension": "4000",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TransferOptionType": "Standard",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TransferRings": 4,
"Enabled": true,
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions/Standard",
"UsePrimaryExtension": true,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TransferScreening": false,
"TransferAnnounce": false,
"TransferIntroduce": false,
"TransferConfirm": false,
"TransferDtDetect": false,
"RnaAction": 1,
"PlayTransferPrompt": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TransferType": 0
}
],
"CreationTime": "2018-12-18T13:26:28Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "drich01",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"RecipientSubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceObjectId": "44a9d3bd-7069-4bd3-ac59-9281440c521a",
"Language": 1033,
"UseCallLanguage": true,
"ScheduleSetObjectId": "49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries",
"IsPrimary": true,
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"ObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TransferOptionsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceURI": "/vmrest/searchspaces/44a9d3bd-7069-4bd3-ac59-9281440c521a",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/greetings",
"AfterMessageTargetHandlerObjectId": "f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"SendUrgentMsg": 0,
"CallhandlerMenuEntry": [
{
"Locked": true,
"ObjectId": "7248a9a8-4e69-4b92-a3d1-a73a8ff8e57c",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/*",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "*",
"TargetConversation": "SubSignIn",
"Action": 2
},
{
"Locked": true,
"ObjectId": "609bb3e8-326a-43e8-9342-e02c09eb0c76",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/%23",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "#",
"Action": 5
},
{
"Locked": false,
"ObjectId": "8bbe927f-85f9-4dc8-a162-cbea12c57e8c",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/0",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "0",
"TargetConversation": "PHTransfer",
"Action": 2,
"TargetHandlerObjectId": "2396117c-3e6f-47bc-ae11-7d5191338671"
},
{
"Locked": false,
"ObjectId": "d8cb9694-04eb-4c20-8697-4949f31ac55e",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/1",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "1",
"Action": 0
},
{
"Locked": false,
"ObjectId": "af225b43-3edf-43cf-89de-e14fdb9cb995",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/2",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "2",
"Action": 0
},
{
"Locked": false,
"ObjectId": "e9723e96-7a61-48a8-962f-70b394812959",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/3",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "3",
"Action": 0
},
{
"Locked": false,
"ObjectId": "a25dff55-5183-4267-acbc-d53384075d4c",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/4",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "4",
"Action": 0
},
{
"Locked": false,
"ObjectId": "20f3f52f-d5e7-4ad3-a59b-403cbd3713e6",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/5",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "5",
"Action": 0
},
{
"Locked": false,
"ObjectId": "89bfaae1-3843-4fec-9702-296fdf463488",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/9",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "9",
"Action": 0
},
{
"Locked": false,
"ObjectId": "e72f2d74-3838-4de3-a385-2d9705fb7134",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/8",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "8",
"Action": 0
},
{
"Locked": false,
"ObjectId": "8a33d4a4-99bd-4f16-93f8-3f198c6b2327",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/7",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "7",
"Action": 0
},
{
"Locked": false,
"ObjectId": "2bd80ff0-8013-469f-8013-2409bda7b5d1",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries/6",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"TouchtoneKey": "6",
"Action": 0
}
],
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"Owner": [],
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
},
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "Don Rich",
"cucsmtp": [
{
"MaxBody": 512,
"MaxSubject": 64,
"DisplayName": "SMTP",
"DeviceName": "SMTP",
"ObjectId": "7e515053-027e-47d5-b9a1-5103147635e8",
"UrgentOnly": false,
"EventList": "NewVoiceMail",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"VoiceMessage": false,
"SendCallerId": true,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/smtpdevices/7e515053-027e-47d5-b9a1-5103147635e8",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"InitialDelay": 0,
"RepeatNotify": false,
"SendCount": true,
"SendPcaLink": false,
"Active": false,
"RepeatInterval": 0,
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"Undeletable": true
}
],
"cucphone": [
{
"DisplayName": "Work Phone",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"BusyRetryInterval": 5,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"MaxSubject": 64,
"MaxBody": 512,
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"Active": false,
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "44463634-7d32-4d99-9dc8-25c565d48f16",
"DeviceName": "Work Phone",
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/phonedevices/44463634-7d32-4d99-9dc8-25c565d48f16",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"RingsToWait": 4,
"WaitConnect": true,
"InitialDelay": 0,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TransmitForcedAuthorizationCode": false
},
{
"DisplayName": "Home Phone",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"BusyRetryInterval": 5,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"MaxSubject": 64,
"MaxBody": 512,
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"Active": false,
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "d9fb3df5-4f03-4701-b51b-4e4eddd2a8c9",
"DeviceName": "Home Phone",
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/phonedevices/d9fb3df5-4f03-4701-b51b-4e4eddd2a8c9",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"RingsToWait": 4,
"WaitConnect": true,
"InitialDelay": 0,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TransmitForcedAuthorizationCode": false
},
{
"DisplayName": "Mobile Phone",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"BusyRetryInterval": 5,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"MaxSubject": 64,
"MaxBody": 512,
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"Active": false,
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "83c48949-7f1b-4520-aff7-a090b40bbfcd",
"DeviceName": "Mobile Phone",
"EventList": "NewVoiceMail",
"DetectTransferLoop": false,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/phonedevices/83c48949-7f1b-4520-aff7-a090b40bbfcd",
"DialDelay": 1,
"Conversation": "SubNotify",
"PromptForId": false,
"Undeletable": true,
"RingsToWait": 4,
"WaitConnect": true,
"InitialDelay": 0,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TransmitForcedAuthorizationCode": false
}
],
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"ObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"MailboxStoreName": "Unity Messaging Database -1",
"cucpin": {
"DoesntExpire": false,
"Locked": false,
"ObjectId": "b1ac2406-8629-4f28-ba88-9562574ff220",
"TimeChanged": "2018-12-18 13:26:34.584",
"CantChange": false,
"IsPrimary": false,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/pin",
"CredentialType": 4,
"Alias": "drich01",
"HackCount": 0,
"Hacked": false,
"CredentialPolicyObjectId": "a8ddf5dd-3fa4-4011-8262-4f6fb2847eaa",
"Credentials": "",
"UserObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"CredMustChange": false
},
"cucpager": [
{
"SuccessRetryInterval": 1,
"DisplayName": "Pager",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"InitialDelay": 0,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"RetriesOnSuccess": 0,
"SendCount": true,
"MaxSubject": 64,
"DeviceName": "Pager",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"Active": false,
"RnaRetryInterval": 15,
"RetriesOnBusy": 4,
"RepeatInterval": 0,
"ObjectId": "400dca57-60b9-4f9c-a817-2698886f54ad",
"MaxBody": 512,
"EventList": "NewVoiceMail",
"SendCallerId": true,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/pagerdevices/400dca57-60b9-4f9c-a817-2698886f54ad",
"DialDelay": 1,
"Undeletable": true,
"RingsToWait": 4,
"WaitConnect": true,
"BusyRetryInterval": 5,
"RetriesOnRna": 4,
"RepeatNotify": false,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"TransmitForcedAuthorizationCode": false
}
],
"cucuma": [],
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"ExternalServiceAccountsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/externalserviceaccounts",
"cucsms": [],
"UserRoleURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/userroles",
"CosURI": "/vmrest/coses/3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"UserMailboxURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/mailboxattributes",
"Language": 1033,
"PrivateListsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/privatelists",
"CallhandlerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"CosObjectId": "3d350406-1e70-4cf7-a9a3-1336ddbb7e6a",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"cucpass": {
"DoesntExpire": false,
"Locked": false,
"EncryptionType": 3,
"TimeChanged": "2018-12-18 13:26:28.876",
"CantChange": false,
"IsPrimary": false,
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/password",
"CredentialType": 3,
"Alias": "drich01",
"HackCount": 0,
"Hacked": false,
"CredentialPolicyObjectId": "ba1ca0ff-257b-4875-9572-74fc25353f2e",
"Credentials": "",
"UserObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"ObjectId": "0848085d-8d91-4cc4-9372-4a88ed9c0d4d",
"CredMustChange": false
},
"Alias": "drich01",
"cucalt": [],
"cuchtml": [
{
"DeviceName": "HTML",
"SendScheduledNotificationAt": "",
"DisplayName": "HTML Missed Call",
"ObjectId": "757d7dd4-0a79-4929-be0a-c66012031c44",
"DisableMobileNumberFromPCA": false,
"EventList": "NewMissedCall",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"DisableTemplateSelectionFromPCA": false,
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/htmldevices/757d7dd4-0a79-4929-be0a-c66012031c44",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"AllowVoiceMailAsAttachment": false,
"MessageCountInSummary": 10,
"NotificationTemplateID": "a682a515-e9ae-4545-81e5-2d6407dfc044",
"Active": false,
"Undeletable": true
},
{
"DeviceName": "HTML",
"SendScheduledNotificationAt": "",
"DisplayName": "HTML",
"ObjectId": "f8c75157-bdcf-4b1d-8fdd-6d770c05451c",
"DisableMobileNumberFromPCA": false,
"EventList": "NewVoiceMail",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"DisableTemplateSelectionFromPCA": false,
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/htmldevices/f8c75157-bdcf-4b1d-8fdd-6d770c05451c",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"AllowVoiceMailAsAttachment": false,
"MessageCountInSummary": 10,
"NotificationTemplateID": "3f97ff1a-49d2-443c-9211-45cc40e70d83",
"Active": false,
"Undeletable": true
},
{
"DeviceName": "HTML",
"SendScheduledNotificationAt": "",
"DisplayName": "HTML Scheduled Summary",
"ObjectId": "a171df98-4e7f-4fdf-9c88-8c2d2a7fc13f",
"DisableMobileNumberFromPCA": false,
"EventList": "",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"DisableTemplateSelectionFromPCA": false,
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices/htmldevices/a171df98-4e7f-4fdf-9c88-8c2d2a7fc13f",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"AllowVoiceMailAsAttachment": false,
"MessageCountInSummary": 10,
"NotificationTemplateID": "accc3e67-09e1-4fc4-ae90-f4c97d639358",
"Active": false,
"Undeletable": true
}
],
"AlternateNamesURI": "/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20db83873f-bb81-4529-b901-46e8c6318f0f)",
"UserVoicePinURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/pin",
"MwisURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/mwis",
"UserWebPasswordURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/credential/password",
"CallHandlerObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"IsVmEnrolled": true,
"NotificationDevicesURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/notificationdevices",
"VideoServiceAccountsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/videoserviceaccounts",
"AlternateExtensionsURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/alternateextensions",
"DtmfAccessId": "4000",
"cucmsghandler": {
"ObjectId": "73a51eac-f8ba-4e86-9519-5404d6fc8bcd",
"SubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"URI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f/messagehandlers/73a51eac-f8ba-4e86-9519-5404d6fc8bcd",
"UserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"EmailAction": 1,
"FaxAction": 1,
"VoicemailAction": 1,
"DeliveryReceiptAction": 1
},
"ListInDirectory": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/Voicemail. | GET | /api/relation/Voicemail/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/Voicemail as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/Voicemail/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/Voicemail/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/Voicemail | 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 relation/Voicemail; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/Voicemail/[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 relation/Voicemail and the JSON format can be used to import instances of relation/Voicemail.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/Voicemail/[pkid]/ | hierarchy=[hierarchy] | The relation/Voicemail instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/Voicemail/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/Voicemail. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcucalt | POST | /api/relation/Voicemail/[pkid]/+Addcucalt/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcuchtml | POST | /api/relation/Voicemail/[pkid]/+Addcuchtml/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcucpager | POST | /api/relation/Voicemail/[pkid]/+Addcucpager/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcucphone | POST | /api/relation/Voicemail/[pkid]/+Addcucphone/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcucsms | POST | /api/relation/Voicemail/[pkid]/+Addcucsms/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Addcucsmtp | POST | /api/relation/Voicemail/[pkid]/+Addcucsmtp/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcucalt | POST | /api/relation/Voicemail/[pkid]/+Delcucalt/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcuchtml | POST | /api/relation/Voicemail/[pkid]/+Delcuchtml/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcucpager | POST | /api/relation/Voicemail/[pkid]/+Delcucpager/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcucphone | POST | /api/relation/Voicemail/[pkid]/+Delcucphone/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcucsms | POST | /api/relation/Voicemail/[pkid]/+Delcucsms/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delcucsmtp | POST | /api/relation/Voicemail/[pkid]/+Delcucsmtp/ | hierarchy=[hierarchy] | If payload required: |