Cisco Unity Connection Provisioning Interface (CUPI) API -- For End Users -- HTML Notification Devices

From DocWiki

Revision as of 09:55, 14 June 2012 by Deeptija (Talk | contribs)
Jump to: navigation, search
Back to: CUPI for End Users Overview


Contents


About HTML Notification Devices (in Cisco Unity Connection 9.0(1) and Later)

Cisco Unity Connection Provisioning Interface (CUPI) API allows users to view list of Html Notification Devices, a specific notification device or modify an existing HTML Notification Device.

Listing HTML Notification Devices

The following is an example of the GET request that lists the HTML notification devices for a user:

  GET /vmrest/user/notificationdevices/htmldevices

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

 <HtmlDevices>
  <HtmlDevice>
   <URI>/vmrest/user/notificationdevices/htmldevices/ 8660c5af-b544-47cc-93eb-93f4923bc03b</URI>
   <Active>false</Active>
   <CallbackNumber>1234</CallbackNumber>
   <DeviceName>HTML</DeviceName>
   <DisableMobileNumberFromPCA>false</DisableMobileNumberFromPCA>
   <DisableTemplateSelectionFromPCA>false</DisableTemplateSelectionFromPCA>
   <DisplayName>HTML</DisplayName>
   <NotificationTemplateID> 75825d74-bf4f-4af3-bf84-6226389a8611</NotificationTemplateID>
   <ObjectId> 8660c5af-b544-47cc-93eb-93f4923bc03b</ObjectId>
   <PhoneNumber></PhoneNumber>
   <SmtpAddress></SmtpAddress>
   <Undeletable>true</Undeletable>
   <SubscriberObjectId> a880bb22-0df1-45aa-893e-895ebf2d3652 </SubscriberObjectId>
  </HtmlDevice>
 </HtmlDevices>

Listing an HTML Notification Device for a User

The following is an example of the GET request that lists a particular html notification device for the end user represented by <deviceid>:

  GET /vmrest/user/notificationdevices/htmldevices/<deviceid>

The following is the response from the above *GET* request and the actual result will depend upon the information has been provided by you:

  <HtmlDevice>
   <URI>/vmrest/user/notificationdevices/htmldevices/8660c5af-b544-47cc-93eb-93f4923bc03b</URI>
   <Active>false</Active>
   <CallbackNumber>1234</CallbackNumber>
   <DeviceName>HTML</DeviceName>
   <DisableMobileNumberFromPCA>false</DisableMobileNumberFromPCA>
   <DisableTemplateSelectionFromPCA>false</DisableTemplateSelectionFromPCA>
   <DisplayName>HTML</DisplayName>
   <NotificationTemplateID>75825d74-bf4f-4af3-bf84-6226389a8611
   </NotificationTemplateID>
   <ObjectId>8660c5af-b544-47cc-93eb-93f4923bc03b</ObjectId>
   <PhoneNumber />
   <SmtpAddress />
   <Undeletable>true</Undeletable>
   <SubscriberObjectId>a880bb22-0df1-45aa-893e-895ebf2d3652
   </SubscriberObjectId>
   <UserURI>/vmrest/user</UserURI>
   <EventList>NewVoiceMail</EventList>
   <ScheduleSetObjectId>1fb3df1c-6ff6-4876-996d-59052126f1fa
   </ScheduleSetObjectId>
   <InitialDelay>0</InitialDelay>
   <RepeatInterval>0</RepeatInterval>
   <RepeatNotify>false</RepeatNotify>
  </HtmlDevice>

Modifying an HTML Notification Device for User

The following is an example of the PUT request that modifies the HTML notification device for the user as represented by <deviceid>:

  PUT /vmrest/users/notificationdevices/htmldevices/<deviceid>

The input for the PUT request will be XML or JSON as per HtmlDevice schema. The output for this request returns the successful response code.

Modifying an HTML Notification Device to Apply HTML Notification Template

The following is an example of the PUT request that modifies the HTML notification device as represented by <deviceid>:

PUT /vmrest/user/notificationdevices/htmldevices/<deviceobjectid>

 <HtmlDevice>
   <NotificationTemplateID>103c4514-db6e-489b-bc08-e9e131b60099</NotificationTemplateID>
 </HtmlDevice>


Configuring an HTML-Based Notification Template with an HTML Notification Device

This PUT request allows user to apply an HTML-based notification template with an HTML notification device. The user can perform this action if the template selection rights are given by administrator. The following is an example of PUT request:

  PUT /vmrest/users/notificationdevices/htmldevices/<deviceobjectid>

This API will modify a particular HTML notification device for the end user as represented by <deviceobjectid>.

Rating: 0.0/5 (0 votes cast)

Personal tools