freeswitch python模組

概述

freeswitch支援多種語言的業務開發,包括C/C++,java,python,js,lua,Golang等等。
freeswitch在使用python做業務開發時,有倆種接入方式,一種是ESL介面,另一種是mod_python模組。
python的ESL介面是通過socket套接字與freeswitch進行命令交互,包括發送命令、命令響應和事件回調等,類似於在外部增加一個第三方模組控制fs行為。
ESL介面部分會在後續的章節中詳細介紹。
今天我們要介紹的是fs內部的mod_python語言支援模組,該模組允許我們使用python腳本開發fs呼叫控制流程。

 

環境

centos:CentOS release 7.0 (Final)或以上版本
freeswitch:v1.8.7
GCC:4.8.5

 

安裝mod_python模組

freeswitch的源碼安裝部署請參照之前的文章。
freeswitch源碼安裝時,默認不安裝mod_python模組,需要我們進入目錄編譯安裝。

cd /root/freeswitch-1.8.7/src/mod/languages/mod_python
make install

cd /usr/local/freeswitch/mod
ll -tr
-rwxr-xr-x. 1 root root 753208 9月 14 10:41 mod_python.so
-rwxr-xr-x. 1 root root 1360 9月 14 10:41 mod_python.la

 

python腳本

增加testapi.py腳本

vi /usr/local/freeswitch/scripts/testapi.py
import freeswitch
def fsapi(session,stream,env,args):
    stream.write("hello")
    freeswitch.consoleLog("info","test")

 

增加testapp.py腳本

vi /usr/local/freeswitch/scripts/testapp.py
import freeswitch
def handler(session, args):
  session.answer()
  freeswitch.console_log("info","testCall\n")
  session.streamFile("local_stream://moh")
  freeswitch.msleep(3000)
  session.hangup()

 

配置啟動

修改freeswitch模組載入配置文件

cd /usr/local/freeswitch/conf/autoload_configs
vi modules.conf.xml
<!-- Languages -->
<load module="mod_python"/>

 

修改dialplan撥號計劃

cd /usr/local/freeswitch/conf/dialplan
vi public.xml
…
<include>
<context name="public">
<extension name="test">
<condition>
<action application="python" data="testapp"/>
</condition>
</extension>

 

啟動freeswitch

cd /usr/local/freeswitch/bin
./freeswitch -nonat
2021-09-14 10:57:06.392800 [NOTICE] mod_python.c:551 Python Framework Loading...
2021-09-14 10:57:06.405965 [CONSOLE] switch_loadable_module.c:1540 Successfully Loaded [mod_python]
2021-09-14 10:57:06.405982 [NOTICE] switch_loadable_module.c:292 Adding Application 'python'
2021-09-14 10:57:06.406012 [NOTICE] switch_loadable_module.c:315 Adding Chat Application 'python'
2021-09-14 10:57:06.406030 [NOTICE] switch_loadable_module.c:338 Adding API Function 'pyrun'
2021-09-14 10:57:06.406046 [NOTICE] switch_loadable_module.c:338 Adding API Function 'python'

 

測試

在freeswitch命令行中輸入命令,使用python調用API介面

[email protected]> python testapi
2021-09-14 11:13:56.068722 [NOTICE] mod_python.c:212 Invoking py module: testapi
2021-09-14 11:13:56.088701 [INFO] switch_cpp.cpp:1443 test
hello

 

在日誌列印中,我們可以看到mod_python模組調用了testapi腳本,並列印了「test「和」hello「。

注意事項,python調用命令中,python腳本的後綴「.py「要去掉。

通過其他sip server發送呼叫請求到本機,查看日誌:

2021-09-14 11:24:40.988720 [NOTICE] switch_channel.c:1114 New Channel sofia/external/10011@192.168.0.110 [73b09c9b-6a62-4372-839b-4c076af7dfc2]
2021-09-14 11:24:40.988720 [INFO] mod_dialplan_xml.c:637 Processing 10011 <10011>->10012 in context public
2021-09-14 11:24:40.988720 [NOTICE] mod_python.c:212 Invoking py module: testapp
2021-09-14 11:24:40.988720 [NOTICE] sofia_media.c:92 Pre-Answer sofia/external/10011@192.168.0.110!
2021-09-14 11:24:40.988720 [NOTICE] switch_cpp.cpp:685 Channel [sofia/external/10011@192.168.0.110] has been answered
2021-09-14 11:24:40.988720 [INFO] switch_cpp.cpp:1443 testCall
2021-09-14 11:24:40.988720 [WARNING] mod_local_stream.c:870 Unknown source moh, trying 'default'
2021-09-14 11:24:40.988720 [ERR] mod_local_stream.c:878 Unknown source default
2021-09-14 11:24:43.988724 [NOTICE] switch_cpp.cpp:733 Hangup sofia/external/10011@192.168.0.110 [CS_EXECUTE] [NORMAL_CLEARING]
2021-09-14 11:24:44.008687 [NOTICE] switch_core_session.c:1744 Session 2 (sofia/external/10011@192.168.0.110) Ended
2021-09-14 11:24:44.008687 [NOTICE] switch_core_session.c:1748 Close Channel sofia/external/10011@192.168.0.110 [CS_DESTROY]

在日誌列印中,我們可以看到在dialplan撥號計劃的執行過程中,通過mod_python調用了「testapp「,testapp.py腳本中應答了這通呼叫,列印日誌」testcall「,並在3秒後掛機。

 

總結

freeswitch做業務開發時,支援多種語言接入,很方便,用戶可以根據自己的技能棧來選擇接入方式和語言。
但是,不同語言在呼叫性能上肯定有差異,這個就需要用戶自己來測試並評估實際使用中的差別了。


 

空空如常

求真得真