Configure Connection

Cisco Unity CUPI guide

Prepare CUPI API access, enter the hostname and credentials in NIM, and test access to the users endpoint.

Before you startDirect link to Before you start

Configure API access using the Cisco CUPI API overview. CUPI uses HTTPS and Basic Authentication; access is determined by the account's assigned administrative roles. See Cisco's authentication and authorization guidance.

NIM requires Hostname, Username, and Password.

Have your Cisco administrator configure a dedicated account for the integration using the vendor documentation linked above.
Assign the administrative roles required to read user data and perform the user and voicemail operations your NIM process needs.
Obtain the Cisco Unity Connection hostname and integration account credentials.
Confirm that NIM can reach the server's CUPI API over HTTPS.

In NIM Studio, open Systems > Overview and add a Cisco Unity CUPI system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Hostname	The hostname of the Cisco Unity Connection server NIM will access.
Username	The integration account username authorized for CUPI access.
Password	The password belonging to that account.

Select Test Connection. NIM calls the users endpoint with this query:
```
GET /users?query=(alias startswith ZZ)
```
The query checks access by looking for users whose alias starts with ZZ. A successful response may contain no matching users; a user with that prefix is not required for the endpoint to work.
Confirm that the test succeeds. If it fails, verify the hostname, credentials, HTTPS connectivity, and account roles.
Collect the system and inspect users and the other collections needed by your voicemail management process.
Validate intended lifecycle changes and delegated form actions with safe test records before enabling scheduled automation or granting operators access to those forms.

The connection test checks read access to the users endpoint. Validate each intended write operation separately.

Step 1 of 3