[Index]
Model ref.: device/cuc/TemplateGreeting
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": {
"PlayWhat": {
"minItems": 0,
"type": "integer",
"description": " The source for the greeting when this greeting is active.",
"name": "PlayWhat",
"title": "Play What"
},
"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"
},
"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": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "AfterGreetingAction",
"title": "After Greeting Action"
},
"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]
},
"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": {
"description": " The unique identifier of the CallHandler object to which this greeting rule belongs. - template parameter [1]",
"format": "uri",
"minItems": 0,
"title": "Call Handler Object Id",
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/CallhandlerTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/CallhandlerTemplate",
"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"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/TemplateGreeting/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/TemplateGreeting/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TemplateGreeting/[pkid1]", "/api/v0/device/cuc/TemplateGreeting/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/TemplateGreeting/?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/TemplateGreeting |
|
{"hrefs": ["/api/device/cuc/TemplateGreeting/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/TemplateGreeting |
|
{"hrefs": ["/api/device/cuc/TemplateGreeting/[pkid1]", "/api/device/cuc/TemplateGreeting/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/TemplateGreeting; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/TemplateGreeting/export/ |
|
{ "hrefs":["/api/device/cuc/TemplateGreeting/[pkid1]", "/api/device/cuc/TemplateGreeting/[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/TemplateGreeting and the JSON format can be used to import instances of device/cuc/TemplateGreeting.
GET http://[host-proxy]/api/device/cuc/TemplateGreeting/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/TemplateGreeting | POST | /api/device/cuc/TemplateGreeting/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/TemplateGreeting/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/TemplateGreeting/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/TemplateGreeting/ |
|
The device/cuc/TemplateGreeting schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/TemplateGreeting instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "URI",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/TemplateGreeting/?skip=0&limit=3&order_by=URI&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 7
},
"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": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/TemplateGreeting/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/TemplateGreeting",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateGreeting/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/TemplateGreeting/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/TemplateGreeting/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/TemplateGreeting/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/TemplateGreeting/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateGreeting/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateGreeting/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateGreeting",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": "5f3ae5b2ce894e00120558f2",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Alternate",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5b2ce894e00120558f2",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5b2ce894e00120558f2/?model_type=device/cuc/TemplateGreeting",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateGreeting",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5b2ce894e00120558f2"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"AfterGreetingAction": 4,
"Enabled": false,
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Alternate",
"RepromptDelay": 2,
"Reprompts": 0,
"GreetingType": "Alternate",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"TimeExpires": "1972-01-01 02:00:00.0",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae5b2ce894e00120558f6",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Busy",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae5b2ce894e00120558f6",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5b2ce894e00120558f6/?model_type=device/cuc/TemplateGreeting",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f6/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/TemplateGreeting",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5b2ce894e00120558f6"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"hierarchy": "5f3ae552ce894e00120537fa",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"AfterGreetingAction": 4,
"Enabled": false,
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Busy",
"RepromptDelay": 2,
"Reprompts": 0,
"GreetingType": "Busy",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"TimeExpires": "1972-01-01 02:00:00.0",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae5b2ce894e00120558fa",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Error",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae5b2ce894e00120558fa",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5f3ae5b2ce894e00120558fa/?model_type=device/cuc/TemplateGreeting",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558fa/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateGreeting",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5b2ce894e00120558fa"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"AfterGreetingTargetConversation": "PHGreeting",
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"hierarchy": "5f3ae552ce894e00120537fa",
"Enabled": true,
"AfterGreetingAction": 6,
"AfterGreetingTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Error",
"RepromptDelay": 2,
"Reprompts": 0,
"GreetingType": "Error",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae5b2ce894e00120558f2",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Alternate",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae5b2ce894e00120558f2",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5b2ce894e00120558f2/?hierarchy=[hierarchy]&model_type=device/cuc/TemplateGreeting",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateGreeting/5f3ae5b2ce894e00120558f2/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateGreeting",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5b2ce894e00120558f2"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"PlayWhat": 0,
"IgnoreDigits": false,
"PlayRecordMessagePrompt": true,
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"Enabled": false,
"AfterGreetingAction": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templategreetings/Alternate",
"RepromptDelay": 2,
"Reprompts": 0,
"GreetingType": "Alternate",
"EnableTransfer": false,
"EnablePersonalVideoRecording": false,
"PlayRecordVideoMessagePrompt": false,
"TimeExpires": "1972-01-01 02:00:00.0"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/TemplateGreeting. | GET | /api/device/cuc/TemplateGreeting/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/TemplateGreeting as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/TemplateGreeting/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/TemplateGreeting/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/TemplateGreeting/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/TemplateGreeting | 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/TemplateGreeting; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/TemplateGreeting/[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/TemplateGreeting and the JSON format can be used to import instances of device/cuc/TemplateGreeting.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/TemplateGreeting/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/TemplateGreeting instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/TemplateGreeting/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/TemplateGreeting. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/TemplateGreeting/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |