[Index]
Model ref.: relation/CallhandlerREL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"VoiceName": {
"minItems": 0,
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName",
"title": "Voice Name"
},
"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]
},
"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_model_type": "device/cuc/Callhandler",
"description": " The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"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"
},
"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"
},
"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]
},
"HF": {
"type": "object",
"properties": {
"cuc_info": {
"type": "string",
"description": "Informative (non-input) field. Indicates the target CUCx host/IP, which is automatically derived from the input NDL.",
"title": "Cisco Unity Connection"
},
"target_ndl": {
"type": "string",
"description": "Mandatory input-field for the Add use-case (if hierarchy is at Site-node, however, this value is derived automatically). The workflow (and GUIRules) will target the UC devices that is linked to this Network Device List (NDL). In the Mod use-case, this should also be derived automatically and can thus be omitted from Updates.",
"title": "Network Device List"
},
"greetings_tab_message": {
"type": "string",
"description": "Greetings",
"title": "Message"
},
"route_list": {
"type": "string",
"description": "The Cisco Unified CM Route List to use. (The valid options are dependent on the selected NDL / CUCM)",
"title": "Route List"
},
"owners_message": {
"type": "string",
"description": "(fields will become available after new item has been saved)",
"title": "Message"
},
"callerInput_tab_message": {
"type": "string",
"description": "Caller Input",
"title": "Message"
},
"hierarchy_type": {
"type": "string",
"description": "Hidden (internal-only) helper field to store hierarchy type string (e.g. 'Site' or 'Customer')",
"title": "Hierarchy Type"
},
"do_not_add_rp": {
"type": "boolean",
"description": "Check this option to bypass Route Pattern addition",
"title": "Do not add Route Pattern"
},
"cuc_template": {
"type": "string",
"description": "Select the Cisco Unity Connection Call Handler Template. (The valid options are dependent on the selected NDL / CUCx)",
"title": "Call Handler Template"
},
"cucm_info": {
"type": "string",
"description": "Informative (non-input) field. Indicates the target CUCM host/IP, which is automatically derived from the input NDL.",
"title": "Cisco Unified CM"
},
"transfer_rules_message": {
"type": "string",
"description": "(fields will become available after new item has been saved)",
"title": "Message"
}
},
"title": "Hf"
},
"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"
},
"Language": {
"description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.",
"title": "Language",
"minItems": 0,
"choices": [
[
1033,
"English(UnitedStates)"
]
],
"type": "integer",
"name": "Language"
},
"UseCallLanguage": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.",
"name": "UseCallLanguage",
"title": "Use Call 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]
},
"templateObjectId": {
"target_title": "DisplayName",
"target_model_type": "device/cuc/CallhandlerTemplate",
"description": "Query parameter",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/CallhandlerTemplate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Template",
"type": "string",
"name": "templateObjectId"
},
"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"
},
"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]
},
"AfterMessageAction": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "After Message Action",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
5,
"Skip Greeting"
],
[
6,
"Restart Greeting"
],
[
7,
"Transfer to Alternate Contact Number"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "AfterMessageAction"
},
"PostGreetingRecordingObjectId": {
"target_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"
},
"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"
},
"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"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"LocalizationKey": {
"type": "string",
"description": "Localization Key for Timezone update.",
"name": "LocalizationKey",
"title": "Localization Key"
},
"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]
},
"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"
},
"Upload": {
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "Upload a greeting to the selected Call Handler.",
"title": "Message"
},
"specific_greeting": {
"type": "boolean",
"description": "Specific Greeting",
"title": "Specific Greeting"
},
"call_handler": {
"type": "string",
"description": "Call Handler Name",
"title": "Call Handler Name"
},
"greeting": {
"type": "string",
"description": "Greetings",
"title": "Greetings"
},
"filename": {
"type": "string",
"description": "Greeting File Name",
"title": "Greeting File"
}
},
"title": "Upload"
},
"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]
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"SendPrivateMsg": {
"description": " Determines if an outside caller can mark their message as private.",
"title": "Message Sensitivity",
"minItems": 0,
"choices": [
[
0,
"Mark Normal"
],
[
1,
"Mark Urgent"
],
[
2,
"Ask Callers"
]
],
"type": "integer",
"name": "SendPrivateMsg"
},
"SendSecureMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether an unidentified caller can mark a message as \"secure.\"",
"name": "SendSecureMsg",
"title": "Send Secure Msg"
},
"Greeting": {
"items": {
"type": "object",
"properties": {
"IgnoreDigits": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection takes action in response to touchtone keys pressed by callers during the greeting.",
"name": "IgnoreDigits",
"title": "Ignore Digits"
},
"PlayWhat": {
"description": " The source for the greeting when this greeting is active.",
"title": "Callers Hear",
"minItems": 0,
"choices": [
[
0,
"System Default Greeting"
],
[
1,
"My Personal Recording"
],
[
2,
"Nothing"
]
],
"type": "integer",
"name": "PlayWhat"
},
"PlayRecordMessagePrompt": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the ?Record your message at the tone?? prompt prior to recording a message.",
"name": "PlayRecordMessagePrompt",
"title": "Play Record Message Prompt"
},
"AfterGreetingTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "AfterGreetingTargetConversation",
"title": "After Greeting Target Conversation"
},
"GreetingType": {
"description": " The type of greeting, e.g. \"Standard,\" \"Off Hours,\" \"Busy,\" etc. - template parameter [2]",
"title": "Greeting Type",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "GreetingType"
},
"AfterGreetingTargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "AfterGreetingTargetHandlerObjectId",
"title": "After Greeting Target Handler Object Id"
},
"AfterGreetingAction": {
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"title": "After Greeting",
"minItems": 0,
"choices": [
[
0,
"Ignore"
],
[
1,
"Hang Up"
],
[
2,
"OTHER (conversation, etc)"
],
[
4,
"Take Message"
],
[
6,
"Restart Greeting"
],
[
8,
"Route From Next Call Routing Rule"
]
],
"type": "integer",
"name": "AfterGreetingAction"
},
"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]
},
"GreetingStreamFilesURI": {
"name": "GreetingStreamFilesURI",
"format": "uri",
"minItems": 0,
"title": "Greeting Stream Files URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"RepromptDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in seconds) that Cisco Unity Connection waits without receiving any input from a caller before Cisco Unity Connection prompts the caller again.",
"name": "RepromptDelay",
"title": "Reprompt Delay"
},
"Reprompts": {
"minItems": 0,
"type": "integer",
"description": " The number of times to reprompt a caller. After the number of times indicated here, Cisco Unity Connection performs the after-greeting action. ",
"name": "Reprompts",
"title": "Reprompts"
},
"CallHandlerObjectId": {
"target_model_type": "device/cuc/Callhandler",
"description": " The unique identifier of the CallHandler object to which this greeting rule belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Call Handler Object Id",
"type": [
"string"
],
"name": "CallHandlerObjectId"
},
"EnableTransfer": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating when an extension is dialed at the greeting and the extension is not available whether to transfer to another extension.",
"name": "EnableTransfer",
"title": "Enable Transfer"
},
"EnablePersonalVideoRecording": {
"minItems": 0,
"type": "boolean",
"description": " It will Enable the Personal video Recording in CUCA.",
"name": "EnablePersonalVideoRecording",
"title": "Enable Personal Video Recording"
},
"PlayRecordVideoMessagePrompt": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the ?Record your message at the tone?? prompt prior to Video recording a message.",
"name": "PlayRecordVideoMessagePrompt",
"title": "Play Record Video Message Prompt"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"format": "uri",
"minItems": 0,
"title": "Callhandler URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeExpires": {
"minItems": 0,
"type": "string",
"description": " The date and time when the greeting rule expires. The greeting rule is considered not expired (enabled), if the value is NULL or a future date. The greeting rule is considered expired (disabled), the value is in the past.",
"name": "TimeExpires",
"title": "Time Expires"
}
}
},
"type": "array",
"title": "Greeting"
},
"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"
},
"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]
},
"User": {
"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"
},
"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"
},
"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"
},
"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"
},
"IsTemplate": {
"description": " A flag indicating whether this instance of a User object is a \"template\" for creating new users. ",
"title": "Is Template",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "IsTemplate"
},
"DtmfNameLastFirst": {
"minItems": 0,
"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"
},
"CcmId": {
"minItems": 0,
"type": "string",
"description": " Id of associated EndUser, ApplicationUser, or DirectoryNumber in Call Manager",
"name": "CcmId",
"title": "Ccm Id"
},
"LdapType": {
"description": " The LDAP configuration information for the user.",
"title": "Ldap Type",
"minItems": 0,
"choices": [
[
0,
"Do not Integrate with LDAP directory"
],
[
1,
"Integrate with LDAP directory"
],
[
2,
"Authenticate"
],
[
3,
"Integrate and Authenticate with LDAP directory"
],
[
4,
"Inactive"
]
],
"type": "integer",
"name": "LdapType"
},
"ExternalServiceAccountsURI": {
"name": "ExternalServiceAccountsURI",
"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]
},
"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"
},
"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"
},
"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"
},
"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"
},
"ReadOnly": {
"description": " If set to 1 (true) user is read-only and cannot be modified.",
"title": "Read Only",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "ReadOnly"
},
"SaySenderExtension": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection during message playback, plays the primary extension information of the subscriber who sent the message after playing the sender's voice name.",
"name": "SaySenderExtension",
"title": "Say Sender Extension"
},
"SavedMessageStackOrder": {
"minItems": 0,
"type": "string",
"description": " The order in which Cisco Unity Connection plays the following types of \"saved\" messages:\n* Urgent voice messages\n* Non-urgent voice messages\n* Urgent fax messages\n* Non-urgent fax messages\n* Urgent e-mail messages\n* Non-urgent e-mail messages\n* Receipts and notices",
"name": "SavedMessageStackOrder",
"title": "Saved Message Stack Order"
},
"SaySenderExtensionAfter": {
"minItems": 0,
"type": "boolean",
"description": " This flag works exactly the same as the SaySenderExtension flag on a user, except the conversation plays the sender's extension in the message footer.",
"name": "SaySenderExtensionAfter",
"title": "Say Sender Extension After"
},
"DisplayName": {
"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": {
"description": " The order in which Cisco Unity Connection will sort new messages.",
"title": "New Message Sort Order",
"minItems": 0,
"choices": [
[
1,
"Newest first"
],
[
2,
"Oldest first"
]
],
"type": "integer",
"name": "NewMessageSortOrder"
},
"TimeLastCall": {
"minItems": 0,
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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]
},
"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"
},
"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"
},
"EnableMessageBookmark": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Message Bookmark is enabled for the subscriber",
"name": "EnableMessageBookmark",
"title": "Enable Message Bookmark"
},
"InboxMessagesPerPage": {
"minItems": 0,
"type": "integer",
"description": " The number of messages Unity Inbox displays in a page.",
"name": "InboxMessagesPerPage",
"title": "Inbox Messages Per Page"
},
"PabLastImported": {
"minItems": 0,
"type": "string",
"description": " The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.",
"name": "PabLastImported",
"title": "Pab Last Imported"
},
"PcaHomePage": {
"minItems": 0,
"type": "string",
"description": " The Home Page is the first page that is displayed after logging in to the PCA. ",
"name": "PcaHomePage",
"title": "Pca Home Page"
},
"UpdateBroadcastMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.",
"name": "UpdateBroadcastMsg",
"title": "Update Broadcast Msg"
},
"SayCopiedNames": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection announces the \"copied\" names during message playback for a subscriber. ",
"name": "SayCopiedNames",
"title": "Say Copied Names"
},
"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"
},
"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]
},
"UserWebPasswordURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the web application password.",
"name": "UserWebPasswordURI",
"title": "User Web Password URI"
},
"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"
},
"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"
},
"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"
},
"MessageTypeMenu": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays the message type menu when the subscriber logs on to Cisco Unity Connection over the phone. ",
"name": "MessageTypeMenu",
"title": "Message Type Menu"
},
"SkipReverseTime": {
"minItems": 0,
"type": "integer",
"description": " Indicates the amount of time (in milliseconds) to jump backward when skipping in reverse in a voice or TTS message using either DTMF or voice commands while reviewing messages.",
"name": "SkipReverseTime",
"title": "Skip Reverse Time"
},
"RouteNDRToSender": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating, for an undeliverable message, whether NDR messages will appear in the subscriber's mailbox or are deleted by the system.",
"name": "RouteNDRToSender",
"title": "Route NDR To Sender"
},
"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]
},
"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"
},
"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"
},
"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"
},
"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"
},
"ForcedAuthorizationCode": {
"minItems": 0,
"type": "string",
"description": " A valid authorization code that is entered prior to extending calls to classes of dialed numbers, for example, external, toll and international calls.",
"name": "ForcedAuthorizationCode",
"title": "Forced Authorization Code"
},
"EnAltGreetPreventMsg": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether callers can leave a message after the greeting when the subscriber alternate greeting is turned on.",
"name": "EnAltGreetPreventMsg",
"title": "En Alt Greet Prevent Msg"
},
"AutoAdvanceMsgs": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating that the conversation will, during playback, advance to the next message in the playback stack automatically after it is done playing the after message menu.",
"name": "AutoAdvanceMsgs",
"title": "Auto Advance Msgs"
},
"EnAltGreetDontRingPhone": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a caller is prevented from being transferred to the subscriber phone when the subscriber alternate greeting is turned on.",
"name": "EnAltGreetDontRingPhone",
"title": "En Alt Greet Dont Ring Phone"
},
"templateAlias": {
"target_model_type": "device/cuc/UserTemplate",
"description": "Query parameter",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "Alias",
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Template Alias",
"type": [
"string"
],
"name": "templateAlias"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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_model_type": "device/cuc/MailboxStore",
"description": "Mailbox Store for the tenant.",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"LocalizationKey": {
"type": "string",
"description": "Localization Key.",
"name": "LocalizationKey",
"title": "Localization Key"
},
"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"
},
"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"
},
"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"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"format": "uri",
"minItems": 0,
"title": "Callhandler URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayAltGreetWarning": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection notifies the subscriber when they login via the phone (plays conversation) or CPCA (displays a warning banner) if their alternate greeting is turned on.",
"name": "SayAltGreetWarning",
"title": "Say Alt Greet Warning"
},
"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"
},
"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"
},
"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"
},
"UserVoicePinURI": {
"readonly": true,
"type": "string",
"description": "The URI to change the voice mail pin of the user.",
"name": "UserVoicePinURI",
"title": "User Voice Pin URI"
},
"LdapCcmPkid": {
"minItems": 0,
"type": "string",
"description": " The pkid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmPkid",
"title": "Ldap Ccm Pkid"
},
"Speed": {
"minItems": 0,
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back messages to the subscriber.",
"name": "Speed",
"title": "Speed"
},
"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"
},
"DtmfAccessId": {
"description": "The DTMF access id (i.e., extension) of the subscriber. The dialable number.",
"title": "Dtmf Access Id",
"minItems": 0,
"required": true,
"type": "string",
"name": "DtmfAccessId"
},
"FaxServerURI": {
"name": "FaxServerURI",
"format": "uri",
"minItems": 0,
"title": "Fax Server URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"BillingId": {
"minItems": 0,
"type": "string",
"description": " Accounting information or project code associated with this user.",
"name": "BillingId",
"title": "Billing Id"
},
"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"
},
"DeletedMessageSortOrder": {
"minItems": 0,
"type": "integer",
"description": " The order in which Cisco Unity Connection presents deleted messages to the subscriber.",
"name": "DeletedMessageSortOrder",
"title": "Deleted Message Sort Order"
},
"SpeechSpeedVsAccuracy": {
"minItems": 0,
"type": "integer",
"description": " Tunes the engine towards Performance or Accuracy. A higher value for this setting means faster matches that may be less accurate. A lower value for this setting means more accurate matches along with more processing and higher CPU utilization.\n",
"name": "SpeechSpeedVsAccuracy",
"title": "Speech Speed Vs Accuracy"
},
"UseDefaultLanguage": {
"minItems": 0,
"type": "boolean",
"description": "Set to true (1) if call handler is using default language from the location it belongs to.",
"name": "UseDefaultLanguage",
"title": "Use Default Language"
},
"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"
}
},
"title": "User"
},
"UserObjectId": {
"minItems": 0,
"type": "string",
"name": "UserObjectId",
"title": "User Object Id"
},
"TargetHandlerObjectId": {
"target_model_type": "device/cuc/Callhandler",
"description": " The unique identifier of the Call Handler object for which this distribution list is the owner. - template parameter [1]",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Callhandler/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Target Handler Object Id",
"type": [
"string"
],
"name": "TargetHandlerObjectId"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Owner"
},
"RecordPlayback": {
"type": "object",
"properties": {
"extension": {
"type": "string",
"description": "Extension to Record message on.",
"title": "Extension"
},
"greeting": {
"type": "string",
"description": "Greetings",
"title": "Greetings"
},
"note": {
"type": "string",
"description": "\nPLEASE NOTE! This is a special interface, which allows admins to trigger a call to\na physical device, which allows for recording or playback of a greeting. The\nextension to dial must be an accessible extension for the admin (or user) to answer\nand record or listen to greetings.\n\n1. Select an extension from the drop-down, or manually type in the number of the\n device you want to call to record or listen to a greeting.\n\n2. Select the \u201cSpecific Greeting\u201d checkbox if you want to record or playback a\n greeting for Standard, or Busy, etc. Else the action will apply to the main Call\n Handler.\n\n3. The duration is the time in seconds, that the system will allow to record a\n greeting, and does not apply when playing back a recording. This is an important\n timer, as setting this too low, might result in incorrect configuration.\n\n4. Finally, do not click \u201cSave\u201d on this form, as it will not trigger the workflow to\n but rather go to Action - Record Greeting, or Action - Playback Greeting.",
"title": "Message"
},
"specific_greeting": {
"type": "boolean",
"description": "Specific Greeting",
"title": "Specific Greeting"
},
"call_handler": {
"type": "string",
"description": "Call Handler Name",
"title": "Call Handler Name"
},
"duration": {
"type": "string",
"description": "Duration to allow enough time to make recording/playback.",
"title": "Duration"
}
},
"title": "Record Playback"
},
"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"
},
"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]
}
},
"schema_version": "1.1.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CallhandlerREL/add/ |
|
The GUI Add form of relation/CallhandlerREL 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/CallhandlerREL | 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/CallhandlerREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/CallhandlerREL/[pkid1]", "/api/relation/CallhandlerREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/CallhandlerREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/relation/CallhandlerREL/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/relation/CallhandlerREL/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/relation/CallhandlerREL/[pkid1]", "/api/v0/relation/CallhandlerREL/[pkid2]",...]}} |
GET http://[host-proxy]/api/relation/CallhandlerREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/CallhandlerREL |
|
{"hrefs": ["/api/relation/CallhandlerREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/CallhandlerREL |
|
{"hrefs": ["/api/relation/CallhandlerREL/[pkid1]", "/api/relation/CallhandlerREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/CallhandlerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/CallhandlerREL/export/ |
|
{ "hrefs":["/api/relation/CallhandlerREL/[pkid1]", "/api/relation/CallhandlerREL/[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/CallhandlerREL and the JSON format can be used to import instances of relation/CallhandlerREL.
GET http://[host-proxy]/api/relation/CallhandlerREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CallhandlerREL | POST | /api/relation/CallhandlerREL/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/CallhandlerREL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/CallhandlerREL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/relation/CallhandlerREL/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CallhandlerREL/ |
|
The relation/CallhandlerREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CallhandlerREL instances)
{
"operations": [
"field_display_policy",
"help",
"get",
"export_bulkload_template",
"move",
"update",
"tag",
"export",
"migration",
"configuration_template",
"create",
"list",
"remove",
"add",
"bulk_update",
"bulk_update_form",
"tag_version"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/CallhandlerREL/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 18
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.1.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/CallhandlerREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/CallhandlerREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"create": {
"support_async": true,
"class": "add",
"href": "/api/relation/CallhandlerREL/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Create"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/CallhandlerREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/relation/CallhandlerREL/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/CallhandlerREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/CallhandlerREL/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/CallhandlerREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/CallhandlerREL/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/CallhandlerREL/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/relation/CallhandlerREL/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/CallhandlerREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/CallhandlerREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/CallhandlerREL",
"model_specific_actions": [
"field_display_policy",
"help",
"get",
"export_bulkload_template",
"move",
"update",
"tag",
"export",
"migration",
"configuration_template",
"create",
"list",
"remove",
"add",
"bulk_update_form",
"tag_version"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "IsPrimary",
"title": "Is Primary"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3af405ce894e001208d07b",
"meta": {
"tags": [],
"cached": true,
"title": "acarstel01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af405ce894e001208d07b",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/"
}
],
"parent": [
{
"pkid": "5f3ae64ace894e0012057585",
"href": "/api/data/HierarchyNode/5f3ae64ace894e0012057585"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af405ce894e001208d07b/?model_type=relation/CallhandlerREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/help",
"method": "GET",
"title": "Help"
}
},
{
"PlaybackGreeting": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+PlaybackGreeting/",
"method": "POST",
"title": "Playback Greeting"
}
},
{
"RecordGreeting": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+RecordGreeting/",
"method": "POST",
"title": "Record Greeting"
}
},
{
"Upload": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+Upload/",
"method": "POST",
"title": "Upload"
}
}
],
"model_type": "relation/CallhandlerREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae64ace894e0012057585",
"5f3af405ce894e001208d07b"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "IsPrimary",
"title": "Is Primary"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/callhandlerowners",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"CreationTime": "2020-08-17T21:17:55Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": false,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TimeZone": 100327,
"DisplayName": "acarstel01",
"hierarchy_friendly_name": "CL1-AB-C-Hannover (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"RecipientSubscriberObjectId": "8ad159de-365f-4325-98fe-a1c2690dcbf1",
"CallSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"ObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"UseCallLanguage": true,
"ScheduleSetObjectId": "78182af6-cb63-4a65-be10-a29df6fc82f7",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/78182af6-cb63-4a65-be10-a29df6fc82f7",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries",
"IsPrimary": true,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/8ad159de-365f-4325-98fe-a1c2690dcbf1",
"CallSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings",
"AfterMessageTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"SendUrgentMsg": 0,
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Hannover",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
},
{
"pkid": "5f3af395ce894e001208b93b",
"meta": {
"tags": [],
"cached": true,
"title": "adervers01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af395ce894e001208b93b",
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/"
}
],
"parent": [
{
"pkid": "5f3ae62dce894e0012056f66",
"href": "/api/data/HierarchyNode/5f3ae62dce894e0012056f66"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af395ce894e001208b93b/?model_type=relation/CallhandlerREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"PlaybackGreeting": {
"support_async": true,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/+PlaybackGreeting/",
"title": "Playback Greeting",
"class": "custom",
"method": "POST"
}
},
{
"RecordGreeting": {
"support_async": true,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/+RecordGreeting/",
"title": "Record Greeting",
"class": "custom",
"method": "POST"
}
},
{
"Upload": {
"support_async": true,
"href": "/api/relation/CallhandlerREL/5f3af395ce894e001208b93b/+Upload/",
"title": "Upload",
"class": "custom",
"method": "POST"
}
}
],
"model_type": "relation/CallhandlerREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae62dce894e0012056f66",
"5f3af395ce894e001208b93b"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "IsPrimary",
"title": "Is Primary"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/bb9e1d10-09a0-4567-9e8d-16239b7c23bc/callhandlerowners",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"CreationTime": "2020-08-17 21:16:03.71",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TimeZone": 140,
"DisplayName": "adervers01",
"hierarchy_friendly_name": "CL1-AB-C-Rennes (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"RecipientSubscriberObjectId": "9d2a8c05-ca81-4553-9a55-9d65896d50ab",
"CallSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"ObjectId": "bb9e1d10-09a0-4567-9e8d-16239b7c23bc",
"UseCallLanguage": true,
"ScheduleSetObjectId": "78182af6-cb63-4a65-be10-a29df6fc82f7",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/78182af6-cb63-4a65-be10-a29df6fc82f7",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/bb9e1d10-09a0-4567-9e8d-16239b7c23bc/menuentries",
"IsPrimary": true,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/bb9e1d10-09a0-4567-9e8d-16239b7c23bc/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/9d2a8c05-ca81-4553-9a55-9d65896d50ab",
"CallSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"URI": "/vmrest/handlers/callhandlers/bb9e1d10-09a0-4567-9e8d-16239b7c23bc",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/bb9e1d10-09a0-4567-9e8d-16239b7c23bc/greetings",
"AfterMessageTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"SendUrgentMsg": 0,
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Rennes",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
},
{
"pkid": "5f3af25dce894e0012087925",
"meta": {
"tags": [],
"cached": true,
"title": "fgertrand01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af25dce894e0012087925",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/"
}
],
"parent": [
{
"pkid": "5f3ae621ce894e0012056c72",
"href": "/api/data/HierarchyNode/5f3ae621ce894e0012056c72"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/",
"class": "delete",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5f3af25dce894e0012087925/?model_type=relation/CallhandlerREL",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/help",
"class": "help",
"title": "Help"
}
},
{
"PlaybackGreeting": {
"support_async": true,
"method": "POST",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/+PlaybackGreeting/",
"class": "custom",
"title": "Playback Greeting"
}
},
{
"RecordGreeting": {
"support_async": true,
"method": "POST",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/+RecordGreeting/",
"class": "custom",
"title": "Record Greeting"
}
},
{
"Upload": {
"support_async": true,
"method": "POST",
"href": "/api/relation/CallhandlerREL/5f3af25dce894e0012087925/+Upload/",
"class": "custom",
"title": "Upload"
}
}
],
"model_type": "relation/CallhandlerREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae621ce894e0012056c72",
"5f3af25dce894e0012087925"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "IsPrimary",
"title": "Is Primary"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/26076be5-7ef9-4057-a126-84e364ba64e8/callhandlerowners",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"CreationTime": "2020-08-17T21:10:51Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TimeZone": 140,
"DisplayName": "fgertrand01",
"hierarchy_friendly_name": "CL1-AB-C-Grenoble (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"RecipientSubscriberObjectId": "b4622f27-b945-4c65-847f-689b5faa681b",
"CallSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"Language": 1033,
"UseCallLanguage": true,
"ScheduleSetObjectId": "78182af6-cb63-4a65-be10-a29df6fc82f7",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/78182af6-cb63-4a65-be10-a29df6fc82f7",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/26076be5-7ef9-4057-a126-84e364ba64e8/menuentries",
"IsPrimary": true,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ObjectId": "26076be5-7ef9-4057-a126-84e364ba64e8",
"TransferOptionsURI": "/vmrest/handlers/callhandlers/26076be5-7ef9-4057-a126-84e364ba64e8/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/b4622f27-b945-4c65-847f-689b5faa681b",
"CallSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"URI": "/vmrest/handlers/callhandlers/26076be5-7ef9-4057-a126-84e364ba64e8",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/26076be5-7ef9-4057-a126-84e364ba64e8/greetings",
"AfterMessageTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"SendUrgentMsg": 0,
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Grenoble",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3af405ce894e001208d07b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "acarstel01",
"business_key": {},
"schema_version": "1.1.3",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3af405ce894e001208d07b",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/"
}
],
"children": [],
"parent": [
{
"pkid": "5f3ae64ace894e0012057585",
"href": "/api/data/HierarchyNode/5f3ae64ace894e0012057585"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af405ce894e001208d07b/?hierarchy=[hierarchy]&model_type=relation/CallhandlerREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"PlaybackGreeting": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+PlaybackGreeting/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Playback Greeting"
}
},
{
"RecordGreeting": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+RecordGreeting/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Record Greeting"
}
},
{
"Upload": {
"support_async": true,
"class": "custom",
"href": "/api/relation/CallhandlerREL/5f3af405ce894e001208d07b/+Upload/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Upload"
}
}
],
"model_type": "relation/CallhandlerREL",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
{
"name": "IsPrimary",
"title": "Is Primary"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/callhandlerowners",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"Transfer": [
{
"TransferHoldingMode": 0,
"TransferOptionType": "Alternate",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TransferConfirm": false,
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"PersonalCallTransfer": false,
"Extension": "8201102",
"Enabled": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/transferoptions/Alternate",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 1,
"TransferType": 0,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"TransferHoldingMode": 0,
"TransferOptionType": "Off Hours",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TransferConfirm": false,
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"PersonalCallTransfer": false,
"Extension": "8201102",
"Enabled": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/transferoptions/Off%20Hours",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 1,
"TransferType": 0,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"Action": 1,
"TransferHoldingMode": 0,
"PersonalCallTransfer": false,
"Extension": "8201102",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TransferOptionType": "Standard",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TransferRings": 4,
"Enabled": true,
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/transferoptions/Standard",
"UsePrimaryExtension": true,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TransferScreening": false,
"TransferAnnounce": false,
"TransferIntroduce": false,
"TransferConfirm": false,
"TransferDtDetect": false,
"RnaAction": 1,
"PlayTransferPrompt": true,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"TransferType": 0
}
],
"CreationTime": "2020-08-17T21:17:55Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": false,
"PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876",
"TimeZone": 100327,
"DisplayName": "acarstel01",
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"RecipientSubscriberObjectId": "8ad159de-365f-4325-98fe-a1c2690dcbf1",
"CallSearchSpaceObjectId": "fe52c878-3008-44f6-b6c2-3c19f11260c5",
"ObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"UseCallLanguage": true,
"ScheduleSetObjectId": "78182af6-cb63-4a65-be10-a29df6fc82f7",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/78182af6-cb63-4a65-be10-a29df6fc82f7",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries",
"IsPrimary": true,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/8ad159de-365f-4325-98fe-a1c2690dcbf1",
"CallSearchSpaceURI": "/vmrest/searchspaces/fe52c878-3008-44f6-b6c2-3c19f11260c5",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings",
"AfterMessageTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"SendUrgentMsg": 0,
"CallhandlerMenuEntry": [
{
"Locked": true,
"ObjectId": "5575a2ca-17d1-4cc8-a082-959c89903784",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/*",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "*",
"TargetConversation": "SubSignIn",
"Action": 2
},
{
"Locked": true,
"ObjectId": "e0c2dc46-0e65-4a62-98bc-804be5d30170",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/%23",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "#",
"Action": 5
},
{
"Locked": false,
"ObjectId": "49548660-ffcd-467d-b2bb-f493b7b42a26",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/0",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "0",
"TargetConversation": "PHTransfer",
"Action": 2,
"TargetHandlerObjectId": "665e0113-d95d-4ced-be91-c4df9e43f984"
},
{
"Locked": false,
"ObjectId": "b8fd0f0a-0daa-42e3-a9d1-c86ed519c49c",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/1",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "1",
"Action": 0
},
{
"Locked": false,
"ObjectId": "3e2b46bc-743a-42a4-a584-15b85b4d71f0",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/2",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "2",
"Action": 0
},
{
"Locked": false,
"ObjectId": "dfd153a2-4949-4a9d-a222-35bd805fff10",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/3",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "3",
"Action": 0
},
{
"Locked": false,
"ObjectId": "8e03934e-b5d7-4dcf-8249-dcd436de99a0",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/4",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "4",
"Action": 0
},
{
"Locked": false,
"ObjectId": "2f46881b-309f-4964-85e8-d5697b282382",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/5",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "5",
"Action": 0
},
{
"Locked": false,
"ObjectId": "f818d7cd-6522-45ae-b036-bc74a79ec743",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/6",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "6",
"Action": 0
},
{
"Locked": false,
"ObjectId": "b618acfe-d13c-42be-84a7-14e64585a4af",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/7",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "7",
"Action": 0
},
{
"Locked": false,
"ObjectId": "f2c4858e-6aa7-477e-aef5-09a5475ab71a",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/8",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "8",
"Action": 0
},
{
"Locked": false,
"ObjectId": "7dac7009-c093-47a7-8ea2-d6d5d30d951a",
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/menuentries/9",
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"TouchtoneKey": "9",
"Action": 0
}
],
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"Greeting": [
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Alternate",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Alternate",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Alternate/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Busy",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Busy",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Busy/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"AfterGreetingTargetConversation": "PHGreeting",
"GreetingType": "Error",
"AfterGreetingTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"AfterGreetingAction": 6,
"Enabled": true,
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Error",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Error/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61"
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Internal",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Internal",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Internal/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Off Hours",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Off%20Hours",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Off Hours/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Standard",
"Enabled": true,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Standard",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Standard/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false
},
{
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"GreetingType": "Holiday",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61",
"URI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Holiday",
"GreetingStreamFilesURI": "/vmrest/handlers/callhandlers/6c9912a3-435e-43b9-922a-eb88a18cbd61/greetings/Holiday/greetingstreamfiles",
"RepromptDelay": 2,
"Reprompts": 0,
"CallHandlerObjectId": "6c9912a3-435e-43b9-922a-eb88a18cbd61",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
}
],
"PlayPostGreetingRecording": 0,
"Owner": [],
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/CallhandlerREL. | GET | /api/relation/CallhandlerREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/CallhandlerREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/CallhandlerREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/CallhandlerREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/CallhandlerREL | 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/CallhandlerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/CallhandlerREL/[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/CallhandlerREL and the JSON format can be used to import instances of relation/CallhandlerREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/relation/CallhandlerREL/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CallhandlerREL/[pkid] | hierarchy=[hierarchy] | The relation/CallhandlerREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/CallhandlerREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/CallhandlerREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Playback Greeting | POST | /api/relation/CallhandlerREL/[pkid]/+PlaybackGreeting | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Record Greeting | POST | /api/relation/CallhandlerREL/[pkid]/+RecordGreeting | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Upload | POST | /api/relation/CallhandlerREL/[pkid]/+Upload | hierarchy=[hierarchy] | If payload required: |