{"id":561,"date":"2011-03-10T13:19:29","date_gmt":"2011-03-10T20:19:29","guid":{"rendered":"http:\/\/www.michel2010.name\/blog\/?p=561"},"modified":"2011-03-10T13:19:29","modified_gmt":"2011-03-10T20:19:29","slug":"freeswitch-howto-configuration","status":"publish","type":"post","link":"https:\/\/blog.michel2010.name\/eric\/2011\/03\/10\/freeswitch-howto-configuration\/","title":{"rendered":"Freeswitch Howto: Configuration"},"content":{"rendered":"

In this section I’m going to focus\u00a0exclusively\u00a0on calling in and out over the POTS lines. \u00a0I’m doing this for two reasons. \u00a0One, this was the part I had the most trouble with, and two, the other dialplan options are (or seem to me to be) better documented. \u00a0I would suggest buying the Freeswitch book<\/a>. \u00a0It’s been very helpful to me, though some if the information is outdated.<\/p>\n

When setting up in-bound and out-bound analog calling (using the freetdm mod which was enabled on install) we deal with these files(these are all in the default install locations, if you installed some where else you’ll have to adjust accordingly):<\/p>\n

\/usr\/local\/freeswitch\/conf\/freetdm.conf
\n\/usr\/local\/freeswitch\/conf\/autoload_configs\/freetdm.conf.xml
\n\/usr\/local\/freeswitch\/conf\/dialplan\/default.xml
\n\/usr\/local\/freeswitch\/conf\/dialplan\/public\/00_inbound_did.xml<\/p>\n

I’ll post these, and go through the ones I know.<\/p>\n

\/usr\/local\/freeswitch\/conf\/freetdm.conf<\/h3>\n
[span wanpipe FXS]\nname => freetdm\ntrunk_type => fxs\ngroup => grp1\nfxs-channel => 1:7\n\ntrunk_type => fxs\ngroup => grp1\nfxs-channel => 1:8\n\n[span wanpipe FXO]\n\nname => freetdm\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:1\n\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:2\n\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:3\n\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:4\n\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:5\n\ntrunk_type => fxo\ngroup => grp2\nfxo-channel => 1:6<\/pre>\n
Now to be honest I didn’t actually configure this file, or\u00a0freetdm.conf.xml. \u00a0When \/usr\/sbin\/wancfg_fs was run it automatically set both of these files up. \u00a0I didn’t have to change either of them.<\/p>\n
\/usr\/local\/freeswitch\/conf\/autoload_configs\/freetdm.conf.xml<\/h3>\n
<analog_spans>
\n<span name=”FXO”>
\n<!–<param name=”hold-music” value=”$${moh_uri}”\/>–>
\n<param name=”dialplan” value=”XML”\/>
\n<param name=”context” value=”public”\/>
\n<!– regex to stop dialing when it matches –>
\n<!–<param name=”dial-regex” value=”5555″\/>–>
\n<!– regex to stop dialing when it does not match –>
\n<!–<param name=”fail-dial-regex” value=”^5″\/>–>
\n<\/span><\/p>\n
<span name=”FXS”>
\n<!–<param name=”hold-music” value=”$${moh_uri}”\/>–>
\n<param name=”dialplan” value=”XML”\/>
\n<param name=”context” value=”default”\/>
\n<!– regex to stop dialing when it matches –>
\n<!–<param name=”dial-regex” value=”5555″\/>–>
\n<!– regex to stop dialing when it does not match –>
\n<!–<param name=”fail-dial-regex” value=”^5″\/>–>
\n<\/span>
\n<\/analog_spans><\/p>\n
 <\/p>\n
Now we get to the good stuff. \u00a0I took this from my default dial plan. \u00a0It only shows one of our five lines, but it should be enough to get you headed in the right direction.<\/p>\n
\/usr\/local\/freeswitch\/conf\/dialplan\/default.xml<\/h3>\n
<extension name=”Call out business hours(Staff)” continue=”true”>
\n<condition field=”ani” expression=”^(1014|1015)” break=”on-true”\/>
\n<condition wday=”2-6″ hour=”9-18″\/>
\n<!– The call out prefix is 7 –>
\n<condition field=”destination_number” expression=”^7(.+)$”>
\n<action application=”set” data=”hangup_after_bridge=true”\/>
\n<action application=”set” data=”continue_on_fail=true”\/>
\n<action application=”bridge” data=”freetdm\/FXO\/2\/$1″\/>
\n<action application=”bridge” data=”freetdm\/FXO\/3\/$1″\/>
\n<action application=”bridge” data=”freetdm\/FXO\/4\/$1″\/>
\n<action application=”bridge” data=”freetdm\/FXO\/5\/$1″\/>
\n<action application=”bridge” data=”freetdm\/FXO\/1\/$1″\/>
\n<action application=”playback” data=”phrase:oh_gee”\/>
\n<\/condition>
\n<\/extension><\/p>\n
The break down:<\/p>\n
<extension name=”Call out business hours(Staff)” continue=”true”><\/p>\n
This is simply the extension name. I have continue set to true. I didn’t think I needed it but it wouldn’t work without it.<\/p>\n
 <\/p>\n
<condition field=”ani” expression=”^(1014|1015)” break=”on-true”\/><\/p>\n
I have two phones that I don’t want dialing out on this extension. If phones 1014 or 1015 are dialing the number they won’t go out through this extension.<\/p>\n
 <\/p>\n
<condition wday=”2-6″ hour=”9-18″\/><\/p>\n
This extension only works Monday through Friday between nine in the morning and six at night.<\/span><\/span><\/span><\/p>\n
 <\/p>\n
<condition field=”destination_number” expression=”^7(.+)$”><\/span><\/span><\/span><\/p>\n
Our \u201ccall out\u201d number is seven. If seven is dialed before the number it is an external call and will be run through this extension.<\/span><\/span><\/span><\/p>\n
 <\/p>\n
<action application=”set” data=”hangup_after_bridge=true”\/><\/span><\/span><\/span><\/p>\n
I’m not sure why this is important but I needed it.<\/span><\/span><\/span><\/p>\n
 <\/p>\n
<action application=”set” data=”continue_on_fail=true”\/><\/span><\/span><\/span><\/p>\n
If you remember we have five outgoing phone lines (POTS). If one of them is busy (it fails to connect) I want to try the next phone line.<\/p>\n
 <\/p>\n
<action application=”bridge” data=”freetdm\/FXO\/2\/$1″\/><\/p>\n
This is the good part. This actually does the calling. The \u201cfreetdm\/FXO\/2\u201d references freetdm.conf.xml. Span FXO, line 2. The \u201c$1\u201d is the number the person is calling. If line 2 is busy it \u201ccontinue_on_fail=true\u201d so it tries the next one (and so on and so forth).<\/p>\n
 <\/p>\n
<action application=”playback” data=”phrase:oh_gee”\/><\/p>\n
This last line is simply a message, I recorded. If all the phone lines are in use this message gets played and the call ends.<\/p>\n
 <\/p>\n
Incoming Calls<\/h3>\n
This was by far the hardest part for me. Thanks to Steve on the Freeswitch mailing list for explaining it to me.<\/p>\n
First let me explain what I was trying to do. Like I said earlier, we have five POTS lines. I needed to direct incoming calls from each line individually to different phones (and or groups) on campus. Where the calls get directed depends on the time of day and the particular phone line in question (I hope that isn’t to confusing).<\/p>\n
\/usr\/local\/freeswitch\/conf\/dialplan\/public\/00_inbound_did.xml<\/h3>\n
<!– LINE1 328-6825–>
\n<!– during work hours will ring the “Administration” phones –>
\n<extension name=”Line 1(6825) work” continue=”true”>
\n<condition field=”source” expression=”mod_freetdm”\/>
\n<condition wday=”2-6″ hour=”9-18″\/>
\n<condition field=”${channel_name}” expression=”^(FreeTDM\/2:1\/)$”>
\n<action application=”set” data=”domain_name=$${domain}”\/>
\n<action application=”set” data=”transfer_ringback=$${us-ring}”\/>
\n<action application=”transfer” data=”2020 XML default”\/>
\n<\/condition>
\n<\/extension><\/span><\/p>\n
 <!– During off hours goes to everyone except Kitchen and Guests –>
\n<extension name=”Line 1(6825) not work” continue=”true”>
\n<condition field=”source” expression=”mod_freetdm”\/>
\n<condition field=”${channel_name}” expression=”^(FreeTDM\/2:1\/)$”>
\n<action application=”set” data=”domain_name=$${domain}”\/>
\n<action application=”set” data=”transfer_ringback=$${us-ring}”\/>
\n<action application=”transfer” data=”2035 XML default”\/>
\n<\/condition> <\/extension>
\n<!– LINE1 DONE–><\/span><\/p>\n
Again, line by line:<\/p>\n
<extension name=”Line 1(6825) work” continue=”true”><\/p>\n
This is simply the extension name. I have continue set to true. I’m pretty sure I need it, and it works with it enabled.<\/p>\n
 <\/p>\n
<condition field=”source” expression=”mod_freetdm”\/><\/p>\n
This tells Freeswitch the source of the inbound call (pretty self explanatory).<\/p>\n
 <\/p>\n
<condition wday=”2-6″ hour=”9-18″\/><\/p>\n
This extension only works Monday through Friday between nine in the morning and six at night.<\/p>\n
 <\/p>\n
<condition field=”${channel_name}” expression=”^(FreeTDM\/2:1\/)$”><\/p>\n
This tests to see what line is calling from the \u201cmod_freetdm\u201d source. My FXO ports are in the second span of my freetdm.conf, \u00a0so \u201cFreeTDM\/2:1\/\u201d is span two line 1. This is the part I got from Steve, and I couldn’t find this information any where.<\/p>\n
 <\/p>\n
<action application=”set” data=”domain_name=$${domain}”\/><\/p>\n
I have no idea what this does but I know I need it.<\/p>\n
 <\/p>\n
<action application=”set” data=”transfer_ringback=$${us-ring}”\/><\/p>\n
I’m assuming this changes depending on the country you live in.<\/p>\n
 <\/p>\n
<action application=”transfer” data=”2020 XML default”\/><\/p>\n
This transfers the incoming call to (in my case) group 2020 in the default dial plan. It can be replaced with any valid extension number.<\/p>\n
The second extension (again this is just for one of our phone lines. \u00a0Each line will need an extension) is for off hours and weekends.<\/p>\n
 <\/p>\n
Faxing<\/h2>\n
We have an analog fax machine, which is why I needed the FXS modules on my Sagnoma card. \u00a0Here are the relevant dialplan parts I used to send and receive faxes.<\/p>\n
 <\/p>\n
Receiving a Fax<\/h3>\n
This gets set up in the public dialplan. \u00a0On our install \/usr\/local\/freeswitch\/dialplan\/public\/00_inbound_did.xml.<\/p>\n
<!– LINE3 328-6982–>
\n<!– Always directed to the fax machine –>
\n<extension name=”Line 3(6982)” continue=”true”>
\n<condition field=”source” expression=”mod_freetdm”\/>
\n<condition field=”${channel_name}” expression=”^(FreeTDM\/2:3\/)$”>
\n<action application=”set” data=”domain_name=$${domain}”\/>
\n<action application=”set” data=”transfer_ringback=$${us-ring}”\/>
\n<action application=”bridge” data=”freetdm\/2\/3|freetdm\/1\/1″\/>
\n<\/condition>
\n<\/extension>
\n<!– LINE3 DONE–><\/p>\n
<action application=”bridge” data=”freetdm\/2\/3|freetdm\/1\/1″\/><\/p>\n
This is the important one. \u00a0It takes the incoming call from span 2 line 3 and transfers it to span 1 line 1.<\/p>\n
 <\/p>\n
Sending a Fax<\/h3>\n
This gets set up in the default dialplan. \u00a0On our install \/usr\/local\/freeswitch\/conf\/dialplan\/default.xml.<\/p>\n
<extension name=”bridge-FXS-to-FXO” continue=”true”>
\n<condition field=”destination_number” expression=”^7(.+)$”\/>
\n<condition field=”channel_name” expression=”FreeTDM\/1:1\/”>
\n<action application=”bridge” data=”freetdm\/1\/1\/${destination_number}|freetdm\/2\/3\/${destination_number}”\/>\u00a0\u00a0 <\/condition>
\n<\/extension><\/p>\n
<condition field=”channel_name” expression=”FreeTDM\/1:1\/”>
\n<action application=”bridge” data=”freetdm\/1\/1\/${destination_number}|freetdm\/2\/3\/${destination_number}”\/>\u00a0\u00a0 <\/condition><\/p>\n
These are the two lines that work the magic. \u00a0I got this off the Freeswitch wiki. \u00a0Direct span 1 line 1 to span 2 line 3 and dial the number. \u00a0Presto the fax goes out.<\/p>\n","protected":false},"excerpt":{"rendered":"
In this section I’m going to focus\u00a0exclusively\u00a0on calling in and out over the POTS lines. \u00a0I’m doing this for two reasons. \u00a0One, this was the part I had the most trouble with, and two, the other dialplan options are (or seem to me to be) better documented. \u00a0I would suggest buying the Freeswitch book. \u00a0It’s … Continue reading “Freeswitch Howto: Configuration”<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,3],"tags":[],"class_list":["post-561","post","type-post","status-publish","format-standard","hentry","category-freeswitch","category-tech"],"_links":{"self":[{"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/posts\/561","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/comments?post=561"}],"version-history":[{"count":0,"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/posts\/561\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/media?parent=561"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/categories?post=561"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.michel2010.name\/eric\/wp-json\/wp\/v2\/tags?post=561"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}