Zentrunk & Freeswitch

This documentaion provides a basic configuration to get FreeSwitch up and running with Plivo as the external SIP gateway. This doumentation was written using a Debian Jessie GNU/Linux System running FreeSwitch 1.6.6.

Notes: There are many softphones that you can use (e.g., X-Lite, Blink for Linux, etc). In this tutorial, we will be using the X-Lite Softphone.
Warnings: Make sure that you have read through the Getting Started with Zentrunk Guide and have all of the Pre-requisites before you start this tutorial.

Installation of Freeswitch

On your Debian system, execute the following commands in the terminal.

  1. Update the Package Manager.
    $ apt-get update && apt-get install -y curl
    
  2. Add the Public Key of FreeSwitch packange to local Pacakage Manager.
    $ curl https://files.freeswitch.org/repo/deb/debian/freeswitch_archive_g0.pub | apt-key add -
    
  3. Add the FreeSwitch repository URL to the source list of local Package Manager.
    $ echo "deb http://files.freeswitch.org/repo/deb/freeswitch-1.6/ jessie main" > /etc/apt/sources.list.d/freeswitch.list
    
  4. Install the FreeSwitch package.
    $ apt-get update && apt-get install -y freeswitch-all freeswitch-all-dbg gdb
    
  • To install Freeswitch on CentOS, follow the instructions given here
  • To install Freeswitch on Windows, follow the instructions given here

Configuring your Freeswitch

To configure the Freeswitch to connect to your Plivo Zentrunk, first locate the root configuration of FreeSwitch on your machine. These locations vary from platform to platform.
In this case (Debian Jessie GNU/Linux System), the root configuration is present at /etc/freeswitch/.
For Windows, the root configuration is located at C:\Program Files\FreeSWITCH\conf.
For Linux systems, it could be either of the following depending on your installation -

  • /usr/local/freeswitch/conf
  • /opt/freeswitch/conf

With the root configuration directory located, there are two major configurations that needs to done -

  1. Create a new SIP Profile
  2. Create a Dial Plan.

Step1: Sip Profile

Create a new file named “zentrunk.xml” at /etc/freeswitch/sip_profiles/external/. In zentrunk.xml, create a new gateway with your Plivo Zentrunk details (refer the below given images to get your Plivo Trunk details).

<include>
  <gateway name="Plivo-outbound">
    <param name="username" value="Username for TestAuthGroup"/>
    <param name="password" value="Password for TestAuthGroup" />
    <param name="proxy" value="Termination SIP Domain of your Plivo Trunk"/>
    <param name="register" value="false"/>
  </gateway>
</include>

 

Termination SIP Domain of your Plivo Trunk :

Trunk4  

TestAuthGroup Credentials :

AuthGroup3

Step2: Dialplan

Next, you should setup a Dial Plan to use the Plivo SIP Profile created in Step1.
Create a new file named “02_zentrunk.xml” at /etc/freeswitch/dialplan/default/. If you already have a dialplan prefixed by 02, you can choose the another number.

<extension name="plivo">
  <condition field="destination_number" expression="^(\d{11})$">
	<action application="set" data="effective_caller_id_number=${outbound_caller_id_number}"/>
	<action application="bridge" data="sofia/gateway/Plivo-outbound/$1"/>
  </condition>
</extension>

The above dial plan has defined an extension for 11 digit US numbers like +1-(222)-(222)-2222. The outbound_caller_id_number field is inherited from vars.xml which would be set as the caller ID while making outbound calls. This extension is set to bridge to your SIP Profile “Plivo-outbound”.

Step3: Reload Configurtions

  1. Load the fs_cli utility. Execute fs_cli in your terminal.
  2. Reload the dialplan. Execute reloadxml.
  3. Add the new SIP Profile, Execute sofia profile external rescan

Test your setup

FreeSwitch instances have default users and SIP passwords preconfigured. To prevent being hacked, it is advised to change this default password.
Open vars.xml located at /etc/freeswitch/ and edit the following line

<X-PRE-PROCESS cmd="set" data="default_password=set your password here"/>

This change is applicable to all users under /etc/freeswitch/directory/default/. If you wish to change the password per user, then navigate to /etc/freeswitch/directory/default/ and edit 1000.xml (or any user of your choice)

<param name="password" value="set your password here"/>

Execute reloadxml in fs_cli utility after making changes to users xml.

Note: Freeswitch has to be restarted if any changes were made to vars.xml.

Setting up your X-Lite

Download and install a softphone. If you are on Mac or Windows, download X-lite. For Linux users, you can download Blink. For this tutorial we will use the X-Lite Softphone.

  • Launch X-Lite and navigate to preferences. Click on the Accounts tab and hit the ‘+’ icon to add an account.

XLite1

  • Add the User ID (1000,1001 etc), Domain (IP address of your FreeSwitch machine), Password (password set in vars.xml), Display name (Any name) and Authorization name (same as your User ID).

Note: Field names may vary based on make and model of the SIP phone. All the configuration will remain in each case.

XLite2

Click on OK when you’re done. Your endpoint entry in the list would be shown as Enabled. This indicates that your SIP phone has successfully registered with FreeSwitch.

Make an outbound call

When the account is successfully enabled on X-Lite, it is ready to make calls. Enter any valid 11 digit US number in your X-Lite and hit on the call button. This call would hit your freeswitch server first, then go through Plivo Zentrunk and finally reach the destination number.