售前電話
135-3656-7657
售前電話 : 135-3656-7657
1.1. 概述
本文介紹如何通過 HTTP API 接口設(shè)置設(shè)備的參數(shù), 如設(shè)置設(shè)備的 SIP 服務(wù)器,SIP 賬號,快捷鍵配置參數(shù)等。
設(shè)備作為 HTTP 服務(wù)端,客戶端發(fā)送特定的 HTTP 請求給設(shè)備,以進(jìn)行相應(yīng)的配置,如下圖所示原理框圖:
本文將使用 postman 工具模擬發(fā)送 HTTP 請求給設(shè)備,以完成我們的模擬演示。
1.2. 適用型號網(wǎng)絡(luò)電話機(jī)所有在售型號
1.3. 前提準(zhǔn)備工具① 準(zhǔn)備對講 i11S 一臺,將版本升級到最新的發(fā)布版本,連接到 PoE 交換機(jī)下
② 調(diào)試電腦一臺,并安裝 postman 軟件,用于模擬發(fā)送 HTTP 請求,電腦連接到交換機(jī)下,保證網(wǎng)絡(luò)聯(lián)通正常
1.4. 網(wǎng)絡(luò)電話機(jī)、電腦連接示意圖下載連接地址:
根據(jù)提示完成安裝
2.2. 配置 postman
點(diǎn)擊 File – New…, 選擇”HTTP request”:
在新窗口中,選擇方法:POST, 輸入設(shè)備的 HTTP URL, 格式如下:, 其中,IP 地址為設(shè)備的 IP 地址,舉例如下:
配置 HTTP 請求所需參數(shù):認(rèn)證方式選擇為 Basic Auth; 增加 Content-type:xml/text,如下圖所示:
點(diǎn)擊請求的 Body,選擇 raw,在消息體中,輸入 body 內(nèi)容格式,格式舉例如下:
其中:
<?xml version="1.0" encoding="UTF-8"?> 為消息的頭,必不可少,格式統(tǒng)一。
<FanvilConfiguration Beep="no" cmd="get">
</FanvilConfiguration>
為 xml 內(nèi)容格式,cmd 可以為 get 獲取當(dāng)前參數(shù), set 設(shè)置參數(shù)
<Item>sip.</Item> 對應(yīng)具體的設(shè)備的配置項(xiàng)內(nèi)容,此例子中的請求,獲取設(shè)備的 SIP線路相關(guān)參數(shù)。
在實(shí)際使用中,
<FanvilConfiguration Beep=”no” cmd=”get”>
<Item>sip.</Item>
</FanvilConfiguration>
部分是需要客戶根據(jù)實(shí)際需要進(jìn)行對應(yīng)的修改。
2.4. 如何獲取設(shè)備支持的參數(shù)列表
針對不同的型號,用戶可使用以下方法獲取設(shè)備所支持的 HTTP API 參數(shù)列表。
方法 1,在設(shè)備的 WEB 頁面 – 系統(tǒng) – 系統(tǒng)配置頁面,獲取 nc 類型的配置文件:
可右鍵保存,或者左鍵查看配置。 常用的參數(shù),請查看下一節(jié)。
方法 2,有些型號沒有在 WEB 頁面體現(xiàn) nc 配置文件,可通過在瀏覽器地址欄中輸入對應(yīng)的 URL,獲取 nc 配置文件:
本節(jié)列舉一些常用的參數(shù),供用戶查詢。 后續(xù)將根據(jù)實(shí)際情況更新。
3.1. SIP 線路參數(shù)SIP 線路參數(shù)舉例如下:(來自門禁 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.表示對應(yīng)線路 1 的參數(shù);
PhoneNumber 對應(yīng) web 中的電話號碼
DisplayName 對應(yīng) web 中的顯示名
RegAddr 對應(yīng) SIP 代理服務(wù)器地址,即服務(wù)器地址
RegPort 對應(yīng) SIP 代理服務(wù)器端口,即服務(wù)器端口
RegUser 對應(yīng)驗(yàn)證用戶名,一般與電話號碼一致
RegPswd 對應(yīng)密碼
RegTTL 對應(yīng)注冊有效期時間,默認(rèn)為 3600 秒
RegEnabled 表示是否啟用線路, 0 不啟用,1 啟用
3.2. 快捷鍵參數(shù)快捷鍵參數(shù)如下, 以 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 設(shè)置了快捷鍵,然后在 HTTP API 中,使用 get 指令查看對應(yīng)的參數(shù)配置,進(jìn)行一一對應(yīng)。
Type=1 表示快捷鍵類型為熱點(diǎn)(針對 i30,i12 等,其他型號,可根據(jù)建議進(jìn)行確認(rèn))
Value=125@1/f, 其中 125 為被叫號碼,@1 表示線路 1,/f 表示子類型快速撥號
3.3. 網(wǎng)絡(luò)參數(shù)網(wǎng)絡(luò)參數(shù)舉例如下,以 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 為網(wǎng)絡(luò)類型,可以是 DHCP 或者 static,此參數(shù)不可以使用 set 指令,會根據(jù) dhcp.Enabled 參數(shù)改變。
static.IP 靜態(tài) IP 地址,當(dāng)網(wǎng)絡(luò)模式為靜態(tài)時有效,動態(tài)時,可以 get 獲取當(dāng)前的 IP 地址。
static.SubnetMask 為子網(wǎng)掩碼,其他同上
static.Gateway 為默認(rèn)網(wǎng)關(guān),其他同上
static.PrimaryDNS 為主 DNS 服務(wù)器
static.SecondaryDNS 為副 DNS 服務(wù)器
dhcp.Enabled,是否啟用(1)DHCP 模式,其中則網(wǎng)絡(luò)模式為動態(tài);不啟用(0)則使用靜態(tài)地址模式
3.4. 音量參數(shù)音量參數(shù)舉例如下, 以 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. 系統(tǒng)信息參數(shù)系統(tǒng)信息參數(shù)只能獲取,即只能使用 get 指令。 參數(shù)如下:
<item>info.</item>
此參數(shù)會獲取到所有系統(tǒng)參數(shù),若為了獲取某一個特定參數(shù),需增加到下一個節(jié)點(diǎn), 舉例,獲取設(shè)備 MAC 地址:
<item>info.dev.mac</item