Contents

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.

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

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

Explanation of Data Fields:

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:

true: if default time zone is to be used

false: to use specific time zone, if false is selected timezone should be also specified.

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:

0-Do not Integrate with LDAP directory.

1-Integrate with LDAP directory

2-Authenticate

4-Inactive

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:

true: if user template

false: if user

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.

Note: To update the ScheduleSetObjectId ,first go to the user URI, then go to the callhandler URI, and then update the scheduleset.

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:

false: The enrollment conversation is not played for the subscriber when they login.

true: The enrollment conversation is played for the subscriber when they login.

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:

false: Do not Skip PIN When Calling From a Known Extension

true: Skip PIN When Calling From a Known Extension

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:

false: Do not list in Directory

true: List in directory

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.