Caller Inputs API
To get the caller input URI, follow the steps given below:
GET https://<connection-server>/vmrest/users/<user-objectid>
From above URI get the call handler URI:
GET https://<connection-server>/vmrest/handlers/callhandlers/<CallhandlerObjectId>
To edit caller inputs, you need to get the menu entries:
GET https://<connection-server>/vmrest/handlers/callhandlers/<CallhandlerObjectId>/menuentries
Listing Caller Inputs
GET https://<connection-server>/vmrest/handlers/callhandlers/<CallhandlerObjectId>/menuentries/<key>
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
<MenuEntry>
<URI>/vmrest/handlers/callhandlers/287cdcc0-9f77-48e0-a7b1-0f9b1a5ac842/menuentries/1</URI>
<CallHandlerObjectId>287cdcc0-9f77-48e0-a7b1-0f9b1a5ac842</CallHandlerObjectId>
<CallhandlerURI>/vmrest/handlers/callhandlers/287cdcc0-9f77-48e0-a7b1-0f9b1a5ac842</CallhandlerURI>
<TouchtoneKey>1</TouchtoneKey>
<Locked>false</Locked>
<Action>7</Action>
<TargetConversation>BroadcastMessageAdministrator</TargetConversation>
<ObjectId>d2a363af-d3f6-46cf-81c9-5ad48d2dccd7</ObjectId>
<DisplayName>abc</DisplayName>
<TransferType>0</TransferType>
<TransferRings>9</TransferRings>
</MenuEntry>
JSON Example
GET https://<Connection-server>/vmrest/handlers/callhandlers/<CallhandlerObjectId>/menuentries/4
Accept: application/json
Connection: keep-alive
{
"URI":"/vmrest/handlers/callhandlers/43bb6590-e9e3-43ca-972e-e3e158a96126/menuentries/4"
"CallHandlerObjectId":"43bb6590-e9e3-43ca-972e-e3e158a96126"
"CallhandlerURI":"/vmrest/handlers/callhandlers/43bb6590-e9e3-43ca-972e-e3e158a96126"
"TouchtoneKey":"4"
"Locked":"false"
"Action":"2"
"TargetConversation":"AD"
"TargetHandlerObjectId":"80b1b22b-2fd8-458e-abd1-294e83a9ec55"
"ObjectId":"a164d69a-5d0a-4c07-b2e2-d972448950db"
}
Response code: 200
Updating Caller Input Parameters
The following is an example of the PUT request that updates caller input parameters:
PUT https://<connection-server>/vmrest/handlers/callhandlers/<CallhandlerObjectId>
<Callhandler>
<OneKeyDelay>9999</OneKeyDelay>
<EnablePrependDigits>true</EnablePrependDigits>
<PrependDigits>4545</PrependDigits>
</Callhandler>
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
Response Code: 204
Note |
<Prepend Digits> parameter must be having digits only (extension parameter) |
Updating Caller Input Keys
The following is an example of the PUT request that updates the call input keys:
|
The following is an example of the PUT request that edits the call input keys for (*):
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Values | Parameters |
---|---|
0 | Ignore |
1 | Hang Up |
4 | Take Message |
5 | Skip Greeting |
6 | Restart Greeting |
7 | Transfer to alternate contact number |
8 | Route from next call routing rule |
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 is an example of the PUT request that shows the call handler 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 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 the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 5: Conversation
|
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:
|
|
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:
|
|
The following is the response from the *PUT* request for greeting administrator and the actual response will depend upon the information given by you:
|
|
The following is the response from the *PUT* request for sign in and the actual response will depend upon the information given by you:
|
|
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 4: 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
For conversation, do the following:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Parameter | Data Type | Operations | Comments | ||
---|---|---|---|---|---|
OneKeyDelay | Integer | Read/Write | Indicate the amount of time that System
waits for additional input after callers press a single key that is not locked.
If there is no input within this time, system performs the action assigned to
the single key.
We recommend a value of 1,500 milliseconds (one and one-half seconds).
|
||
ObjectId | String(36) | Read Only | Unique Id for menu entry. | ||
EnablePrependDigits | Boolean | Read/Write | To simulate abbreviated extensions by using
prepended digits for call handlers and user mailboxes. When such digits are
defined, they are prepended to any extension that a caller dials while
listening to the greeting for the call handler or user mailbox.
Possible values:
Default value: false. |
||
PrependDigits | Integer | Read/Write | Digits that are prepended to any extension that a caller dials while listening to the greeting of the user. | ||
MenuEntriesURI | String(36) | Read Only | Parameters for caller input keys are
present in menu entries URI.
|
||
TouchtoneKey | String(1) | Read Only | Indicates the phone keypad key to which the settings apply. | ||
Locked | Boolean | Read/Write | A locked menu entry does not allow
additional dialing after this choice is entered.
Values can be: • false: Unlocked - Additional dialing after this choice is entered is allowed • true: Locked - Additional dialing is ignored Default value: false. |
||
Action | Integer | Read/Write | Takes values from 0-8. See table for
values.
Default value: 0 |
||
CallHandlerObjectId | String(36) | Read Only | Menu entries can only belong to call handlers. No other object can own a menu entry. | ||
TargetConversation | String(36) | Read/Write | The name of the conversation to which the caller is routed. | ||
TargetHandlerObjectId | String(36) | Read/Write | The unique identifier of the specific object to send along to the target conversation. | ||
TransferNumber | Integer | Read/Write | Extension to which call is transferred. | ||
DisplayName | String(24) | Read/Write | Descriptive name of the handler being used. | ||
TransferType | Integer | Read/Write | The type of call transfer Cisco Unity
Connection will perform - supervised or unsupervised (also referred to as
"Release to Switch" transfer).
Possible Values:
Default Value: 0 TransferRings Integer Read/Write Applies only when the "TransferType" column is set to supervised (1). This value should never be less than 2 for a supervised transfer. Possible value: 2-20 Default value: 4 |