Cisco Unity Connection Provisioning Interface (CUPI) API -- Mailbox Quota alert

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


Mailbox Quota Alert

These APIs are capable of retrieving and updating the email notification Mailbox Quota Alert text from CUC.

Acceptance criteria :

  • GET API to view the "header" and body of the quota alert text in specified language.
  • API to set the "header" and body of the quota alert text for specified language.


GET : https://<connection-server>/vmrest/mailboxquotatexts

This API can be used by Administrator to fetch the list of Mailbox Quota alerts that will be used as email notification alert texts for end user. Currently, there is only one Mailbox Quota Alert which is Warning Quota, that can be configured in different languages. Output of this API will be:

<MailboxQuotaTexts total="1">

                <MailboxQuotaText>

                        <URI>/vmrest/mailboxquotatexts/da9d6130-baf7-4b8b-8aa5-1d973567d0b6</URI>

                        <ObjectId>da9d6130-baf7-4b8b-8aa5-d973567d0b6</ObjectId>

                        <Body/>

                        <DefaultBody>Your mailbox has exceeded the quota warning threshold specified by your administrator.
\n\nCurrent Usage: %CURRENTUSAGE%\nQuota Warning Threshold: %THRESHOLD%\nQuota Size Limit: %LIMIT%\n\
nPlease reduce your mailbox size by deleting few items from your mailbox.</DefaultBody>

                        <DefaultSubject>Voicemail Mailbox Quota Warning</DefaultSubject>

                        <LanguageCode>1033</LanguageCode>

                        <Subject/>

                        <UseDefault>true</UseDefault>

                       <RuleDescription>Text for Mailbox Warning Quota</RuleDescription>

               </MailboxQuotaText>

</MailboxQuotaTexts>

GET : https://<connection-server>/vmrest/mailboxquotatexts/<mailboxQuotaTextObjectId>

This API can be used by Administrator to fetch the details of a particular Mailbox Quota Alert.

Output of this API will be:

<MailboxQuotaText>

          <URI>/vmrest/mailboxquotatexts/da9d6130-baf7-4b8b-8aa5-1d973567d0b6</URI>

          <ObjectId>da9d6130-baf7-4b8b-8aa5-1d973567d0b6</ObjectId>

          <Body/>

          <DefaultBody>Your mailbox has exceeded the quota warning threshold specified by your administrator.\n\nCurrent Usage: %CURRENTUSAGE%\nQuota 
Warning Threshold: %THRESHOLD%\nQuota Size Limit: %LIMIT%\n\nPlease reduce your mailbox size by deleting few items 
from your mailbox.</DefaultBody>

          <DefaultSubject>Voicemail Mailbox Quota Warning</DefaultSubject>

          <LanguageCode>1033</LanguageCode>

          <Subject/>

          <UseDefault>true</UseDefault>

          <RuleDescription>Text for Mailbox Warning Quota</RuleDescription>

</MailboxQuotaText>

PUT : https://<connection-server>/vmrest/mailboxquotatexts/<mailboxQuotaTextObjectId>

This API can be used by an administrator to modify the subject line, body and Use Default flag for the email notification alert for the end users. If an administrator updates “UseDefault” option to false and if “Subject” and “Body” (customized subject and body texts) of the Alert are null in the database or in input XML, then it is mandatory to provide both of them. Input will be an XML with following data :

<MailboxQuotaText>

           <Body>changed body content</Body>

           <Subject>Changed subject line</Subject>

           <UseDefault>false</UseDefault>

</MailboxQuotaText>
Output: HTTP response code : 204


Explanation of Data Fields

The following chart lists all of the data fields:

Parameter Data Type Operations Description
URI String Read-only URI of Mailbox Quota alert
ObjectId Char(36) Read-only Acts as a primary key for the API. The ObjectID is a unique system-generated identifier for a Mailbox Quota Alert object.
Body String Read/Write Customized body text for Mailbox Quota Alert.
DefaultBody String Read-only Default body text for the Mailbox Quota Alert
DefaultSubject String Read-only Default subject line for Mailbox Quota Alert
LanguageCode Integer Read/Write Specified the language code in which the alert will be displayed
Subject String Read/Write Customized subject line for Mailbox Quota Alert
UseDefault Boolean Read/Write Specify that whether DefaultSubject and DefaultBody is used or not.

Values can be:

  • false -0
  • true -1
RuleDescription String Read-only Specified the type of Mailbox Quota Alert

Labels:None

Rating: 0.0/5 (0 votes cast)

Personal tools