[Index]
Model ref.: device/cuc/Callhandler
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]
},
"templateObjectId": {
"target_title": "DisplayName",
"target": "/api/device/cuc/CallhandlerTemplate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Template",
"description": "Query parameter",
"required": false,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/CallhandlerTemplate",
"type": "string",
"name": "templateObjectId"
},
"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]
},
"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"
},
"ScheduleSetObjectId": {
"target_title": "DisplayName",
"description": " The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.",
"title": "Schedule Set",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/ScheduleSet/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/ScheduleSet",
"type": "string",
"name": "ScheduleSetObjectId"
},
"OneKeyDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key.",
"name": "OneKeyDelay",
"title": "One Key Delay"
},
"DispatchDelivery": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating that all messages left for the call handler is for dispatch delivery. ",
"name": "DispatchDelivery",
"title": "Dispatch Delivery"
},
"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"
},
"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]
},
"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"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CallSearchSpaceURI": {
"name": "CallSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Call Search Space URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/Callhandler/add/ |
|
The GUI Add form of device/cuc/Callhandler as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cuc/Callhandler/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cuc/Callhandler/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/Callhandler/[pkid1]", "/api/device/cuc/Callhandler/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/Callhandler/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/Callhandler/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/Callhandler/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Callhandler/[pkid1]", "/api/v0/device/cuc/Callhandler/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Callhandler/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/Callhandler |
|
{"hrefs": ["/api/device/cuc/Callhandler/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Callhandler |
|
{"hrefs": ["/api/device/cuc/Callhandler/[pkid1]", "/api/device/cuc/Callhandler/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Callhandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Callhandler/export/ |
|
{ "hrefs":["/api/device/cuc/Callhandler/[pkid1]", "/api/device/cuc/Callhandler/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/Callhandler and the JSON format can be used to import instances of device/cuc/Callhandler.
GET http://[host-proxy]/api/device/cuc/Callhandler/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Callhandler | POST | /api/device/cuc/Callhandler/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/Callhandler/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/Callhandler/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/Callhandler/ |
|
The device/cuc/Callhandler schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Callhandler instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/Callhandler/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 60
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cuc/Callhandler/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Callhandler/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/Callhandler/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/Callhandler",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Callhandler/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cuc/Callhandler/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/Callhandler/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/Callhandler/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/Callhandler/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Callhandler/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Callhandler/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Callhandler",
"model_specific_actions": [
"add",
"list",
"update",
"get",
"remove",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"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": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd30788192d40018f76541",
"meta": {
"tags": [],
"cached": true,
"title": "drich01",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd30788192d40018f76541",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30788192d40018f76541/?model_type=device/cuc/Callhandler",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Callhandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30788192d40018f76541"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/callhandlerowners",
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"CreationTime": "2018-12-18T13:26:28Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "drich01",
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"RecipientSubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceObjectId": "44a9d3bd-7069-4bd3-ac59-9281440c521a",
"ObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"UseCallLanguage": true,
"ScheduleSetObjectId": "49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries",
"IsPrimary": true,
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceURI": "/vmrest/searchspaces/44a9d3bd-7069-4bd3-ac59-9281440c521a",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/greetings",
"AfterMessageTargetHandlerObjectId": "f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"SendUrgentMsg": 0,
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
},
{
"pkid": "5dcd30ac8192d40018f77284",
"meta": {
"tags": [],
"cached": true,
"title": "Goodbye",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"self": [
{
"pkid": "5dcd30ac8192d40018f77284",
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30ac8192d40018f77284/?model_type=device/cuc/Callhandler",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/Callhandler/5dcd30ac8192d40018f77284/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/Callhandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30ac8192d40018f77284"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"VoiceName": "0b358c59-e807-4db8-b0a5-e097f01d2263.wav",
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"CreationTime": "2017-09-26T09:50:01Z",
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49/callhandlerowners",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"RecipientDistributionListURI": "/vmrest/distributionlists/89e1efd0-d501-42b3-8792-441dc5128bcf",
"TimeZone": 140,
"DisplayName": "Goodbye",
"hierarchy_friendly_name": "Overton (Customer)",
"VoiceNameURI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49/voicename",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"CallSearchSpaceObjectId": "44a9d3bd-7069-4bd3-ac59-9281440c521a",
"ObjectId": "f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"UseCallLanguage": true,
"ScheduleSetObjectId": "6294c08c-f988-453d-a8a0-289cd6aa8749",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/6294c08c-f988-453d-a8a0-289cd6aa8749",
"AfterMessageAction": 1,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49/menuentries",
"IsPrimary": false,
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49/transferoptions",
"IsTemplate": false,
"URI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"CallSearchSpaceURI": "/vmrest/searchspaces/44a9d3bd-7069-4bd3-ac59-9281440c521a",
"SendUrgentMsg": 0,
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/f3b4a8ed-1b10-432c-8fe2-244ec03bce49/greetings",
"Undeletable": true,
"VoiceFileURI": "/vmrest/voicefiles/84de78a1-0142-4b60-864d-a314c894c413",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"RecipientDistributionListObjectId": "89e1efd0-d501-42b3-8792-441dc5128bcf",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
},
{
"pkid": "5dcd185956b5de0018914264",
"meta": {
"tags": [],
"cached": true,
"title": "Goodbye",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd18514544b7001860529a",
"href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a"
}
],
"self": [
{
"pkid": "5dcd185956b5de0018914264",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd185956b5de0018914264/?model_type=device/cuc/Callhandler",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/Callhandler/5dcd185956b5de0018914264/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Callhandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd185956b5de0018914264"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"VoiceName": "5a36dd3e-60af-4d55-af31-ef93631813f9.wav",
"PartitionURI": "/vmrest/partitions/99867ff9-d9ae-4470-98b5-6013a2f87793",
"hierarchy": "5dcd1812e186e30018eb7023",
"CreationTime": "2019-02-12T13:30:22Z",
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe/callhandlerowners",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"RecipientDistributionListURI": "/vmrest/distributionlists/a49d3604-28ea-495d-94f7-36da420a6859",
"TimeZone": 140,
"DisplayName": "Goodbye",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"VoiceNameURI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe/voicename",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"PartitionObjectId": "99867ff9-d9ae-4470-98b5-6013a2f87793",
"CallSearchSpaceObjectId": "bec6f1a2-1297-4974-a365-24cf3ce094db",
"ObjectId": "894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe",
"UseCallLanguage": true,
"ScheduleSetObjectId": "a0c0098c-346c-45df-96fa-77c14aa130b2",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/a0c0098c-346c-45df-96fa-77c14aa130b2",
"AfterMessageAction": 1,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe/menuentries",
"IsPrimary": false,
"LocationObjectId": "e21cf6d2-ae77-4cf0-bb98-f94b8550c291",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe/transferoptions",
"IsTemplate": false,
"URI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe",
"CallSearchSpaceURI": "/vmrest/searchspaces/bec6f1a2-1297-4974-a365-24cf3ce094db",
"SendUrgentMsg": 0,
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe/greetings",
"Undeletable": true,
"VoiceFileURI": "/vmrest/voicefiles/2399b12a-b1e5-4aa8-99d7-c2dd649fa53f",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"RecipientDistributionListObjectId": "a49d3604-28ea-495d-94f7-36da420a6859",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"LocationURI": "/vmrest/locations/connectionlocations/e21cf6d2-ae77-4cf0-bb98-f94b8550c291"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd30788192d40018f76541",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "drich01",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"self": [
{
"pkid": "5dcd30788192d40018f76541",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30788192d40018f76541/?hierarchy=[hierarchy]&model_type=device/cuc/Callhandler",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Callhandler/5dcd30788192d40018f76541/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Callhandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30788192d40018f76541"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/callhandlerowners",
"PartitionURI": "/vmrest/partitions/0bdf803d-2c4e-499f-9319-4183da96c03b",
"CreationTime": "2018-12-18T13:26:28Z",
"EnablePrependDigits": false,
"UseDefaultTimeZone": true,
"PhoneSystemURI": "/vmrest/phonesystems/b4721efd-4847-4205-b550-a0cd39868d04",
"TimeZone": 140,
"DisplayName": "drich01",
"PartitionObjectId": "0bdf803d-2c4e-499f-9319-4183da96c03b",
"RecipientSubscriberObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceObjectId": "44a9d3bd-7069-4bd3-ac59-9281440c521a",
"ObjectId": "bdae05c2-e3ff-40f9-95a2-5464c129920f",
"UseCallLanguage": true,
"ScheduleSetObjectId": "49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"OneKeyDelay": 1500,
"DispatchDelivery": false,
"ScheduleSetURI": "/vmrest/schedulesets/49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/menuentries",
"IsPrimary": true,
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"Language": 1033,
"TransferOptionsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/transferoptions",
"IsTemplate": false,
"RecipientUserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"CallSearchSpaceURI": "/vmrest/searchspaces/44a9d3bd-7069-4bd3-ac59-9281440c521a",
"URI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"GreetingsURI": "/vmrest/handlers/callhandlers/bdae05c2-e3ff-40f9-95a2-5464c129920f/greetings",
"AfterMessageTargetHandlerObjectId": "f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"SendUrgentMsg": 0,
"Undeletable": false,
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0,
"InheritSearchSpaceFromCall": true,
"MediaSwitchObjectId": "b4721efd-4847-4205-b550-a0cd39868d04",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/Callhandler. | GET | /api/device/cuc/Callhandler/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Callhandler as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/Callhandler/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/Callhandler/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Callhandler/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Callhandler/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Callhandler | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/Callhandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Callhandler/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cuc/Callhandler and the JSON format can be used to import instances of device/cuc/Callhandler.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/Callhandler/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/Callhandler instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/Callhandler/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Callhandler. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/Callhandler/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |