Cisco Unity Connection Provisioning Interface (CUPI) API -- Playback Message Settings

From DocWiki

Revision as of 04:12, 10 September 2013 by Subabhat (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


Playback Message Settings

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

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


Edit Parameters

Request Body:
<UserTemplate>
    <Volume>50</Volume>
    <Speed>100</Speed>
    <SayTotalNew>true</SayTotalNew>
    <SayTotalNewVoice>true</SayTotalNewVoice>
    <SayTotalNewEmail>false</SayTotalNewEmail>
    <SayTotalNewFax>false</SayTotalNewFax>
    <SayTotalReceipts>false</SayTotalReceipts>
    <SayTotalSaved>true</SayTotalSaved>
    <SayTotalDraftMsg>false</SayTotalDraftMsg>
    <MessageTypeMenu>false</MessageTypeMenu>
    <NewMessageSortOrder>2</NewMessageSortOrder>
    <SaveMessageOnHangup>1</SaveMessageOnHangup>
    <DeletedMessageSortOrder>1</DeletedMessageSortOrder>
    <SaySender>true</SaySender>
    <SaySenderExtension>false</SaySenderExtension> 
    <SayAni>true</SayAni>
    <SayMsgNumber>true</SayMsgNumber>
    <SayTimestampBefore>true</SayTimestampBefore>
    <AutoAdvanceMsgs>false</AutoAdvanceMsgs>
    <ConfirmDeleteMessage>true</ConfirmDeleteMessage>
</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

NOTE: To sort the message type:

  • for new message: <NewMessageSortOrder>2</NewMessageSortOrder>
  • for saved message: <SaveMessageSortOrder>1</SaveMessageSortOrder>
  • for deleted message: <DeletedMessageSortOrder>1</DeletedMessageSortOrder>

All the possible values for above three parameters are given in the table.


Explanation of Data Fields

Parameter Values
Volume 25: Low

50: Medium 100: High

Speed 50: Slow

100: Normal 150: Fast 200: Fastest

SaveMessageOnHangup True: New

False: Saved

NewMessageSortOrder 1: Newest First

2: Oldest First

SavedMessageSortOrder 1: Newest First

2: Oldest First

DeletedMessageSortOrder 1: Newest First

2: Oldest First

NOTE: Volume and Speed parameters must be of the same range given in the table.

Rating: 0.0/5 (0 votes cast)

Personal tools