Skip to main content

Configure Connection

Digium SwitchVOX guide

Follow this focused guide to configure and validate Digium SwitchVOX in NIM.

What you need

The SwitchVOX server address and an account that can access the API. Use a dedicated account where your SwitchVOX configuration supports it.

Authentication

SwitchVOX uses HTTP Digest authentication. NIM supplies the configured account credentials when it connects to the API.

Prepare the SwitchVOX account​

  1. Sign in to the SwitchVOX Admin Suite with an administrator account.
  2. 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 workflow.
  3. Confirm the account can sign in successfully and that the NIM server can reach the SwitchVOX server over the configured HTTP or HTTPS port.
Use a dedicated integration account

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 NIM​

  1. In NIM, create or open the Digium SwitchVOX system.
  2. On the Connection tab, enter the SwitchVOX server address and the API account username and password.
  3. Select the appropriate protocol and port for your SwitchVOX deployment, then save the connection.
  4. If SwitchVOX uses a private or internally issued certificate, ensure the NIM server trusts the issuing certificate authority before testing an HTTPS connection.

Validate access​

  1. Collect the SwitchVOX system in NIM.
  2. Confirm that the expected tables load and that NIM reports no authentication or connection errors.
  3. If collection fails, verify the server address, network path, account credentials, and account permissions. Re-enter the password if it was recently changed.
About Digest authenticationDigest authentication verifies the configured username and password through an HTTP challenge-response exchange. A prior interactive SwitchVOX browser session or browser cookies are not required for NIM to authenticate.