[Index]
Model ref.: device/cuc/InterviewHandler
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, "title": "Voice Name", "type": "string", "description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.", "name": "VoiceName" }, "DisplayName": { "minItems": 0, "title": "Display Name", "type": "string", "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.\"", "name": "DisplayName" }, "CreationTime": { "description": " The date and time the handler is created.", "title": "Creation Time", "minItems": 0, "readonly": true, "type": "string", "name": "CreationTime" }, "RecipientDistributionListURI": { "name": "RecipientDistributionListURI", "title": "Recipient Distribution List URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "PartitionURI": { "name": "PartitionURI", "title": "Partition URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "PartitionObjectId": { "minItems": 0, "title": "Partition Object Id", "type": "string", "description": " The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.", "name": "PartitionObjectId" }, "RecipientSubscriberObjectId": { "minItems": 0, "title": "Recipient Subscriber Object Id", "type": "string", "description": " The DignetObjectId of the User object to which the recorded message of the interview handler should be routed.", "name": "RecipientSubscriberObjectId" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generate identifier for a InterviewHandler object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "UseCallLanguage": { "minItems": 0, "title": "Use Call Language", "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.", "name": "UseCallLanguage" }, "DispatchDelivery": { "minItems": 0, "title": "Dispatch Delivery", "type": "boolean", "description": " A flag indicating that all messages left for the interview handler is for dispatch delivery. ", "name": "DispatchDelivery" }, "VoiceNameURI": { "name": "VoiceNameURI", "title": "Voice Name URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "LocationObjectId": { "minItems": 0, "title": "Location Object Id", "type": "string", "description": " The unique identifier of the Location object to which this handler belongs.", "name": "LocationObjectId" }, "InterviewQuestionsURI": { "title": "Interview Questions URI", "type": "string", "description": "The URI to fetch the Interview Questions.", "name": "InterviewQuestionsURI" }, "UseDefaultLanguage": { "minItems": 0, "title": "Use Default Language", "type": "boolean", "description": "A flag indicating whether the language for this interview handler is derived from the interview handler object attribute or the default language from the location to which the interview handler belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.", "name": "UseDefaultLanguage" }, "Language": { "minItems": 0, "title": "Language", "type": "integer", "description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.", "name": "Language" }, "RecipientUserURI": { "name": "RecipientUserURI", "title": "Recipient User URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "URI": { "name": "URI", "title": "URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "AfterMessageTargetHandlerObjectId": { "minItems": 0, "title": "After Message Target Handler Object Id", "type": "string", "description": " The unique identifier of the specific object to send along to the target conversation.", "name": "AfterMessageTargetHandlerObjectId" }, "TenantObjectId": { "minItems": 0, "title": "Tenant Object Id", "type": "string", "description": " Unique ObjectId of the tbl_Tenant", "name": "TenantObjectId" }, "SendUrgentMsg": { "minItems": 0, "title": "Send Urgent Msg", "type": "integer", "description": " A flag indicating whether an unidentified caller is given a choice to mark a message as Urgent or Normal, or if not given the choice, whether the message is always marked Normal (default value) or Urgent.", "name": "SendUrgentMsg" }, "Undeletable": { "minItems": 0, "title": "Undeletable", "type": "boolean", "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.", "name": "Undeletable" }, "VoiceFileURI": { "name": "VoiceFileURI", "title": "Voice File URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "AfterMessageTargetConversation": { "minItems": 0, "title": "After Message Target Conversation", "type": "string", "description": " The name of the conversation to which the caller is routed.", "name": "AfterMessageTargetConversation" }, "RecipientDistributionListObjectId": { "minItems": 0, "title": "Recipient Distribution List Object Id", "type": "string", "description": " The unique identifier of the DistributionList object where the recorded message of the interview handler should be routed.", "name": "RecipientDistributionListObjectId" }, "DtmfAccessId": { "minItems": 0, "title": "Dtmf Access Id", "type": "string", "description": " The dialable number.", "name": "DtmfAccessId" }, "AfterMessageAction": { "minItems": 0, "title": "After Message Action", "type": "integer", "description": " The type of call action to take, e.g., hang-up, goto another object, etc.", "name": "AfterMessageAction" }, "LocationURI": { "name": "LocationURI", "title": "Location URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/InterviewHandler/add/ |
|
The GUI Add form of device/cuc/InterviewHandler 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/InterviewHandler/ | 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/InterviewHandler/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/InterviewHandler/[pkid1]", "/api/device/cuc/InterviewHandler/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/InterviewHandler/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/InterviewHandler/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/InterviewHandler/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/InterviewHandler/[pkid1]", "/api/v0/device/cuc/InterviewHandler/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/InterviewHandler/?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/InterviewHandler |
|
{"hrefs": ["/api/device/cuc/InterviewHandler/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/InterviewHandler |
|
{"hrefs": ["/api/device/cuc/InterviewHandler/[pkid1]", "/api/device/cuc/InterviewHandler/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/InterviewHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/InterviewHandler/export/ |
|
{ "hrefs":["/api/device/cuc/InterviewHandler/[pkid1]", "/api/device/cuc/InterviewHandler/[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/InterviewHandler and the JSON format can be used to import instances of device/cuc/InterviewHandler.
GET http://[host-proxy]/api/device/cuc/InterviewHandler/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/InterviewHandler | POST | /api/device/cuc/InterviewHandler/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/InterviewHandler/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/InterviewHandler/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/InterviewHandler/ |
|
The device/cuc/InterviewHandler schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/InterviewHandler instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/InterviewHandler/?skip=0&limit=3&order_by=DisplayName&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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/InterviewHandler/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/InterviewHandler/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/InterviewHandler/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/InterviewHandler", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/InterviewHandler/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/InterviewHandler/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/InterviewHandler/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/InterviewHandler/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/InterviewHandler/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/InterviewHandler/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/InterviewHandler/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/InterviewHandler", "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" }, { "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/InterviewHandler. | GET | /api/device/cuc/InterviewHandler/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/InterviewHandler as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/InterviewHandler/[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/InterviewHandler/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/InterviewHandler/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/InterviewHandler/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/InterviewHandler | 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/InterviewHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/InterviewHandler/[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/InterviewHandler and the JSON format can be used to import instances of device/cuc/InterviewHandler.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/InterviewHandler/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/InterviewHandler instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/InterviewHandler/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/InterviewHandler. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/InterviewHandler/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |