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

From DocWiki

Revision as of 10:42, 1 November 2013 by Deeptija (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


Unified Messaging Account API

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

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

From the above URI, get the unified messaging account:

    GET https://<connection-
    server>/vmrestvmrest/usertemplates/<usertemplateobjectid>/templateexternalserviceacco
    unts


Updating the Unified Messaging Account

Request Body: 
<TemplateExternalServiceAccount>
    <EmailAddressUseCorp>true</EmailAddressUseCorp>
    <EnableCalendarCapability>true</EnableCalendarCapability>
    <EnableMailboxSynchCapability>true</EnableMailboxSynchCapability>
    <EnableTtsOfEmailCapability>true</EnableTtsOfEmailCapability>
</TemplateExternalServiceAccount> 

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 

JSON Example

To view the unified messaging account, do the following:

Request URI:
GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/templateexternalserviceaccounts/<templateexternalserviceaccountsobjectId 
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:

{
    "EmailAddressUseCorp":"true"
    "EnableCalendarCapability":"true"
    "EnableMailboxSynchCapability":"true"
     "EnablTtsOfEmailCapability":"true"
}
Response Code: 200

Explanation of Data Fields

Device Name Data Type Operation Comments
EmailAddressUseCorp Boolean Read/Write Use Corporate Email Address

Default value: False

EnableTtsOfEmailCapability Boolean Read/Write Access Exchange Email by Using Text to Speech (TTS)

Default value: False

EnableCalendarCapability Boolean Read/Write Access Exchange Calendar and Contacts

Default value: False

EnableMailboxSynchCapability Boolean Read/Write Synchronize Connection and Exchange Mailboxes (Single Inbox)

Default value: False

Rating: 0.0/5 (0 votes cast)

Personal tools