Contents

Unified Messaging Account API

A user may have zero or more unified messaging service accounts (also known as external service accounts). Examples of these services include Cisco Unified MeetingPlace 8.0, Exchange 2003, Exchange 2007, Exchange 2010. Using CUPI for End Users, a user can:

Retrieve a list of its unified messaging service accounts,

Retrieve one of its unified messaging service accounts, and

Change the password for one of its unified messaging service account

Listing all the Unified Messaging Accounts
In the following example, the user has two unified messaging service accounts, Exchange2K3 and Exchange2K7.

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

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

For each unified messaging service account, CUPI returns the following information:

URI - The URI for retrieving the unified messaging service account

IsEnabled - A flag to indicate whether the unified messaging service account is enabled

UseServiceCredentials - A flag to indicate whether service credentials or user credentials are used to sign in the unified messaging service account

LoginType - A flag to indicate whether the user alias (0), a guest account (1), or a specified user ID (2) is used to sign in the account

UserId - The user ID to sign in to the unified messaging service account, if one is used

ObjectId - The unique ID of the unified messaging service account

Display Name - The display name of the unified messaging service account

Listing Details of Particular Unified Messaging Service Account
To retrieve a specific unified messaging service account, use the GET method with the URI field from above as follows:

GET http://<connection-server>/vmrest/user/externalserviceaccounts/<unified-messaging-account-objectid>
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

Updating the Unified Messaging Account

Some unified messaging service accounts use service credentials to sign in and others employ user-supplied credentials. This is indicated by the UseServiceCredentials field. For unified messaging service accounts that require user credentials for signing in (for example, those with UseServiceCredentials set to false), the user may specify the password using a PUT method by using the unified messaging service account URI and a query parameter, _password_, as follows.

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

Note that if you attempt to specify the password of a unified messaging service account that does not require a user password (for example, one where UseServiceCredentials is set to true), an error will be returned.