Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Phone Menu

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


User Template Phone Menu

The following URI can be used to view the user template object ID:

    GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>


Updating Phone menu fields

Request Body:
<UserTemplate>
    <PromptVolume>50</PromptVolume>
    <PromptSpeed>100</PromptSpeed>
    <IsClockMode24Hour>false</IsClockMode24Hour>
    <ConversationTui>SubMenu</ConversationTui>
    <MessageLocatorSortOrder>1</MessageLocatorSortOrder>
    <JumpToMessagesOnLogin>false</JumpToMessagesOnLogin>
</UserTemplate>

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


Updating Conversation fields

Example 1: Edit call actions

Request Body:
<UserTemplate>
    <ExitAction>1</ExitAction>
</UserTemplate>

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

Example 2: Edit call handler The following URI can be used to view call handler template object ID:

    GET https://<connection-server>/vmrest/handlers/callhandlers
Request Body:
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>PHTransfer</ExitTargetConversation>
    <ExitTargetHandlerObjectId>c1fc1029-55f4-40dc-a553-
    40b75664ed8a</ExitTargetHandlerObjectId>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>PHTransfer</ExitTargetConversation>
    <ExitTargetHandlerObjectId>c1fc1029-55f4-40dc-a553-40b75664ed8a</ExitTargetHandlerObjectId>   
</UserTemplate>

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

Example 3: Interview handler The following is an example of the GET request that shows the interview handler template object ID:

GET https://<connection-server>/vmrest/handlers/interviewhandlers
Request Body:
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetHandlerObjectId>c1fc1029-55f4-40dc-a553-40b75664ed8a</ExitTargetHandlerObjectId> 
 </UserTemplate>

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

Example 4: Directory handler The following is an example of the GET request that shows the directory handler template object ID:

  GET https://<connection server>/vmrest/handlers/directoryhandlers
Request Body:
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetHandlerObjectId>c1fc1029-55f4-40dc-a553-
    40b75664ed8a</ExitTargetHandlerObjectId> 
 </UserTemplate>

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

Example 5: Conversation

Request Body: for broadcast message administrator
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>BroadcastMessageAdministrator</ExitTargetConversation>
 </UserTemplate>

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:
<pre>
Response Code: 204
Request Body: for caller system transfer
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>SystemTransfer</ExitTargetConversation>
 </UserTemplate>

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:

Response Code: 204
Request Body: for greeting administrator
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>GreetingAdministrator</ExitTargetConversation>
 </UserTemplate>

The following is the response from the *PUT* request for greeting administrator and the actual response will depend upon the information given by you:

Response Code: 204
Request Body: for sign in
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>SubSignIn</ExitTargetConversation>
 </UserTemplate>

The following is the response from the *PUT* request for sign in and the actual response will depend upon the information given by you:

Response Code: 204
Request Body: for user system transfer
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>SubSysTransfer</ExitTargetConversation>
 </UserTemplate>

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:

Response Code: 204

Example 6: Users with Mailbox

Request Body:
<UserTemplate>
    <ExitAction>2</ExitAction>
    <ExitTargetConversation>PHTransfer</ExitTargetConversation> 
    <ExitTargetHandlerObjectId>71cb381b-fd16-4ba8-8a1d-
    e71684e57b0e</ExitTargetHandlerObjectId>
</UserTemplate>

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

JSON Example

To set exit action, do the following:

PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Accept: application/json
Content-type: application/json
Connection: keep-alive
Request Body:
{
    "ExitAction":"2",
    "ExitTargetConversation":"SubSysTransfer"
}

The following is the response from the *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204


Explanation of Data Fields

Parameter Values
useBriefPrompts *True: Brief
  • False: Full
PromptVolume *25: Low
  • 50: Medium
  • 100: High
PromptSpeed *50: Slow
  • 100: Normal
  • 150: Fast
  • 200: Fastest
IsClockMode24Hour *True: 24-Hour Clock (00:00 - 23:59)
  • False: 12-Hour Clock (12:00 AM - 11:59 PM)
ConversationTUI *SubMenu: Classic Conversation
  • SubMenu_Alternate_Custom: Custom keypad mapping1
  • SubMenu_Alternate_Custom1: Custom keypad mapping1
  • SubMenu_AlternateN: Alternate Keypad Mapping(N)
  • SubMenu_AlternateS: Alternate Keypad Mapping(S)
  • SubMenu_AlternateX: Alternate Keypad Mapping (X)
  • SubMenuOpt1: Optional conversation1
  • SubMenu_AlternateI: Standard Conversation
MessageLocatorSortOrde *1: Last In, First Out
  • 2: First In, First Out

NOTE: PromptVolume and PromptSpeed parameters must be of the same range given in the table.

Rating: 0.0/5 (0 votes cast)

Personal tools