Cisco Unity Connection Imaging Interface (CUII) API -- Using CUII for Getting the Message Status

From DocWiki

Links to Other API pages: Cisco_Unity_Connection_APIs

CUII Contents

API Overview Using CUII for Getting the Message Status Using CUII for Getting Message Specific Information Using CUII to View the Current MWI Status Using CUII to Get the Current Status of a Message Error Handling

   
GET https://<connection-server>/vmrest/mailbox/folders/inbox/<user-alias>/notification

The above request returns unread message count, unread urgent count, MWI status, and MWI image URL for the INBOX folder. The following are the sample GET requests and responses. The values can differ depending on the state of the mailbox. Note that for displaying correct behavior of MWI status and its corresponding image, MWI must be configured properly in the system. If not configured properly, the default value 'OFF' is returned, even if the unread messages are present in the mailbox.

Get Request

   GET https://<connection-server>/vmrest/mailbox/folders/inbox/jsmith/notification
   Response
   <NotificationInformation>
   <UnreadMsgCount>2</UnreadMsgCount>
   <UnreadUrgentMsgCount>0</UnreadUrgentMsgCount>
   <Mwi>ON</Mwi>
   <MwiImageUrl>
   /vmrest/mailbox/folders/inbox/jsmith/mwistatusimage
   </MwiImageUrl>
   <MsgState> </MsgState>
   <MsgStateImageUrl> </MsgStateImageUrl>
   </NotificationInformation>

Get Request

   GET https://<connection-server>/vmrest/mailbox/folders/inbox/gjoseph/notification
   Response
   <NotificationInformation>
   <UnreadMsgCount>4</UnreadMsgCount>
   <UnreadUrgentMsgCount>2</UnreadUrgentMsgCount>
   <Mwi>ON</Mwi>
   <MwiImageUrl>
   /vmrest/mailbox/folders/inbox/gjoseph/mwistatusimage
   </MwiImageUrl>
   <MsgState> </MsgState>
   <MsgStateImageUrl> </MsgStateImageUrl>
   </NotificationInformation>