In this tutorial, you will learn how to set up a new softswitch.  When you are finished, you will be able to:

  1. Register a SIP phone with our softswitch
  2. Make a call from your SIP phone
  3. View CDRs from the perspective of your Customer, and view Vendor CDRs from the perspective of the softswicth administrator

The tutorial uses as an example a fictitious company named: 'Call Integrale'.   The tutorial also uses a fictitious Vendor named: 'Lancia Tele'.  Both, 'Call Integrale' and 'Lancia Tele' will be useful as you learn various concepts and the roles of each party involved in a call.


To learn the most from the tutorial, you will need:

  • A SIP termination provider that you can terminate voice calls to
  • A SIP phone

Step 0. Login & configuration of "My Preference"

Sippy recommends starting from the configuration of settings in "My Preference" menu when the softswitch operator logs into the Softswitch for the very first time, 

Mandatory settings:

  1. Set the base currency - default currency that the system will use to display all costs/prices etc. for the softswitch operator
  2. Set an Email - email is used for system notifications
  3. Mail "From" Header - will result in your emails. This should be configured in the preferences of the root user according to your SMTP settings. SMTP does not work with the default mail 'From' header specified for the ssp-root user in case a custom SMTP server is being used
  4. Allow API Calls/API Password - activate the use of API functionality
  5. Web Password/Confirm Password  - update the web password for the user that the operator used to log in
  6. Allowed Hosts - comma or space-separated list of allowed IPs for the login by the current user

Step 1. Setting up Vendors

The first step is to create a new Vendor, and a Vendor Connection.  In the example, we are using the fictitious for termination; they have provided us a SIP gateway called

Creating our first Vendor

  1. Navigate to the Vendors screen by clicking on 'Vendors' in the left hand navigation menu
  2. Click the 'Add' button

  1. On the 'Add New Vendor' screen; 
    1. Enter the name of your Vendor into the Vendor Name field
    2. The Web Login and Web Password fields will automatically be filled in; this optionally allows your Vendors to log into your system to see CDRs related to their Connections
    3. Set the Base Currency, this should be the currency in which you do business with your Vendor.  The tutorial uses USD
    4. Set the Time Zone to match the Time Zone your vendor bills you in.  This will make future reporting and reconciliation with your Vendor easier
    5. The Balance field is used to track the balance you have with your Vendor.  For example, you could leave the Balance at zero, and as you terminate calls, the Balance will become negative
    6. Click Save & Close

The Add New Vendor Screen

Creating Vendor Connections

The next step is to create a Connection under the newly created Vendor.  It is common for a Vendor to have multiple Connections, but in this guide you will only see one created.

  1. On the Vendors screen, click the 'Open Connections' action link corresponding to the newly created Vendor.

  1. On the Connections screen, click the Add button

  1. On the Add New Connections screen
    1. Give your connection a meaningful name inside the Connection Name field
    2. Select the protocol of your connection using the Protocol pick-list.  This guide uses SIP in the example
    3. Set the hostname or IP address of your Vendor's gateway connection 
    4. If your Vendor requires digest authentication, then enter their credentials in the Username and Password fields.  If your Vendor does not use digest authentication, then you can leave the fields blank. Click here for more information on Authentication
    5. Optionally, if you need to add or remove prefixes for your traffic for this connection you can do so in the Number Translation section on this screen.  Click here to learn more about Number Translation
    6. Click the Save & Close button