Configure Connection
Digium SwitchVOX guide
Prepare the SwitchVOX API account, configure its credentials in NIM, and test API access before collecting audit data.
The SwitchVOX server address and an account that can access the API. Use a dedicated account where your SwitchVOX configuration supports it.
SwitchVOX uses HTTP Digest authentication. NIM supplies the configured account credentials when it connects to the API.
NIM requires Tenant URL, Username, and Password.
Prepare the SwitchVOX accountDirect link to Prepare the SwitchVOX account
- Sign in to the SwitchVOX Admin Suite with an administrator account.
- Identify the account NIM will use for the connection. It must be either an administrator account, such as
admin, or an extension user with the API access required for your intended process. - Confirm the account can sign in successfully and that the NIM server can reach the SwitchVOX server over the configured HTTP or HTTPS port.
Avoid using an individual administrator’s account for an ongoing NIM connection. A dedicated account makes access reviews, password changes, and troubleshooting more predictable.
Configure the connection in NIMDirect link to Configure the connection in NIM
- In NIM Studio, open Systems > Overview and add a Digium SwitchVOX system, or select the existing system.
- Open its Connection screen.
- Enter the following settings and save the connection.
| NIM setting | Value |
|---|---|
| Tenant URL | The SwitchVOX server URL using the protocol and port configured for your deployment. |
| Username | The administrator or extension account username authorized for API access. |
| Password | The password belonging to that account. |
If SwitchVOX uses a private or internally issued certificate, ensure the NIM server trusts the issuing certificate authority before testing an HTTPS connection.
Validate accessDirect link to Validate access
- Select Test Connection. NIM calls
/json/using the configured Tenant URL to check whether the API is working. - Confirm that the test succeeds, then collect the SwitchVOX system in NIM.
- Inspect extensions, directory, and accessControl to confirm that the expected records load without authentication or connection errors.
- If the test or collection fails, verify the Tenant URL, network path, account credentials, and account permissions. Re-enter the password if it was recently changed.
- Confirm that the collected data covers the intended users and access before using it in NIM filters and reports.
The connection test checks API access. Validate the required collections separately. This connector is read-only.