Cisco Unity Connection Provisioning Interface (CUPI) API -- User Unified Messaging Account

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


Unified Messaging Account API

Create a Unified Messaging Account

To add a new unified messaging account to user, server must have Unified Messaging Services Configured. The following URI can be used to view the user object ID:

     GET https://<connection-server>/vmrest/users/<user-objectid>

From the above URI, get the unified messaging account:

     GET https://<connection-server>/vmrest/users/<user-objectid>/externalserviceaccounts

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

<ExternalServiceAccount>
     <URI>/vmrest/users/9375d893-c8eb-437b-90bf-
   7de4b1d0c3e8/externalserviceaccounts/39871e30-849a-4dcf-b868-2faf360d503a</URI>
     <ObjectId>39871e30-849a-4dcf-b868-2faf360d503a</ObjectId>
     <ExternalServiceObjectId>1cd78b6c-1e6e-4542-a6e7-14f431d6569c</ExternalServiceObjectId>
     <SubscriberObjectId>9375d893-c8eb-437b-90bf-7de4b1d0c3e8</SubscriberObjectId>
     <UserURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8</UserURI>
     <EnableCalendarCapability>true</EnableCalendarCapability>
     <EnableMeetingCapability>false</EnableMeetingCapability>
     <EnableTtsOfEmailCapability>true</EnableTtsOfEmailCapability>
     <IsPrimaryMeetingService>false</IsPrimaryMeetingService>
     <LoginType>0</LoginType>
     <UserPassword/>
     <EmailAddress>chhavi@com</EmailAddress>
     <EnableMailboxSynchCapability>true</EnableMailboxSynchCapability>
     <EmailAddressUseCorp>false</EmailAddressUseCorp>
</ExternalServiceAccount>
Response Code: 200

To create an a new external service account, POST an XML document (formatted similar to the one above) to the following URL:

     POST https://<connection-server>/vmrest/users/<user-objectid>/externalserviceaccounts

JSON Example

GET https://<connection-server>/vmrest/users/<user-objectid>/externalserviceaccounts/<objectid>
Accept: application/json
Content-type: application/json
Connection: keep-alive

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

Response Code: 200

Updating the Unified Messaging Account

JSON Example

To view the unified messaging account, do the following:

Request URI:
PUT https://<connection-server>/vmrest/users/<userobjectid>/
externalserviceaccounts/<externalserviceaccountsobjectId>
Accept: application/json
Content-type: application/json
Connection: keep-alive
{
     "EmailAddressUseCorp":"true"
     "EnableCalendarCapability":"true"
     "EnableMailboxSynchCapability":"true"
       "EnablTtsOfEmailCapability":"true"
}

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


Explanation of Data Fields

Device Name Data Type Operations Comment
EmailAddressUseCorp Boolean Read/Write Use Corporate Email Address.
EnableTtsOfEmailCapability Boolean Read/Write Access Exchange Email by Using Text to Speech (TTS).
EnableCalendarCapability Boolean Read/Write Access Exchange Calendar and Contacts.
EnableMailboxSynchCapability Boolean Read/Write Synchronize Connection and Exchange Mailboxes (Single Inbox).

Rating: 1.0/5 (1 vote cast)

Personal tools