Netsapiens Configuration

This article demonstrates how to configure Netsapiens.

Article #: 25

How To: configure Netsapiens

Similar questions: configure Netsapiens, set up Netsapiens, configure Netsapiens with Xima CCaaS, set up Netsapiens with Xima CCaaS

Purpose: demonstrate how to configure Netsapiens


  1. Create an API user within Netsapiens. This API user will serve as both the API user and as the extension in which we will receive calls from Contact Center with. To begin, go to Users > Configuration > Add User (button near the bottom of the screen)
  2. Click the Xima domain
  3. Fill out the fields of information listed.

Here are a few tips when filling out the fields:

  • When creating a password, make sure it is strong and secure.
  • Notice that the Call Limit is set to Unlimited by default. This is the setting we recommend, but if you would like to change the call limit, you can.
  • When determining the Scope, it’s important to know that in order to pull API information across, in this case the users from Netsapiens, you need to have a Call Center Supervisor at a minimum to have that permission.
  1. Click Create.
  2. Click Create User Device.
  3. You will now need to log in to the Xima CCaaS portal. To do this, Web to Xima CCaaS with the URL that has been provided (i.e.,
  4. At the login screen, enter Username and Password and hit Login.

The first thing you may notice once logged in is the error message that appears at the bottom of the screen. This error simply means that you are not connected to anything yet. That is fine and is to be expected.

  1. Along the left-hand side in the navigation pane, select Admin (System) (cog wheel icon) > Target Platform Configuration
  2. A new window called “Netsapiens Platform Settings” will appear. You will need to fill in the fields of information below. To get that information, sign into the Xima Manager Portal.
  3. After signing into the Xima Portal, go to Domains > xima > Users
  4. Search for your extension (the user name of the API user you created) and click it when it pops up.
  5. Select the Edit icon associated with your extension.
  6. A dropdown menu will appear. Click on Phones.
  7. A window called “Edit Phone” will appear, and here you’ll be able to see a lot of the information you need to fill out the Netsapiens Platform Settings window in Xima CCaaS. You will see the Domain and Outbound Proxy. Enter this information into your Netsapiens Platform Settings window. Keep this window open for later.

When copying and pasting the Outbound Proxy, do not include the SIP Proxy Server Port portion. The SIP Proxy Server Port will most likely be :5060.

  1. The next field of information to fill out in the Netsapiens Platform Settings window is the API URL. This information is in the URL of the Xima Manager Portal. Copy the first part of the URL (copy up until the .com/), and paste this information into the API URL field in your Netsapiens Platform Settings window.
  2. While still in the Netsapiens Platform Settings window, type in the Admin Username and Admin Password. This is the username and password of the API user you created within Netsapiens.
  3. The last fields of information to fill out on the Netsapiens Platform Settings window are the Client ID and the Client Secret. To obtain this information, go to the Netsapiens admin portal, which is where we initially started and created our API user.
  4. Go to System > Settings > Advanced > Oauth Clients
  5. Click Add
  6. Type in a Client ID name and click Create.
  7. Click the Client ID name you just created and you’ll see that the Client Secret is listed a few lines down.
  8. Go back to the Netsapiens Platform Settings window to copy and paste your new Client ID name and the Client Secret.
  9. Click Save.
  10. A new window called “Confirm Changes” will appear. Click OK.
  11. While still in Xima CCaaS, go to Admin (System) > Manage SIP Extensions
  12. A new window called “SIP Extensions” will appear. Click the + icon located in the upper right hand corner of the window.
  13. A new window called “Add Extension” will appear. Here you will need to enter the SIP Extension and the SIP Password. To get this information, go back to the Xima Manager Portal. In step 14, we instruct you to keep the “Edit Phones” window open. This is because the SIP Extension and SIP Password information are listed in that window. The SIP Extension is the Username and the SIP Password is the Password. Please still keep the “Edit Phones” window open.
  14. Go back to the Add Extension window in Xima CCaaS and copy and paste the corresponding information.
  15. Click Save.
  16. A new window called “Confirm Changes” will appear. Click OK.
  17. Click Done when your extension has been registered.
  18. Go to the Xima CCaaS Admin portal. This is done by copying the Xima CCaaS URL (copy up until the .com), and this will take you to a page where you can download the Xima Desktop.
  19. Once logged into the Xima CCaaS Admin portal, go to User Management > User Licenses. Here you will be able to see that all of your users have been pulled over.
  20. Go back to the Xima Manager Portal where you will see the “Edit Phones” window. Click Save.
  21. Click Inventory and you’ll be able to see many different DIDs.
  22. Select the appropriate DID and go to the User field. Type in your API user and click Save.