Reading a User's Information
To read a user's information, do the following GET request:
GET http://<connection-server>/vmrest/users/{objectid}
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Links to Other API pages: Cisco_Unity_Connection_APIs
To read a user's information, do the following GET request:
GET http://<connection-server>/vmrest/users/{objectid}
To create a user account, do the following POST request:
POST http://<connection-server>/vmrest/users?templateAlias=voicemailusertemplate
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User>
<Alias>jdoe</Alias>
<DtmfAccessId>7890</DtmfAccessId>
</User>
The following is the result of the above POST request:
201 Created
The HTTP response will include the full URI to the newly created user in the Location header.
To modify a user account, do the following PUT request:
PUT http://<connection-server>/vmrest/users/{objectid}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User>
<DisplayName>johnd</DisplayName>
</User>
The following is the result of the above PUT request:
204 Accepted
To delete a user account, do the following DELETE request:
DELETE http://<connection-server>/vmrest/users/{objectid}
The following is the result of the above DELETE request:
200 OK
To search for a user account, do the following GET request:
GET http://<connection-server>/vmrest/users?query=(alias%20startswith%20ab)
The reset the MWI for a user:
POST http://<connection-server>/vmrest/users/{objectid}?method=resetmwi