End User API
Cisco Personal Communication Assistant users that are also called end users can use this API to perform the following operations:
-
Update transfer options (basic transfer rules), unified messaging account passwords (Connection 8.5 and later), external services account passwords (Connection 8.0), and user passwords and PINs.
-
Record greetings and voice names.
-
Create, read, update, and delete private lists and private list members, alternate names, and user-defined alternate extensions
-
Read SMTP proxy addresses, basic user information (for example, alias, display name, and DTMF access ID), class of service information, and administrator-defined alternate extensions.
To access all of the APIs mentioned in this document, the end user must login using his/her credentials.
Listing the Details of End User
The request can be used to fetch the end user's details. It provides basic details of an end user.
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Updating Details of the End User
This request can be used to update the end user's details where only the ListInDirectory field can be updated.
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Parameter |
Operations |
Data Type |
Comments |
---|---|---|---|
First Name |
Read Only |
String |
The first name (i.e., givenName) of this user. |
Last Name |
Read Only |
String |
The last name (i.e., surname or family name) of this user, by which a user is commonly known. |
Alias |
Read Only |
String |
A unique text name for User. Users enter the alias to sign in to the Cisco Personal Communications Assistant (Cisco PCA). |
DisplayName |
Read Only |
String |
Descriptive name for the user. |
VoiceFileURI |
Read Only |
String |
Specifies the URI of voice file. |
ListInDirectory |
Read/Write |
Boolean |
A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers. Values: •false:Do not list in Directory •true: List in directory Default Value: true. |
DTMFAccessId |
Read Only |
String |
The DTMF access id (i.e., extension) of the subscriber. |
SMTPAddress |
Read Only |
String |
The full SMTP address for the user |
EmailAddress |
Read Only |
String |
The corporate email address of the user. |