Phone Menu API
Listing Phone Menu Fields
All the parameters of Phone Menu are present at the URI:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Updating Phone menu fields
To update the attributes of Phone Menu, the following steps can be followed:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Updating Conversation fields
Example 1: Edit call actions
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 2: Edit call handler
|
The following URI can be used to view call handler template object ID:
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 3: Interview handler
|
The following is an example of the GET request that shows the interview handler template object ID:
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 4: Directory handler
The following is an example of the GET request that shows the directory handler template object ID:
|
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 5: Conversation
Request Body: for broadcast message administrator
|
The following is the response from the *PUT* request for broadcast message administrator and the actual response will depend upon the information given by you:
|
Request Body: for caller system transfer
|
The following is the response from the *PUT* request for caller system transfer and the actual response will depend upon the information given by you:
|
Request Body: for greeting administrator
|
The following is the response from the *PUT* request for greeting administrator and the actual response will depend upon the information given by you:
|
Request Body: for sign in
|
The following is the response from the *PUT* request for sign in and the actual response will depend upon the information given by you:
|
Request Body: for user system transfer
|
The following is the response from the *PUT* request for user system transfer and the actual response will depend upon the information given by you:
|
Example 6: Users with Mailbox
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example To set exit action, do the following:
|
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Field Name | Data Type | Operation | Description |
---|---|---|---|
UseBriefPrompts | Boolean | Read/Write | A flag indicating whether the subscriber
hears brief or full phone menus when accessing Cisco Unity Connection over the
phone.
Possible values:
|
PromptVolume | Integer | Read/Write | The volume level for playback of system
prompts. The range can vary from 0 to 100.
Possible values:
Default Value: 50 |
PromptSpeed | Integer | Read/Write | The audio speed Cisco Unity Connection uses
to play back prompts to the subscriber.
Possible values:
Default Value: 100 |
IsClockMode24Hour | Boolean | Read/Write | The time format used for the message
timestamps that the subscriber hears when they listen to their messages over
the phone.
Possible values: • true: 24-Hour Clock (00:00 - 23:59) • false: 12-Hour Clock (12:00 AM - 11:59 PM) EnableMessageLocator Boolean Read/Write A flag indicating whether the message locator feature is enabled for the subscriber. Possible Values: • false: Message locator feature is disabled for subscriber • true: Message locator feature is enabled for subscriber Default Value: false RepeatMenu Integer Read/Write The number of times to repeat a menu in touchtone conversation. The range can vary from 0 to 250. Default value: 1 ConversationTui String Read/Write The name of the conversation the subscriber uses to set up, send, and retrieve messages. Possible values:
|
MessageLocatorSortOrder | Integer | Read/Write | The order in which system will sort
messages when the "Message Locator" feature is enabled.
Possible values:
Default Value: 1 |
FirstDigitTimeout | Integer | Read/Write | The amount of time to wait (in
milliseconds) for first digit when collecting touchtone. The range can vary
from 500 to 10000.
Default value: 5000 |
InterdigitDelay | Integer | Read/Write | The amount of time to wait (in
milliseconds) for input between touch tones when collecting digits in touchtone
conversation. The range can vary from 1000 to 10000.
Default Value: 3000 |
CommandDigitTimeout | Integer | Read/Write | The amount of time (in milliseconds)
between digits on a multiple digit menu command entry (i.e. different than the
inter digit timeout that is used for strings of digits such as extensions and
transfer strings). The range can vary from 250 to 5000.
Default value: 1500 |
GreetByName | Boolean | Read/Write | A flag indicating whether the subscriber
hears his/her name when they log into their mailbox over the phone.
Possible Values:
Default Value: true |
SayAltGreetWarning | Boolean | Read/Write | A flag indicating whether Cisco Unity
Connection notifies the subscriber when they login via the phone (plays
conversation) or CPCA (displays a warning banner) if their alternate greeting
is turned on.
Default Value: false |
JumpToMessagesOnLogin | Boolean | Read/Write | A flag indicating whether the subscriber
conversation jumps directly to the first message in the message stack after
subscriber sign-in.
Possible values:
Default Value: true |
ExitCallActionObjectId | String(36) | Read Only | The unique identifier of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out. |
ExitAction | Integer | Read/Write | The type of call action to take, e.g.,
hang-up, goto another object, etc.
Possible values: 0-8 Default Value: 0 |
ExitTargetConversation | String(64) | Read/Write | The name of the conversation to which the caller is routed. |
ExitTargetHandlerObjectId | String(36) | Read Only | The unique identifier of the specific object to send along to the target conversation. |