Cisco Unity Connection Provisioning Interface (CUPI) API -- Mailbox Store API
Mailbox Stores Configuration
Administrator can use this APIs for creating, reading, modifying and deleting mailbox stores for listing,viewing, creation, selection, and deletion. During installation, Cisco Unity Connection automatically creates:
- A mailbox store database for information on voice messages (who each message was sent to,when it was sent, the location of the WAV file on the hard disk, and so on).
- An operating-system directory for voice message WAV files.
- An administrator with the required permissions can create up to four additional mailbox stores. Each additional mailbox store includes:
- Another mailbox-store database for information on voice messages that are saved in that mailbox store. The database is pre-sized for an average of approximately 40 messages each for 10,000 users, or about 1.25 GB. (The database application currently being used for Connection cannot dynamically resize a database after it is created.)
- Another operating-system directory for the voice message WAV files and other message attachments.
Listing the Mailbox Stores
The following is an example of the GET request that lists all the mailbox stores:
|
The following is the response from the above *GET* request.
|
|
JSON Example
To list all mailboxstores(GET), do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Viewing the Specific Mailbox Stores
The following is an example of the GET request that lists the details of specific mailbox stores represented by the provided value of mailbox store object ID:
|
The following is the response from the above *GET* request:
|
|
JSON Example
To view individual mailbox store (GET), do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Viewing the Number of Mailboxes in a Mailbox Store
The following is an example of the GET request that lists the number of mailboxes in a mailbox store represented by the provided value of mailbox store object ID:
|
The following is the response from the above *GET* request:
|
JSON Example
To view the number of mailboxes in a mailbox store, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Creating the Mailbox Store
The parameters that can be given as part of the POST Request Body are : DisplayName, MaxSizeMB,Mounted, Undeletable. Even If the other values such as "server" are mentioned as part of the request body , the values will not be used while creation and default values will be used. The following is an example of the POST request that creates a mailbox store:
|
The following is the example of the response from the above *POST* request:
|
JSON Example
To create a new mailbox store, do the following:
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
Updating the Mailbox Stores
The following is an example of the PUT request that allows you to update the content of the mailbox store:
|
The output for this request returns the successful response code.
JSON Example
To update mounted field of mailbox store, do the following:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Deleting the Mailbox Store
The following is an example of the DELETE request that deletes a specific mailbox store where you need to mention the mailbox store object ID:
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
The output for this request returns the successful response code.
JSON Example
To delete mailbox store, do the following:
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
The following chart lists all of the data fields:
Parameter | Data Type | Operations | Description |
---|---|---|---|
URI | String | Read Only | The URI of the mailbox store. |
MailDatabase | String (512) | Read Only | The name of the mailbox database,such as "UnityMbxDb1". For external IMAP mailstores this value will be NULL. |
Server | String (256) | Read Only | The name of the server on which the mailbox store resides. |
ObjectId | String (36) | Read Only | A globally unique, system-generated identifier for a MailboxStore object. |
Mounted | Boolean | Read/Write | A flag indicating whether the mailbox store
is mounted. You should check this setting before accessing the mailbox store
database. Tools can set it to denote that a mailbox store is offline when
offline database maintenance needs to be performed.
Default Value: true |
RequiredSecurity | String | Read Only | The method of encryption that Cisco Unity
Connection will use on a mailbox store connection. Possible values are:
Default Value: 0 |
MailboxStoreType | String | Read Only | The type of mailbox store (e.g.,UMSS).
Possible values are:
Default Value: 0 |
DisplayName | String (64) | Read/Write | A descriptive name for the message Store. |
DbInstance | String (256) | Read Only | The name of the dbinstance on which the
mailbox store resides.
Default Value: ciscounity Status Read Only String Current status of the mailbox store. Possible values are:
|
Undeletable | Boolean | Read/Write | A flag indicating whether this mailbox
store can be deleted. It is used to prevent deletion of factory defaults.
Default Value: true |
LastError | String | Read Only | Last error result from a mailbox store
maintenance action, that is create or delete. Possible values are:
Default Value: 0 |
MaxSizeMB | Integer | Read/Write | This is the max size in MB for the mailbox
store. The range can vary from 1 to 2147483647.
Default Value: 15000 |
TotalSizeOfMailbox | String | Read Only | Total Size of the voicemail messages and the mailbox attachments in the mailbox store. |
TimeAtWhichSizeCalculated | String | Read Only | Time at which the total size of mailbox store was calculated. |
MailboxesURI | String | Read Only | The URI of the mailboxes. |