蓝牙电话-关联FreeSwitch中继SIP账号通过Rest接口
前言
上一篇章《蓝牙电话-与FreeSwitch服务器和UA坐席的通话.docx》中，我们使用开源的B2B-UA当中经典的FreeSWITCH搭建了一个最简洁的、并且可用的局域网“云平台”，使电脑上的“软电话”能正常使用蓝牙电话的方案呼叫出去。
但是我们实际使用过程中，手机和手机SIM卡常常不是一一对应的使用。这就引出一个问题，我们桥接上B2B-UA的SIP中继账号，到底最终是要跟SIM卡的手机号绑定？还是要跟手机设备绑定？还是要跟手机app里登录的账号进行绑定？
针对这个问题，上一篇章给出了两种方式：SIP账号直接配置，以及自己实现一个http或https的接口，使用GET传入手机号码，返回json格式的对应SIP账号密码。
本篇章中，采用最简单的步骤和方式，在windows中使用python编写脚本，在上一篇章中搭建的FreeSWITCH账号的基础之上，编写和启动一个自己的局域网内的Rest接口，供用户进行访问传入手机号，来获取手机号对应的中继SIP账号。
本文中预设的依赖条件如下：
序号 | 描述 |
01 | 上一版本中已安装和配置的FreeSwitch的安装路径 |
02 | windows或Linux中最新版本的python |
03 | 依赖部分pip install 安装的依赖库 |
由于最新的python随便搜索就能下载和安装，脚本对python版本没有特定要求、一般下载最新版本即可，此处不再赘述，仅贴上最新的windows的python下载地址：
https://www.python.org/downloads/
已安装的FreeSWITCH
已安装的FreeSWITCH的安装路径如下：C:\Program Files\FreeSWITCH
已添加的用户和目录结构如下：
HTTP的Rest接口
本章节根据前面已安装的FreeSWITCH的用户和目录结构，使用Python简单的实现了一个http的GET接口脚本【api_server.py】。使用时，简单将该Python脚本丢到下述目录中
C:\Program Files\FreeSWITCH\conf\directory\default，并执行 python api_server.py，
即可正常使用http来访问接口，并可传入手机号18873216143，获取得到预期的SIP账号密码，如下：
http://172.16.80.141:8032/registersip/18873216143
返回结果：
{"sipRealm":"xxx.com","dateCreated":"2024/01/31 15:23:04","ipPort":"172.16.80.141:5060","sipPhone":"sim18873216143","pwd":"1234","statusCode":"0","notReversal":"0"}
若未在SIP服务器添加sim18873216143这个账号，则GET查询的返回结果为：
{"dateCreated":"2024/01/31 14:13:49","statusCode":"920100","represent":"手机号不合法"}
返回结果的各字段的含义如下：
序号 | 字段名称 | 取值 | 描述 |
01 | dateCreated | yyyy/MM/dd HH:mm:ss | 接口调用时间 |
02 | statusCode | 0-成功 非0-失败 | 状态码 |
03 | represent | 字符串描述 | 失败原因 |
04 | sipPhone | sim+传入的手机号 | 中继SIP账号 |
05 | pwd | 字符串 | 中继SIP密码 |
06 | ipPort | IP:端口 | SIP服务器地址 |
07 | sipRealm | 字符串 | SIP域（未使用） |
08 | notReversal |
| VOS平台需要赋值1 无此字段则默认0 |
api_server.py脚本内容
Python脚本 api_server.py的内容如下：
（放在FreeSWITCH的用户目录：C:\Program Files\FreeSWITCH\conf\directory\default）
（当前使用的python版本为Python 3.12.0 另外，为了提供http服务和json与xml的解析，需要另外pip install sanic、setuptools和lxml）
脚本的文本内容如下：
# !/usr/bin/python
# pip install sanic
# pip install setuptools
# #pip install lxml
from sanic.response import json, text
from sanic import Sanic, request
import datetime
import os
import xml.etree.ElementTree as ET
app = Sanic("registersip")
@app.route("/registersip/<phone>")
async def registersip(request, phone):
#读取传入的手机号 phone
dir_path = os.getcwd()
#扫描本地目录的所有文件
is_match = False
xml_path = ""
for dirpath, dirnames, filenames in os.walk(dir_path):
for filename in filenames:
if filename == 'sim'+phone+'.xml':
is_match = True
xml_path = os.path.join(dirpath, filename)
#print(xml_path)
status_code = 200
if is_match==False:
res_dict = {
"dateCreated": datetime.datetime.now().strftime("%Y/%m/%d %H:%M:%S"),
"statusCode": "920100",
"represent": "手机号不合法"
}
return json(res_dict, status=status_code, ensure_ascii=False)
#如果存在文件 则读取文件内容中的密码
root = ET.parse(xml_path).getroot()
pwd_item = root[0][0] #取include--user--params下的所有节点的内容 并取name=password的value的值
pwd_string = ""
for subchild in pwd_item:
name = subchild.get('name') #子节点下属性name的值
value = subchild.get('value')
if name=='password':
pwd_string = value
break
res_dict = {"sipRealm": "xxx.com",
"dateCreated": datetime.datetime.now().strftime("%Y/%m/%d %H:%M:%S"),
"ipPort": "172.16.80.141:5060",
"sipPhone": "sim"+phone,
"pwd": pwd_string,
"statusCode": "0"
}
return json(res_dict, status=status_code, ensure_ascii=False)
if __name__ == "__main__":
app.run(single_process=True,
access_log=True,
host="0.0.0.0",
port=8032,
workers=1,
)
最终部署的FreeSWITCH的配置文件的账号目录的内容如下：
浏览器访问api接口的结果如下：
至此，即可将部署的http访问路径http://172.16.80.141:8032/registersip/ 按上一篇章的要求，直接粘贴到智能拨号器PC版的【平台地址】，或粘贴到智能拨号器手机app版的管理app中。
经过以上的一顿操作，即可实现将智能拨号器的app，跟开源的FreeSWITCH进行联动，使用蓝牙获取手机SIM号码，并实时获取其关联的中继SIP账号。
总结
本次这两个篇章，均为针对最近的用户反馈的情况，使用最简洁的方式，让蓝牙电话的用户，能第一时间的将所谓的“云平台”给部署出来，并能实现正常的电话呼叫。
对于使用VOS平台及其它平台的用户，本文的python的Rest接口的编写和数据获取方式，也能起到一定的参考作用。
