1.1. 概述
本文介绍如何通过 HTTP API 接口设置设备的参数, 如设置设备的 SIP 服务器,SIP 账号,快捷键配置参数等。
设备作为 HTTP 服务端,客户端发送特定的 HTTP 请求给设备,以进行相应的配置,如下图所示原理框图:
本文将使用 postman 工具模拟发送 HTTP 请求给设备,以完成我们的模拟演示。
1.2. 适用型号
电话对讲机所有在售型号
1.3. 前提准备工具
① 准备对讲 i11S 一台,将版本升级到最新的发布版本,连接到 PoE 交换机下
② 调试电脑一台,并安装 postman 软件,用于模拟发送 HTTP 请求,电脑连接到交换机下,保证网络联通正常
1.4. 电话对讲机、电脑连接示意图
2. Postman 模拟 HTTP 请求
2.1. 下载安装 postman
下载连接地址:https://www.postman.com/downloads/
根据提示完成安装
2.2. 配置 postman
点击 File – New…, 选择”HTTP request”:
在新窗口中,选择方法:POST, 输入设备的 HTTP URL, 格式如下:http://ip/xmlservice, 其中,IP 地址为设备的 IP 地址,举例如下:
配置 HTTP 请求所需参数:认证方式选择为 Basic Auth; 增加 Content-type:xml/text,如下图所示:
2.3. 配置 HTTP 请求 body 内容
点击请求的 Body,选择 raw,在消息体中,输入 body 内容格式,格式举例如下:
其中:
<?xml version="1.0" encoding="UTF-8"?> 为消息的头,必不可少,格式统一。
<FanvilConfiguration Beep="no" cmd="get">
</FanvilConfiguration>
为 xml 内容格式,cmd 可以为 get 获取当前参数, set 设置参数
<Item>sip.</Item> 对应具体的设备的配置项内容,此例子中的请求,获取设备的 SIP线路相关参数。
在实际使用中,
<FanvilConfiguration Beep=”no” cmd=”get”>
<Item>sip.</Item>
</FanvilConfiguration>
部分是需要客户根据实际需要进行对应的修改。
2.4. 如何获取设备支持的参数列表
针对不同的型号,用户可使用以下方法获取设备所支持的 HTTP API 参数列表。
方法 1,在设备的 WEB 页面 – 系统 – 系统配置页面,获取 nc 类型的配置文件:
方法 1,在设备的 WEB 页面 – 系统 – 系统配置页面,获取 nc 类型的配置文件:
可右键保存,或者左键查看配置。 常用的参数,请查看下一节。
方法 2,有些型号没有在 WEB 页面体现 nc 配置文件,可通过在浏览器地址栏中输入对应的 URL,获取 nc 配置文件:
3. 常用参数
本节列举一些常用的参数,供用户查询。 后续将根据实际情况更新。
3.1. SIP 线路参数
SIP 线路参数举例如下:(来自门禁 i30)
sip.line.1.PhoneNumber = 112
sip.line.1.DisplayName = 112
sip.line.1.SipName =
sip.line.1.RegAddr = 172.18.1.45
sip.line.1.RegPort = 2066
sip.line.1.RegUser = 112
sip.line.1.RegPswd = abc123
sip.line.1.RegTTL = 3600
sip.line.1.RegEnabled = 0
sip.line.1.表示对应线路 1 的参数;
PhoneNumber 对应 web 中的电话号码
DisplayName 对应 web 中的显示名
RegAddr 对应 SIP 代理服务器地址,即服务器地址
RegPort 对应 SIP 代理服务器端口,即服务器端口
RegUser 对应验证用户名,一般与电话号码一致
RegPswd 对应密码
RegTTL 对应注册有效期时间,默认为 3600 秒
RegEnabled 表示是否启用线路, 0 不启用,1 启用
3.2. 快捷键参数
快捷键参数如下, 以 i30 举例:
<item> dss.page.1.key.1.Type=1 </item>
<item> dss.page.1.key.1.Value=125@1/f </item>
<item> dss.page.1.key.1.Title= </item>
建议,先在 WEB 设置了快捷键,然后在 HTTP API 中,使用 get 指令查看对应的参数配置,进行一一对应。
Type=1 表示快捷键类型为热点(针对 i30,i12 等,其他型号,可根据建议进行确认)
Value=125@1/f, 其中 125 为被叫号码,@1 表示线路 1,/f 表示子类型快速拨号
3.3. 网络参数
网络参数举例如下,以 i30,i12 等:
<item> net.WANMode=DHCP </item>
<item> net.static.IP=172.18.8.7 </item>
<item> net.static.SubnetMask=255.255.255.0 </item>
<item> net.static.Gateway=172.18.8.1 </item>
<item> net.static.PrimaryDNS=202.96.134.133 </item>
<item> net.static.SecondaryDNS=202.96.128.86 </item>
<item> net.static.DomainName= </item>
<item> net.dhcp.Enabled=1 </item>
其中,WANMode 为网络类型,可以是 DHCP 或者 static,此参数不可以使用 set 指令,会根据 dhcp.Enabled 参数改变。
static.IP 静态 IP 地址,当网络模式为静态时有效,动态时,可以 get 获取当前的 IP 地址。
static.SubnetMask 为子网掩码,其他同上
static.Gateway 为默认网关,其他同上
static.PrimaryDNS 为主 DNS 服务器
static.SecondaryDNS 为副 DNS 服务器
dhcp.Enabled,是否启用(1)DHCP 模式,其中则网络模式为动态;不启用(0)则使用静态地址模式
3.4. 音量参数
音量参数举例如下, 以 i11SV 为例:
<item> phone.volume.HandFreeVol=9 </item>
<item> phone.volume.HandFreeRingVol=3 </item>
<item> phone.volume.HandFreeToneVol=3 </item>
phone.volume.HandFreeVol 为免提音量,值的范围为 1-9,9 为最大音量
phone.volume.HandFreeRingVol=3 为免提铃声音量,即来电铃声音量,范围为 1-9,9 为最大音量
phone.volume.HandFreeToneVol=3 为免提信号音音量,来电提示音等为信号音,范围为 1-9, 9为最大音量
3.5. 系统信息参数
系统信息参数只能获取,即只能使用 get 指令。 参数如下:
<item>info.</item>
此参数会获取到所有系统参数,若为了获取某一个特定参数,需增加到下一个节点, 举例,获取设备 MAC 地址:
<item>info.dev.mac</item