local config = {}
config = {
-- Set to NAME or ID depending on whether queue field contains name or ID of queue
queueType = 'NAME',
-- Name or ID of queue to reserve agents from
queue = 'Voice Queue',
-- NOTE: Keeping queue and queueType as '' will cause CX to use the default queue set in the CX Voice channel
-- queue = '',
-- queueType = '',
-- CxFQDN
cxFqdn = "https://devops.com",
-- API of voice connector for reserving an agent
voiceConnectorApi = "http://VC-IP:VC-PORT/request-agent",
-- Path of folder containing sound files that play during the IVR menu, DO NOT CHANGE
ivr_prompts_folder = "/usr/share/freeswitch/sounds/ivr_prompts/",
}
return config
Press the "I" key to enter editing mode.
The queueType field can contain one of two values:
'NAME'
''
The queue field can contain one of two types of values, based on what the queueType field above contains:
Name of the Agent Queue e.g. Support Queue (If queueType contains 'NAME') This name can be obtained from Unified Admin from the Queues section.
Empty string i.e. '' (If queueType contains '')
If queue and queueType are set to '' , then the call will be routed to the default queue set for the CX Voice channel in Unified Admin.
The voiceConnectorApi field will contain a URL in the following format:
http://VC-IP:VC-PORT/request-agent
Replace VC-IP and VC-PORT with IP address and port of the voice connector.
The cxFqdn field contains the fully qualified domain name of the EFCX:
https://devops.com
Replace https://devops.com with the EFCX domain name.
The ivr_prompts_folder field contains path to the ivr_prompts folder. Leave it at the default value.
Save and exit the file by pressing the Esckey, entering :wq and pressing ENTER.
Configure Dialplans
Domain Creation
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.
CxIVR Dialplan
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, matching the {DN} value in the cx_env{DN}lua script filename set in the IVR scripts section above.
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.
Direct-Transfer Dialplan
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.
WebRTC Dialplan
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
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.
Progressive Outbound Dialplan
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.
Silent Monitoring Dialplan
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(\d{2,15})$
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:
Tag
Type
Data
Group
Order
Enabled
action
set
sip_h_X-CallType=MONITOR
0
10
true
action
export
sip_h_X-CallType=MONITOR
0
15
true
action
lua
eavesdrop_custom.lua $1
0
20
true
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.
Conference Dialplan
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:
Tag
Type
Data
Group
Order
Enabled
action
answer
0
10
true
action
set
session_in_hangup_hook=true
0
15
true
action
export
session_in_hangup_hook=true
0
20
true
action
set
api_hangup_hook=lua cx_hangup.lua $1
0
25
true
action
export
api_hangup_hook=lua cx_hangup.lua $1
0
30
true
action
conference
$1
0
35
true
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.
Changes in User Exists Dialplan
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):
Tag
Type
Data
Group
Order
Enabled
condition
${sip_h_X-CallType}
^CONSULT$
3
5
true
action
bind_meta_app
A a s1 lua::consult_conf.lua CONSULT_TRANSFER
3
10
true
action
bind_meta_app
C a s1 lua::consult_conf.lua CONSULT_CONFERENCE
3
15
true
The result will look like this:
Save the changes by pressing SAVE button in top right corner.
Changes in Local extension Dialplan
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:
action
lua
vcApi.lua 'rona'
1
76
true
The result will look like this:
Note that the new line must be AFTER the bridge user/${destination_number}@${domain_name} line so if the Order of that line is 75 then the new line must have order 76 (as shown in the image above)
Save the changes by pressing SAVE button in top right corner.
Changes in Global Variables dialplan
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):
Tag
Type
Data
Group
Order
Enabled
condition
${sip_h_X-CALL-ID}
^$
2
5
true
action
set
sip_h_X-CALL-ID=${sip_call_id}
2
10
true
action
set
sip_rh_X-CALL-ID=${sip_call_id}
2
15
true
Tag
Type
Data
Group
Order
Enabled
condition
${sip_h_X-CALL-VARIABLE0}
^$
3
5
true
action
set
sip_h_X-CALL-VARIABLE0=${uuid}
3
10
true
action
set
sip_rh_X-CALL-VARIABLE0=${uuid}
3
15
true
Tag
Type
Data
Group
Order
Enabled
action
export
sip_h_X-CALL-ID=${sip_h_X-CALL-ID}
4
5
true
action
export
sip_rh_X-CALL-ID=${sip_h_X-CALL-ID}
4
10
true
action
export
sip_h_X-CALL-VARIABLE0=${sip_h_X-CALL-VARIABLE0}
4
15
true
action
export
sip_rh_X-CALL-VARIABLE0=${sip_h_X-CALL-VARIABLE0}
4
20
true
The result will look like:
Save the changes by pressing SAVE button in top right corner.
Changes in Call Recording Dialplan
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.
Set the Enabled column of the following lines to False:
Save the changes by pressing SAVE button in top right corner.
Changes in conference profile
Changes in conference profile
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.
Configure SIP Trunk and routes
Configure SIP Trunk(Gateway) for outbound calls
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:
Gateway: A name of your choice e.g. MySipTrunk
Username: The username of the SIP Trunk. Not needed for IP-based SIP trunks.
Password: The password of the SIP Trunk. Not needed for IP-based SIP trunks.
Proxy: The IP address and port of the SIP trunk e.g. 192.168.25.35:5060.
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.
Configuring route For Outbound calls
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.
Configuring route For Inbound calls
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.
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.
Changes in SIP Profile
Changes in SIP Profile
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:
Name
Value
Enabled
apply-candidate-acl
0.0.0.0/0
True
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.
Configure Access Control List (ACL)
Configure Access Control List (ACL)
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.
Configure Event Socket Library (ESL)
Configure Event Socket Library (ESL)
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 Settings from the Advanced tab. (If the option is unavailable, skip to step 6)
Change the Event Socket IP Address to 0.0.0.0, and the Event Socket ACL to esl.
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.
SSH into the Media Server.
CODE
ssh username@server-ip
Enter user password and press ENTER.
Use command
CODE
su
Enter root password and press ENTER.
If the Settings option in Step 4 was unavailable, then run the following command