Required Information to Integrate Xima CCaaS with Netsapiens

Overview

To establish a connection between Xima CCaaS and Netsapiens, you will need:

• SIP proxy information
• Domain details
• API credentials (OAuth client ID and secret)
• API user credentials
• A DID for inbound testing

Each item is explained in detail below.

---

Required Information

Domain

The Domain is the name assigned within your Netsapiens environment.

You can locate the Domain:

• Under the Domain tab (for Super Users)
• Under the Inventory tab
• Within the phone provisioning section (for Office Manager roles or higher)

---

SIP Proxy Server Host (sip_proxy_server_host)

This is typically the same hostname used to access your Netsapiens management portal.

Example format:

yourcompany.domain.com

This value is also commonly listed under the phone configuration settings as the Outbound Proxy.

---

SIP Proxy Server Port (sip_proxy_server_port)

The default port is typically 5060, unless your provider specifies otherwise.

Confirm this value under the phone configuration or outbound proxy settings.

---

API URL (api_url)

This is the full URL used to access the Netsapiens management portal.

Example format: [https://yourcompany.domain.com]

This must be the correct portal URL for your specific Netsapiens instance.

---

API Client ID (api_client_id) and API Client Secret (api_client_secret)

These are OAuth credentials generated within the Netsapiens Admin Portal. They allow Xima CCaaS to securely access the Netsapiens API.

Where to Create OAuth Credentials

1. Log in to the Netsapiens Admin Portal: https://{FQDN}/SiPbx/adminlogin.php
2. Navigate to: System → Settings → Advanced → OAuth Clients
3. Select Add
4. Enter a Client ID name
5. Leave the Redirect URL field blank
6. Select Create

The system will generate:

• Client ID
• Client Secret

You may need to refresh the page to view the newly created credentials.

Important Notes:

• Each application accessing the Netsapiens API must have its own OAuth client.
• The Client ID and Secret can be revoked or deleted at any time from the Admin Portal.

---

API Username (api_username) and API Password (api_password)

These are the credentials for a Netsapiens user account that has sufficient permissions to allow API access.

Minimum recommended role:

• Office Manager

Higher-level roles such as Call Center Supervisor, NDP, Reseller, or Super User are also acceptable.

Important:

• The user must have a secure password set.
• If it does not show “Secure password set,” create a new Portal/API password in the Admin Portal.

---

DID (For Inbound Testing)

A valid DID is required to test inbound call routing into Xima CCaaS.

This DID should:

• Be assigned within Netsapiens
• Route to the configured CCaaS virtual handset or extension

---

Verifying API Access

If you are unable to pull users from Netsapiens into Xima CCaaS, verify the following:

1. The API URL is correct
2. The Client ID and Client Secret are valid
3. The API username and password are correct
4. The API user has sufficient permissions
5. The user shows “Secure password set”

You can verify OAuth clients under:

System → Settings → Advanced → OAuth Clients

You can verify user permissions under:

Users → Configuration → Select User → Scope