User API
Administrator can use this API to create/update/delete/fetch the user with mailbox. Various attributes of user, for example notification device, greetings, contact, private list, phone menu, call transfer, screening, or personal data, can also be updated using this API .
Listing the Users
The request can be used to fetch the list of all users.
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view the list of users, 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:
|
|
Listing Users based on Email Address
In Cisco Unity Connection 11.5(1) and later, the system administrator can use email address to list the users using following URI:
|
The following is an example of the GET request that lists the details of specific user based on the email address (emailaddress is <emailaddress@domain.com>:
|
|
JSON Example
To view the details of particular user based on email address (emailaddress is <emailaddress@domain.com>), 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:
|
Listing Specific Tenant Related Users by System Administrator
In Cisco Unity Connection 10.5(2) and later, the system administrator can use TenantObjectID to list the specific tenant related user using the following URI:
|
To get the TenantObjectID, use the following URI:
|
Viewing the Details of a Specific User
The following is an example of the GET request that lists the details of specific user represented by the provided value of object ID:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view the details of particular user, do the following:
|
|
|
Creating a User
This request can be used to create a new user. The mandatory fields for creation of a user are alias and DtmfAccessId. The URI for getting user template alias is:
|
The URI for getting MailboxStoreObjectId is:
|
The ObjectId field in the response body of above URI is used as MailboxStoreObjectId. Users can be created in two ways:
-
This creates the user using default mailbox store:
POST https://<connection-server>/vmrest/users?templateAlias=<usertemplatealias>
-
This creates the user using specified mailbox store object ID:
POST https://<connection-server>/vmrest/users?templateAlias=<usertemplateAlias>&MailboxStoreObjectId=<mailboxStore-ObjectId>
<User> <Alias>texoma</Alias> <DtmfAccessId >123422</DtmfAccessId > </User>
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
Response Code: 201 /vmrest/users/f82b301d-1ec8-44c6-a3ee-0012269439bf
JSON Example
To create user, 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 a User
The following is an example of the PUT request that update details of a user:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
To update details of a user:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Update Language and TimeZone:
UseCallLanguage | UseDefaultLanguage | Language | |
---|---|---|---|
Use System Default Language | false | true | NULL/LanguageCode |
Inherit Language from Caller | true | true/false | NULL/LanguageCode |
Particular Language | false | false | Language Code |
-
URI for timezone:
https://<Connection-server>/vmrest/timezones
-
URI for installed Languages:
https://<Connection-server>/vmrest/installedlanguages
-
URI to get Language code:
https://<Connection-server>/vmrest/languagemap
<User> <UseDefaultTimeZone>false</UseDefaultTimeZone> <TimeZone>175</TimeZone> <UseDefaultLanguage>false</UseDefaultLanguage> <Language>1034</Language> </User>
Response Code: 204
JSON Example
To delete a user, do the following:
|
|
Delete a User
The following is an example of the DELETE request that can be used to delete a user:
|
|
JSON Example
To delete a user, do the following:
|
|
Explanation of Data Fields:
Field Name | Operation | Data Type | Description | ||
---|---|---|---|---|---|
Inactive | Read/Write | Boolean | A flag displays the status of a user.
Possible values:
Default Value: false
|
||
Alias | Read/Write | String(64) | A unique text name of a user. Users enter the alias to sign in to the Cisco Personal Communications Assistant (Cisco PCA).
The administrators enter the alias to sign in to Cisco Unity Connection Administration. |
||
DisplayName | Read/Write | String(64) | Descriptive name of the user. | ||
FirstName | Read/Write | String(64) | The first name (i.e., given name) of the user. | ||
LastName | Read/Write | String(64) | The last name (i.e., surname or family name) of the user, by which a user is commonly known. | ||
SmtpAddress | Read/Write | String(320) | The full SMTP address for the user | ||
TimeZone | Read/Write | Integer(4) | The time zone to which this user account is associated. URI for timezone is: https://<Connection-server>/vmrest/timezones. | ||
UseDefaultTimeZone | Read/Write | Boolean | Indicates if the default timezone is being used. Possible values:
|
||
Language | Read/Write | Integer | The preferred language of this user. For a user with a voice mailbox, it is the language in which the subscriber hears instructions played to them. If the subscriber has TTS enabled by their class of service, it is the language used for TTS. | ||
UseDefaultLanguage | Read/Write | Boolean | Set to true, if the call handler is using default language from the location it belongs to. If false, you need to specify the language, so set the particular language | ||
LdapType | Read/Write | Integer | The LDAP configuration information for the user. Possible Value:
Default Value: 0 |
||
LocationObjectId | Read Only | String(36) | The unique identifier of the LocationVMS object to which the user belongs to. | ||
IsTemplate | Read Only | Boolean | A flag indicating whether this instance of a user object is a "template" for creating new users.
Possible values:
Default Value: false |
||
Initials | Read/Write | String(64) | The initial letters of some or all of the names of the user. | ||
Title | Read/Write | String(64) | The position or function of a user within an organization, such as 'Vice President'. | ||
EmployeeId | Read/Write | String(64) | The numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. | ||
Address | Read/Write | String(128) | The physical address such as a house number and street name where the user is located, or with which a user is associated. | ||
Building | Read/Write | String(64) | The name of the building where the user is based. | ||
City | Read/Write | String(64) | The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated. | ||
State | Read/Write | String(64) | The full name of the state or province where this user is located, or with which a user is associated. | ||
PostalCode | Read/Write | String(40) | For users in the United States, the zip code where the user is located. For users in Canada, Mexico, and other countries, the postal code where the user is located. | ||
Country | Read/Write | String(2) | The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated. URI to fetch available country code: https://<Connection-server>/vmrest/languagemap. From the response fetch last 2 letter of the Languagetag parameter. | ||
Department | Read/Write | String(64) | The name or number for the department or subdivision of an organization to which a person belongs to. | ||
Manager | Read/Write | String(64) | The name of the person who is the manager or supervisor of the user. Any character except non-printing ASCII characters can be used here. | ||
BillingId | Read/Write | String(32) | Accounting information or project code associated with the user. Any ASCII or Unicode character can be used here. | ||
EmailAddress | Read/Write | String(320) | The corporate email address of the user. | ||
DtmfAccessId | Read/Write | String(40) | The DTMF access id (i.e., extension) of the subscriber. | ||
XferString | Read/Write | String(40) | The cross-server transfer extension. If NULL, the user's primary extension is used. | ||
FaxServerObjectId | Read/Write | String(36) | The unique identifier of the FaxServer object for the subscriber. | ||
PartitionObjectId | Read/Write | String(36) | The unique identifier of the partition associated with the user | ||
MediaSwitchObjectId | Read/Write | String(36) | The unique identifier of the MediaSwitch object associated with the user | ||
SearchByExtensionSearchSpaceObjectId | Read/Write | String(36) | The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string). | ||
SearchByNameSearchSpaceObjectId | Read/Write | String(36) | The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string). | ||
CosObjectId | Read/Write | String(36) | The unique identifier of the class of service object to which this user account is associated. | ||
CallHandlerObjectId | Read/Write | String(36) | The unique identifier of the primary CallHandler object for the subscriber. | ||
ScheduleSetObjectId | Read/Write | String(36) | The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within
this call handler.
|
||
TenantObjectId | Read Only | String(36) | The unique identifier of the tenant to which the user belongs. This field is reflected in the response only if the user belongs to a particular tenant. | ||
IsVmEnrolled | Read/Write | Boolean | A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they
are listed in the directory, etc.) for the subscriber when they login.
Possible values:
Default value: true |
||
SkipPasswordForKnownDevice | Read/Write | Boolean | A flag indicating whether the subscriber will be asked for his/her PIN when attempting to sign-in from a known device.
Possible values:
Default value: false |
||
ListInDirectory | Read/Write | Boolean | A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.
Possible values:
Default value: false |
||
UseShortPollForCache | Read/Write | Boolean | A flag indicating whether the user's polling cycle for retrieving the calendar information will be the shorter "power user"
polling cycle.
Possible values:
Default value : false |
||
RouteNDRToSender | Read/Write | Boolean | Flag indicating whether to Send Non-Delivery Receipts on Failed Message Delivery.
Possible values:
Default value: true |
||
Undeletable | Read Only | Boolean | Flag indicating whether a user cannot be deleted or not.
Possible values:
|
||
VoiceName | Read/Write | String(40) | The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object. | ||
DialablePhoneNumber | Read/Write | String(255) | The phone number of the fax machine that the user sends faxes to for printing. | ||
PhoneNumber | Read Only | String(255) | The corporate Phone number. | ||
CreateSmtpProxyFromCorp | Read/Write | Boolean | Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created
for the user.
Possible values:
Default value: false MailboxStoreName Read Only String Mailbox store name used by the user |