Cisco Unity Connection Provisioning Interface (CUPI) API -- Caller Input APIs
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 the Caller Inputs
The following is an example of the GET request that fetch the list of caller inputs:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view the list of caller inputs, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Viewing the Details of Specific Caller Input
The following is an example of the GET request that lists the details of specific caller input:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view a particular caller input, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Updating a Caller Input
The following is an example of the PUT request that updates a specific caller input:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To update a particular caller input, 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 | Operations | Data Type | Comments |
---|---|---|---|
URI | Read Only | String | URI of the call handler menu entries. |
CallHadlerObjectId | Read Only | String | A transfer rule can belong only to a call handler object. No other object can own a menu entry. |
CallHandlerURI | Read Only | String | URI of the call handler that is being referenced. |
TouchtoneKey | Read Only | String | The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). |
Locked | Read/Write | Boolean | A flag indicating whether Cisco Unity
Connection ignores additional input after callers press this key.
A locked menu entry does not allow additional dialing after this choice is entered, but Cisco Unity Connection will immediately take the associated action. If the action is set to "Ignore" (0), the key is thrown out and the greeting continues playing as normal. Any other action is taken immediately without waiting to determine if the caller is going to dial an extension. Possible Values:
Default value: false |
Action | Read/Write | Integer | Specifies the action to be taken in the
event of the key press.
Default value: 0 |
TargetConversion | Read/Write | String | Specifies the conversation to go to after
taking a message.
Default value: 0 |
TargetHandlerObjectId | Read/Write | String | The unique identifier of the specific object to send along to the target conversation. |
ObjectId | Read Only | String | Object ID of the caller input. |
TransferNumber | Read/Write | Integer | The phone number associated with the alternate contact. |
DisplayName | Read/Write | String | The display name associated with the alternate contact number. |
TransferType | Read/Write | Integer | The type of call transfer Cisco Unity
Connection will perform - supervised or unsupervised (also referred to as
"Release to Switch" transfer).
Default value: 0 |
TransferRings | Read/Write | Integer | The number of times the extension rings
before Cisco Unity Connection considers it a "ring no answer" and plays the
subscriber or handler greeting
Possible value can range from 2-20 Default Value: 4 |