API Reference for device/cuc/UserTemplateGreeting

Model ref.: device/cuc/UserTemplateGreeting

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$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"
          }, 
          "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"
          }, 
          "Enabled": {
               "type": "boolean", 
               "description": "If TimeExpires is set, this field is ignored.", 
               "name": "Enabled", 
               "title": "Enabled"
          }, 
          "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"
          }, 
          "CallhandlerURI": {
               "name": "CallhandlerURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Callhandler URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "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"
          }, 
          "GreetingStreamFilesURI": {
               "type": "string", 
               "description": "The URI to get the greeting stream files addresses of the user.", 
               "name": "GreetingStreamFilesURI", 
               "title": "Greeting Stream Files URI"
          }, 
          "URI": {
               "name": "URI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "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"
          }, 
          "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", 
               "readonly": true, 
               "target": "/api/device/cuc/CallhandlerPrimaryTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/CallhandlerPrimaryTemplate", 
               "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"
          }, 
          "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"
          }, 
          "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"
          }, 
          "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"
          }, 
          "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"
          }, 
          "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": "14.0"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/UserTemplateGreeting/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/UserTemplateGreeting device/cuc/UserTemplateGreeting schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/UserTemplateGreeting/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplateGreeting/[pkid1]", "/api/v0/device/cuc/UserTemplateGreeting/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/UserTemplateGreeting	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/UserTemplateGreeting/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/UserTemplateGreeting	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/UserTemplateGreeting/[pkid1]", "/api/device/cuc/UserTemplateGreeting/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplateGreeting; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/UserTemplateGreeting/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/UserTemplateGreeting/[pkid1]", "/api/device/cuc/UserTemplateGreeting/[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/UserTemplateGreeting and the JSON format can be used to import instances of device/cuc/UserTemplateGreeting.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/cuc/UserTemplateGreeting:

 GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplateGreeting	POST	/api/device/cuc/UserTemplateGreeting/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cuc/UserTemplateGreeting	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/UserTemplateGreeting/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/UserTemplateGreeting/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/cuc/UserTemplateGreeting/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/UserTemplateGreeting schema and all instances as JSON.

(The list will return 0 to 3 device/cuc/UserTemplateGreeting instances)

GET http://[host]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "URI", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/UserTemplateGreeting/?skip=0&limit=3&order_by=URI&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "14.0", 
          "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/UserTemplateGreeting/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/UserTemplateGreeting", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/UserTemplateGreeting/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/UserTemplateGreeting/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/UserTemplateGreeting/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/UserTemplateGreeting/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/UserTemplateGreeting/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/UserTemplateGreeting/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/UserTemplateGreeting", 
          "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"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/UserTemplateGreeting.	GET	/api/device/cuc/UserTemplateGreeting/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/UserTemplateGreeting as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/cuc/UserTemplateGreeting/[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/UserTemplateGreeting/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cuc/UserTemplateGreeting

GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplateGreeting	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/UserTemplateGreeting; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/UserTemplateGreeting/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/UserTemplateGreeting and the JSON format can be used to import instances of device/cuc/UserTemplateGreeting.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/UserTemplateGreeting/[pkid]	hierarchy=[hierarchy]	The device/cuc/UserTemplateGreeting instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/cuc/UserTemplateGreeting/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/cuc/UserTemplateGreeting.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cuc/UserTemplateGreeting/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/cuc/UserTemplateGreeting

GET http://[host-proxy]/api/device/cuc/UserTemplateGreeting/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cuc/UserTemplateGreeting/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Purge