REST API Support for Squared UC in Unity Connection 11.5 EDCS-1554157 July 15, 2015
Notice The information in this presentation is provided under Non-Disclosure agreement and should be treated as Cisco Confidential. Under no circumstances is this information to be shared further without the express consent of Cisco. Any roadmap item is subject to change at the sole discretion of Cisco, and Cisco will have no liability for delay in the delivery or failure to deliver any of the products or features set forth in this document.
Agenda Introduction CUPI API CUMI API Users query enhancement 'USN' and 'UID Validity' information of supported mailbox folders Message query support with USN 'greater than' search criteria
Introduction Release 11.5 onwards, below enhancements have been incorporated: CUPI API Added support for searching of users based on ‘Corporate Email Address’ CUMI API Added support for mailbox synchronization based on ‘USN’ and ‘UID Validity’ attributes Added support to search user messages with USN ‘greater than’ a given value
CUPI API - Users Query Enhancement
Overview Enhanced CUPI API to allow searching of users based on "Corporate Email Address". Supported CUPI API Query Structures are : http://<connectionserver>/vmrest/users?query=(emailaddress is abc@cisco.com) http://<connectionserver>/vmrest/users?query=(emailaddress startswith abc@cisco.com) http://<connectionserver>/vmrest/users?query=(emailaddress isnotnull) http://<connectionserver>/vmrest/users?query=(emailaddress isnull) NOTE :If there are more than one user with the same ‘Corporate Email Address’, all users will be listed.
Example of CUPI Users query:
CUMI API – 'USN' and 'UID Validity' information of mailbox folders
Overview To extend the functionality of mailbox folders, additional attributes will be returned on executing the mailbox query: USN (Unique Sequence Number) UID Validity (Unique Identifier Validity) – Creation time of mailbox.
Example of earlier response Earlier response attributes: URI Display Name Message Count
New Response of mailbox query New attributes shown in the response below: USN UID Validity NOTE : Doing any operation on Inbox folder will impact the USN of both ‘Inbox’ and ‘Deleted’ folder.
‘Inbox’ folder example Sending an HTTP GET Request to the URI, server generated response will be as shown below:
'Deleted' folder example
'Sent' folder example
CUMI API - Message query Support with USN 'greater than’ search criteria
Overview CUMI API has been extended to fetch the messages having USN greater than any given value. Supported CUMI API query structure for Inbox/Sent/Deleted folder is: http://<connectionserver>/vmrest/mailbox/folders/<mailbox- folder>/messages?userobjectid=<userobjectid>&<usngreaterthan= number> Sample query: http://<connectionserver>/vmrest/mailbox/folders/<inbox>/message s?userobjectid=<8790536f-d391-4273-843d- cbe466a9f938>&usngreaterthan=<6>
'Inbox' folder example Sending an HTTP GET Request to the URI, server generated response will be as shown below:
'Sent' folder example
'Deleted' folder example
Troubleshooting Find Troubleshooting tips at the below link:
References Doc Wiki Links: http://docwiki-dev.cisco.com/wiki/Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_-- User_API#Listing_Users_based_on_Email_Address http://docwiki- dev.cisco.com/wiki/Cisco_Unity_Connection_Messaging_Interface_%28CUMI%29_API_-- _Using_the_CUMI_API#Filtering