Media Server Configurations for CX Voice

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Select the Domains option from the Advanced tab.

• Select the ADD button on the top right.

• Add the Fully Qualified Domain Name(FQDN) that was provided with the Media Server, as shown in the image below:

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Add a new Dialplan by pressing the Add Button on the top.

• Fill the form with following details :

  • Name = <Name of your choice>

  • Condition 1 =  Select destination_number from list and add a dialing number in the format ^dialing_number$, matching the {DN} value in the cx_env{DN}lua script filename set in the IVR scripts section above.

    • e.g. for a dialing number of 1218, the field must have the value ^1218$.

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open CxIvr dialplan.

• Change action from transfer to lua and add the name of the custom IVR script into data column. it looks like this.

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

•  Add a new Dialplan by pressing the Add Button on the top.

•  Fill the form with following details :

  • Name = CxQueue

  • Condition 1 =  Select destination_number from list and add a random number

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open CxQueue dialplan.

• Change the value of the Data column in the destination_number row to ^99887766[-0-9a-zA-Z]*$

• Change the value of the Type column in the Action row to lua and the Data field to vcApi.lua 'directTransfer'

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Add a new Dialplan by pressing the Add Button on the top.

• Fill the form with following details:

  • Name = webrtc

  • Condition 1 =  Select destination_number from list and add the webRTC dialing number in the format ^dialing_number$.

    • e.g. for a dialing number of 123456, the field must have the value ^123456$.

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open webRTC dialplan.

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Add a new Dialplan by pressing the Add Button on the top.

• Fill the form with following details :

  • Name = Progressive Outbound Agent Transfer

  • Condition 1 =  Select destination_number from list and set the value to ^agent$

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open the Progressive Outbound Agent Transfer dialplan.

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Change the value of the Type column in the Action row to bridge and the Data field to user/${sip_h_X-agentExtension}@<DOMAIN>

  • Where DOMAIN is the value of the Domain set in the Domain creation section.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

•  Add a new Dialplan by pressing the Add Button on the top.

•  Fill the form with following details :

  • Name = Manual_Outbound

  • Condition 1 = Click the black arrow to the right of the first field. In the first field enter ${sip_h_X-CallType} and in the second field enter ^OUT$.

  • Condition 2 = Click the black arrow to the right of the first field. In the first field enter ${customer_leg_uuid} and in the second field enter ^$.

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open Manual_Outbound dialplan.

• Delete the line with the Action tag (Click the checkbox in the right and press SAVE in the top right)

• Add the following information to this dialplan:

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Set the Order field to 49.

• Set the Continue field to True.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

•  Add a new Dialplan by pressing the Add Button on the top.

•  Fill the form with following details :

  • Name = Custom_Hangup

  • Condition 1 = Click the black arrow to the right of the first field. In the first field enter ${user_exists} and in the second field enter ${user_exists}.

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open Custom_Hangup dialplan.

• Delete the line with the Action tag (Click the checkbox in the right and press SAVE in the top right)

• Add the following information to this dialplan:

• Set the Context field to global.

• Set the Domain field to Global.

• Set the Order field to 999.

• Set the Continue field to False.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

•  Add a new Dialplan by pressing the Add Button on the top.

•  Fill the form with following details :

  • Name = Silent Monitoring

  • Condition 1 =  Select destination_number from list and add ^\*44(.+)$

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open Silent Monitoring dialplan.

• Delete the line with the Action tag (Click the checkbox in the right and press SAVE in the top right)

• Add the following information to this dialplan:

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

•  Add a new Dialplan by pressing the Add Button on the top.

•  Fill the form with following details :

  • Name = CustomConf

  • Condition 1 =  Select destination_number from list and add ^custom_conf_(.*)$

  • Action 1  =  Select first item from the list  

• Save the form by pressing save button on top right Corner.

• Re-open CustomConf dialplan.

• Delete the line with the Action tag (Click the checkbox in the right and press SAVE in the top right)

• Add the following information to this dialplan:

• Set the Context field to the value of the Domain set in the Domain creation section.

• Set the Domain field to the value of the Domain set in the Domain creation section.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Find and open the user_exists dialplan.

• Add the following information(to add custom values in the Type column, select a random value then click on it to edit):

• The result will look like this:

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Find and open the local_extension dialplan.

• Add the following information to the last group:

• Secondly, replace the Data field in the line with Order 75 with: {origination_uuid=${custom_origination_uuid}}user/${destination_number}@${domain_name}

• The result will look like this:

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Find and open the global-variables dialplan.

• Add the following information to this dialplan (to add custom values in the Type column, select a random value then click on it to edit):

• The result will look like:

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Dialplan Manager section under the Dialplan tab.

• Find and open the user_record dialplan.

• Add the following data to the table, such that the final version looks like the image below:

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Conference Profiles section under the Applications tab:

• Open the profile named default:

• Under the Profile Parameters, find the following keywords under the Name column and click the checkbox:

• Press TOGGLE in the top right and choose CONTINUE in the prompt shown.

• Save the changes by pressing SAVE button in top right corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Gateways section under the Accounts tab.

• Press the ADD button in the top right.

• Set the following fields:

  1. Gateway: A name of your choice e.g. MySipTrunk

  2. Username: The username of the SIP Trunk. Not needed for IP-based SIP trunks.

  3. Password: The password of the SIP Trunk. Not needed for IP-based SIP trunks.

  4. Proxy: The IP address and port of the SIP trunk e.g. 192.168.25.35:5060.

  5. Register: Set to True. Set to False for IP-based SIP trunks.

• Press the SAVE button on the top right.

• Open this newly created gateway and note the URL opened in the browser.

• Add the IP address of the SIP trunk to the Media Server ACL:

  • Open SIP Profiles under the Advanced tab.

• Open the external profile and note the value of the apply-register-acl field.

• Open Access controls under the Advanced tab.

• Open the entry that matches the aforementioned apply-register-acl field.

• At the bottom add an entry where the the Type is set to ‘allow’ and the CIDR field contains the address of the SIP Trunk.

• Press the SAVE button on the top right.

• Open SIP Status under the Status tab.

• Press the Reload ACL button at the top right.

• Open SIP Profiles under the Advanced tab.

• Open the external profile and note the value of the sip-port field.

• Back out via the BACK button on the top right.

• Open the internal profile and note the value of the sip-port field.

• Open a terminal and SSH into the Media Server machine via the command

  • CODE

    ssh Media-Server-Username@Media-Server-IP-Address

• Enter the Media Server SSH password when prompted.

• Enter and run the command

  • CODE

    su

• And enter the Media Server root password.

• Run the command

  • CODE

    sudo iptables -A INPUT -p tcp -m tcp --dport PORT -j ACCEPT

  • Where PORT is the port noted down in the previous steps. Run the command once for each port.

• Run the command

  • CODE

    sudo iptables-save

• Contact the SIP Trunk provider and have all traffic from the Media Server machine public IP address allowed.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Outbound Routes section under the Dialplans tab.

• Press the ADD button in the top right.

• Set the following fields :

  • Gateway = The name of the gateway configured above.

  • Dialplan Expression =  The format of the number accepted by the SIP trunk e.g. for 11 digits the format is ^(\d{11})$

• Press the SAVE button on top right corner.

• Re-open this newly created Outbound Route.

• Add the following information to the last group:

• To the last row, where the Type field is bridge, append {origination_uuid=${custom_origination_uuid}} to the start of the field in the Data column. The result will look as below:

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Destinations section under the Dialplans tab.

• Press the ADD button in the top right.

• In the Destination field set the inbound dialing number provided by the SIP trunk provider in the format ^dialing_number$.

  • e.g. for a dialing number of 1234, the field must have the value ^1234$.

• Press the SAVE button on top right Corner.

• Open the Inbound Routes section under the Dialplans tab.

• Press the ADD button in the top right.

• Set the following fields :

  • Name = A name of your choice.

  • Destination Number =  The destination created above.

  • Action = From the Extensions list select the number chosen as the destination number in the CxIvr dialplan section above.

• Press the SAVE button on top right Corner.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open SIP Profiles under the Advanced tab.

• Open the internal profile, scroll down to the ws-binding and wss-binding fields, and set their Enabled column values to True.

• Find the disable-transcoding field and its Value and Enabled columns to true.

• Find the nat-options-ping fields and its Value and Enabled columns to true.

• Find the liberal-dtmf fields and its Value and Enabled columns to true.

• At the bottom add the data:

• Press the SAVE button on the top right.

• Open SIP Status under the Status tab.

• Locate the line sofia status profile internal and to its right press the RESCAN button, followed by the RESTART button after the page reloads.

For the Voice Connector and Dialer to be able to access the Freeswitch ESL for communicating with Media Server, their IP address must be added to the ACL.

• Login to Media Server web interface. 

  • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

• Add the username and password that was shown upon installation of Media Server and press LOGIN.

• Press the IP address in the top right and select the Domain created in the Domain creation section above:

• Open the Access Control List from the Advanced tab.

• Create a new ACL with the Add button.

• Set the name to esl,  the Default to allow and add the following IP addresses:

  • 127.0.0.1

  • The IP address of the Media Server e.g. 192.168.1.17.

  • The IP address of the server the Voice connector is running on e.g. 192.168.1.201.

  • The IP address of the server the Dialer is running on e.g. 192.168.1.106.

  • Lastly, add the IP addresses of the docker containers for the Voice connector and Dialer.

    • On the Voice connector and Dialer servers, use the command docker ps to list the containers.

• Run the command:

  • CODE

    docker inspect containerID

  • Scroll down to the Networks object and find the Gateway and IPAddress fields.

• Copy these two addresses to the esl ACL.

  • Make sure to do this process for both the Voice connector and dialer.

• Click the Save button and go to the SIP Status with from the Status tab.

• Click the Reload ACL button on the top right.

1. Login to Media Server web interface. 

   • Open in browser: https://IP-addr, where IP-addr is the IP address of the Media Server.

1. Add the username and password that was shown upon installation of Media Server and press LOGIN.

2. Press the IP address in the top right and select the Domain created in the Domain creation section above:

1. Open Settings from the Advanced tab. (If the option is unavailable, skip to step 6)

1. Change the Event Socket IP Address to 0.0.0.0, and the Event Socket ACL to esl.

1. Optionally, change the Event Socket Password to the a different value, or leave as default ClueCon.

   • If the password is changed, then the same must be set in the environment files for the voice connector and dialer.

   • If the password is changed, update it in the environment variables for the and Dialer docker containers.

2. SSH into the Media Server.

   CODE

   ssh username@server-ip

3. Enter user password and press ENTER.

4. Use command

   CODE

   su

5. Enter root password and press ENTER.

6. If the Settings option in Step 4 was unavailable, then run the following command

   CODE

   echo '<configuration name="event_socket.conf" description="Socket Client">
     <settings>
       <param name="nat-map" value="false"/>
       <param name="listen-ip" value="0.0.0.0"/>
       <param name="listen-port" value="8021"/>
       <param name="password" value="PASSWORD"/>
       <param name="apply-inbound-acl" value="esl"/>
     </settings>
   </configuration>' > /etc/freeswitch/autoload_configs/event_socket.conf.xml

   1. In following command replace customEslPass with your chosen password, then run the command

      CODE

      sed -i 's/PASSWORD/customEslPass/g' /etc/freeswitch/autoload_configs/event_socket.conf.xml

7. Run the command to restart Media Server with the new ESL settings:

   CODE

   systemctl restart freeswitch

8. Run the following command:

   CODE

   echo "switch.event_socket.host = 0.0.0.0
   switch.event_socket.port = 8021
   switch.event_socket.password = EslPass" | sudo tee -a /etc/fusionpbx/config.conf

   1. In following command replace customEslPass with the password chosen in Step 10a, then run the command

      CODE

      sed -i 's/EslPass/customEslPass/g' /etc/fusionpbx/config.conf

9. Log out of the Media Server web interface and log back in.

• SSH into the Media Server.

  • Use command

    CODE

    ssh username@server-ip

  • Enter user password and press ENTER.

  • Use command

    CODE

    su

  • Enter root password and press ENTER.

• Open the Media Server config file

  CODE

  vi /etc/freeswitch/autoload_configs/switch.conf.xml

• Locate the following line and replace 1000 with 100000

  CODE

  <param name="max-sessions" value="1000"/>

• Locate the following line and replace 30 with 100000

  CODE

  <param name="sessions-per-second" value="30"/>

• Run the command to restart Media Server with the new ESL settings:

  CODE

  systemctl restart freeswitch

• SSH into the Media Server.

  • Use command

    CODE

    ssh username@server-ip

  • Enter user password and press ENTER.

  • Use command

    CODE

    su

  • Enter root password and press ENTER.

• Open /etc/freeswitch/autoload_configs/lua.conf.xml

• Find the line near the end containing <!-- Subscribe to events -->  

• Insert the following under it:

  CODE

  <hook event="CHANNEL_HANGUP_COMPLETE" subclass="" script="hangup_event.lua"/>

• Run the command:

systemctl restart freeswitch