Call Handler Field Descriptions

Call Handler Basics (Auto Attendant only)

Title	Field Name	Description
Network Device List *	HF.target_ndl	Mandatory input-field for the option (if hierarchy is at Site-node, however, this value is derived automatically). The workflow (and GUIRules) will target the UC devices that is linked to this Network Device List (NDL). In the Mod use-case, this should also be derived automatically and can thus be omitted from Updates.
Cisco Unity Connection	HF.cuc_info	Informative (non-input) field. Indicates the target CUCx host/IP, which is automatically derived from the input NDL.
Cisco Unified CM	HF.cucm_info	Informative (non-input) field. Indicates the target CUCM host/IP, which is automatically derived from the input NDL.
Name *	DisplayName	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.”
Route List	route_list	The CUCM Route List to use. The valid options are dependent on the selected NDL/CUCM. console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting call handler is “Opening Greeting.”
Pilot	DtmfAccessId	The DTMF access id (i.e., extension) for the call handler. The dialable number.
Call Handler Template	cuc_template	Select the Unity Template for Call Handler.

Transfer Rules (Auto Attendant only)

Title	Field Name	Description
Message	callerInput_tab_message	Caller Input
Callhandler Menu Entry	CallhandlerMenuEntry.[n]
Object Id	ObjectId	The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.
Call Handler *	CallHandlerObjectId	The unique identifier of the CallHandler object to which this menu entry belongs.
Touchtone Key	TouchtoneKey	The character on the touch-tone keypad that this menu entry corresponds to ( * , #, 0,1…9).
Ignore Additional Input (Locked)	Locked	A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key. Values: 0: Additional input accepted 1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key.
Call Action	Action	The type of call action to take, e.g., hang-up, goto another object, etc.
Extension or URI	TransferNumber	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Description	DisplayName	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Transfer Type	TransferType	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Rings to Wait for	TransferRings	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Target Conversation	TargetConversation	The name of the conversation to which the caller is routed.
Target Handler Object Id	TargetHandlerObjectId	The unique identifier of the specific object to send along to the target conversation.

Caller Input

Title	Field Name	Description
Message	callerInput_tab_message
Callhandler Menu Entry	CallhandlerMenuEntry.[n]
Object Id	ObjectId	The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.
Call Handler *	CallHandlerObjectId	The unique identifier of the Call Handler object to which this menu entry belongs.
Touchtone Key	TouchtoneKey	The character on the touch-tone keypad that this menu entry corresponds to ( * , #, 0,1…9).
Ignore Additional Input (Locked)	Locked	A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key. Values: 0: Additional input accepted 1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key.
Call Action	Action	The type of call action to take, e.g., hang-up, goto another object, etc.
Extension or URI	TransferNumber	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Description	DisplayName	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Transfer Type	TransferType	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Rings to Wait for	TransferRings	This setting only applies if “Call Action” is set to ‘Transfer to Alternate Contact Number’.
Target Conversation	TargetConversation	The name of the conversation to which the caller is routed.
Target Handler Object Id	TargetHandlerObjectId	The unique identifier of the specific object to send along to the target conversation.

Greetings (Auto Attendant only)

Title	Field Name	Description
Message	greetings_tab_message
Greeting	Greeting.[n]
Greeting Type	Enabled	The type of greeting, e.g. “Standard,” “Off Hours,” “Busy,” etc.
Enabled	Enabled	If TimeExpires is set, this field is ignored.
Time Expires	TimeExpires	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.
Callers Hear	PlayWhat	The source for the greeting when this greeting is active.
Play the “Record Your Message at the tone” Prompt	PlayRecordMessage Prompt	A flag indicating whether the “Record your message at the tone?” prompt prior to recording a message.
Callers See My Personal Recording	EnablePersonal VideoRecording	It will Enable the Personal video Recording in CUCA.
Callers See Play the “Record Your Message at the Tone” Prompt	PlayRecordVideo MessagePrompt	A flag indicating whether the “Record your message at the tone?” prompt prior to Video recording a message.
Ignore Caller Input During Greeting	IgnoreDigits	A flag indicating whether Cisco Unity Connection takes action in response to touchtone keys pressed by callers during the greeting.
Allow Transfers to Numbers Not Associated with Users or Call Handlers	EnableTransfer	A flag indicating when an extension is dialed at the greeting and the extension is not available whether to transfer to another extension.
Times to Re-prompt Caller	Reprompts	The number of times to reprompt a caller. After the number of times indicated here, Cisco Unity Connection performs the after-greeting action.
Delay between Re-prompts	RepromptDelay	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.

Title	Field Name	Description
After Greeting	AfterGreetingAction	The type of call action to take, for example, hang-up, goto another object, etc.
After Greeting Target Conversation	AfterGreetingTarget Conversation	The name of the conversation to which the caller is routed.
After Greeting Target Handler Object Id	AfterGreetingTarget HandlerObjectId	The unique identifier of the specific object to send along to the target conversation.
Call Handler Object Id	CallHandlerObjectId	The unique identifier of the Call Handler object to which this greeting rule belongs.
Callhandler URI	CallhandlerURI
Greeting Stream Files URI	GreetingStreamFilesURI
Greetings Type	GreetingType	The type of greeting, e.g. “Standard,” “Off Hours,” “Busy,” etc.
URI	URI

Record/Playback (Auto Attendant only)

Title	Field Name	Description
Message	RecordPlayback.note	A special interface, which allows administrators to trigger a call to a physical device, which allows for recording or playback of a greeting. The extension to dial must be an accessible extension for the admin (or user) to answer and record or listen to greetings.
Call Handler Name	RecordPlayback.call_handler	Call Handler Name.
Extension	RecordPlayback.extension	Extension to Record message on.
Specific Greeting	RecordPlayback.specific_greeting	The unique identifier of the Call Handler object to which this menu entry belongs.
Greetings	RecordPlayback.greeting	Greetings.
Duration	RecordPlayback.duration	Duration to allow enough time to make recording/playback.

Upload Greeting (Auto Attendant only)

Title	Field Name	Description
Message	note	Upload a greeting to the selected Call Handler.
Greeting File	Upload.filename	Call Handler Name.
Call Handler Name	Upload.call_handler	Call Handler Name.
Specific Greeting	Upload.specific_greeting	Specific Greeting.
Greetings	Upload.greeting	Greetings.