上海迅時通信設(shè)備有限公司OMAPI技術(shù)開發(fā)文檔

上海迅時通信設(shè)備有限公司

OMAPI技術(shù)開發(fā)文檔（V6.0）

網(wǎng)址：

電話：

傳真：

文檔版本：V6.0

更新時間：20180208

版權(quán)所有?上海迅時通信設(shè)備有限公司2018。保留一切權(quán)利。

非經(jīng)本公司書面許可，任何單位和個人不得擅自摘抄、復(fù)制本文檔內(nèi)容的部分或

全部，并不得以任何形式傳播。

NewRoczk

TECHNOLOGIES

OMAPI技術(shù)開發(fā)文檔（V6.0）

本文主要介紹OMAPI的作用及使用方法，幫助程序開發(fā)人員學(xué)習(xí)并掌握OMAPI,最終利

用OMAPI開發(fā)出更多更好的應(yīng)用程序。

?點擊這里下載PDF版。

?點擊這里下載Word版。

讀前須知

閱讀本文檔之前，您最好對我司的OM系列的IPPBX產(chǎn)品有一定了解。

推薦資料：《OM用戶手冊》、《OM管理員手冊》、《OM功能學(xué)習(xí)指導(dǎo)書》。

資料下載：0M相關(guān)資料可到迅時官網(wǎng)下載。

說明：所有OM系列產(chǎn)品的OMAPI都是一樣的，只是版本不同而已。

技術(shù)支持與服務(wù)

為保障開發(fā)者能夠基于OMAPI順利開發(fā)應(yīng)用產(chǎn)品，我們提供了論壇、QQ群、微信公共號

等多渠道的技術(shù)支持與服務(wù)。

OMAPI技術(shù)交流QQ群號：

OMAPI技術(shù)咨詢電話：轉(zhuǎn)278

迅時IPPBX客服電話：

微信公眾號：

迅時通信迅時OMAPI

發(fā)布時間:2017-02-08

目錄

OMAPI技術(shù)開發(fā)文檔(V6.0)....................................................錯誤!未定義書簽。

1快速入門................................................錯誤!未定義書簽。

1.1初次見面............................................錯誤!未定義書簽。

1.2交互原理...........................................錯誤!未定義書簽。

1.3測試demo............................................................................錯誤!未定義書簽。

1.4API認證............................................錯誤!未定義書簽。

2OMAPI接口............................................錯誤!未定義書簽。

2.1控制命令(Control)................................................................錯誤!未定義書簽。

2.1.1查詢(Query)...................................................................錯誤!未定義書簽。

2.1.2配置(Assign).................................................................錯誤!未定義書簽。

2.1.3呼叫保持和接回(Hold/Unhold)......................................錯誤!未定義書簽。

2.1.4靜音開啟與解除(Mute/Unmute)....................................錯誤!未定義書簽。

2.1.5監(jiān)聽和插播(Monitor/Talk/Listen).................................錯誤!未定義書簽。

2.1.6強插(Bargein)................................................................錯誤!未定義書簽。

2.1.7強拆(Clear)....................................................................錯誤!未定義書簽。

2.2呼叫轉(zhuǎn)接命令(Transfer).................................................錯誤!未定義書簽。

2.2.1連接(Connect)..........................................................錯誤!未定義書簽。

2.2.2隊列(Queue).............................................................錯誤!未定義書簽。

2.2.3會議(Conference)....................................................錯誤!未定義書簽。

2.3語音管理命令(Manage)...................................................錯誤!未定義書簽。

2.3.1查詢語音文件....................................錯誤!未定義書簽。

2.3.2刪除語音文件....................................錯誤!未定義書簽。

2.4來電受理(Accept)...........................................................錯誤!未定義書簽。

2.5事件報告...........................................錯誤!未定義書簽。

2.5.1系統(tǒng)事件........................................錯誤!未定義書簽。

2.5.2分機狀態(tài)變更事件................................錯誤!未定義書簽。

2.5.3呼叫狀態(tài)變更事件................................錯誤!未定義書簽。

2.5.4來電呼入控制流程事件............................錯誤!未定義書簽。

2.5.5按鍵信息事件(DTMF)....................................................錯誤!未定義書簽。

2.5.6語音文件播放完畢事件(EndOfAnn)..............................錯誤!未定義書簽。

2.5.7分機組隊列事件(QUEUE)..........................................錯誤!未定義書簽。

2.6通話記錄報告........................................錯誤!未定義書簽。

2.6.1呼入(IN).........................................................................錯誤!未定義書簽。

2.6.2呼出(0U).......................................................................錯誤!未定義書簽。

2.6.3內(nèi)部互撥(L0).................................................................錯誤!未定義書簽。

2.6.4呼叫轉(zhuǎn)移(FI/FW)............................................................錯誤!未定義書簽。

2.6.5雙向外呼(CB).................................................................錯誤!未定義書簽。

3實現(xiàn)方案................................................錯誤!未定義書簽。

3.1點擊撥號............................................錯誤!未定義書簽。

3.2來/去電彈屏.........................................錯誤!未定義書簽。

3.3多級IVR...............................................................................錯誤!未定義書簽。

3.4來電黑名單.........................................錯誤!未定義書簽。

3.5來電直通車.........................................錯誤!未定義書簽。

3.6指定中繼外呼.......................................錯誤!未定義書簽。

3.7酒店叫醒解決方案...................................錯誤!未定義書簽。

3.8API+TTS實現(xiàn)方案...................................錯誤!未定義書簽。

3.9語音播報實現(xiàn)方案...................................錯誤!未定義書簽。

3.10API中間件解決方案................................錯誤!未定義書簽。

3.11API+儂好解決方案..................................錯誤!未定義書簽。

3.12API+云平臺解決方案................................錯誤!未定義書簽。

3.13分機外呼控制實現(xiàn)方案..............................錯誤!未定義書簽。

3.14監(jiān)聽+插播+強拆實現(xiàn)方案............................錯誤!未定義書簽。

3.15接通后播放語音實現(xiàn)方案............................錯誤!未定義書簽。

3.16滿意度評價實現(xiàn)方案................................錯誤!未定義書簽。

3.17公網(wǎng)服務(wù)器訪問私網(wǎng)內(nèi)OM................................................錯誤!未定義書簽。

3.17.1端口映射.......................................錯誤!未定義書簽。

3.17.2配置云平臺做代理轉(zhuǎn)發(fā)...........................錯誤!未定義書簽。

3.17.3客戶端直接訪問OM....................................................錯誤!未定義書簽。

4專題介紹................................................錯誤!未定義書簽。

4.1IPPBX...................................................................................錯誤!未定義書簽。

4.2語法和對象.........................................錯誤!未定義書簽。

4.3API認證............................................錯誤!未定義書簽。

4.4API反向認證........................................錯誤!未定義書簽。

4.5API功能開關(guān)........................................錯誤!未定義書簽。

4.6API控制模式功能介紹................................錯誤!未定義書簽。

4.7外轉(zhuǎn)外功能開關(guān).....................................錯誤!未定義書簽。

4.8錄音...............................................錯誤!未定義書簽。

4.9FSP錄音下載.......................................錯誤!未定義書簽。

4.10語音文件配置說明..................................錯誤!未定義書簽。

4.11語音菜單..........................................錯誤!未定義書簽。

4.12出隊列判斷方法....................................錯誤!未定義書簽。

4.13插播TTS遠程語音文件..............................錯誤!未定義書簽。

4.14迅時云平臺配置方法................................錯誤!未定義書簽。

4.15跨域訪問OM的解決方法............................錯誤!未定義書簽。

4.16Telnet登錄OM后臺的方法..........................錯誤!未定義書簽。

5常見問題解答............................................錯誤!未定義書簽。

5.1網(wǎng)絡(luò)環(huán)境相關(guān)問題解答................................錯誤!未定義書簽。

5.2API認證相關(guān)問題解答................................錯誤!未定義書簽。

5.3menu相關(guān)問題解答..................................錯誤!未定義書簽。

5.4配置相關(guān)問題解答...................................錯誤!未定義書簽。

5.5呼叫相關(guān)問題解答...................................錯誤!未定義書簽。

5.6事件相關(guān)問題解答...................................錯誤!未定義書簽。

5.7CDR相關(guān)問題解答...................................錯誤!未定義書簽。

5.8其他問題...........................................錯誤!未定義書簽。

6附錄....................................................錯誤!未定義書簽。

6.1系統(tǒng)參數(shù)列表........................................錯誤!未定義書簽。

6.2系統(tǒng)參數(shù)查詢和配置方法.............................錯誤!未定義書簽。

6.3軟件版本迭代.......................................錯誤!未定義書簽。

Rev21(GA)...................................................................錯誤!未定義書簽。

Rev13(GA)...................................................................錯誤!未定義書簽。

Rev07(GA)...................................................................錯誤!未定義書簽。

Rev02(GA)...................................................................錯誤!未定義書簽。

Rev2(GA).....................................................................錯誤!未定義書簽。

Rev6(GA).....................................................................錯誤!未定義書簽。

6.4文檔更新說明錯誤!未定義書簽。

1快速入門

本章簡單介紹OMAPI基本概念及應(yīng)用服務(wù)器和0M之間的基本交互原理,手把手教你完

成OMAPI認證配置，并使用測試工具體驗應(yīng)用服務(wù)器和0M之間的消息交互，助您快速

入門。

1.1初次見面

關(guān)于OMAPI

迅時0M系歹ij的IPPBX設(shè)備提供統(tǒng)一的開放式接口---OMAPI,開發(fā)者可以通過OMAPI

對OM設(shè)備進行控制、監(jiān)控和數(shù)據(jù)統(tǒng)計等。

OMAPI本質(zhì)上是經(jīng)過封裝的簡單XML消息，應(yīng)用服務(wù)器和0M設(shè)備之間通過HTTP協(xié)議

進行通信。

1.應(yīng)用服務(wù)器通過OMAPI對OM進行操作：參數(shù)查詢、參數(shù)配置、狀態(tài)查詢、呼叫控制、

呼叫轉(zhuǎn)接等。

2.OM實時向應(yīng)用服務(wù)器推送報告：分機狀態(tài)變化、呼叫狀態(tài)、配置變化、服務(wù)啟動、DTMF、

語音播放完畢和通話記錄等。

OMAPI使OM設(shè)備具有更大的靈活性和可操作性，開發(fā)者可利用OMAPI開發(fā)或?qū)雍艚?/p>

中心、計費系統(tǒng)、酒管系統(tǒng)、CRM、OA辦公系統(tǒng)等豐富多彩的應(yīng)用。

OMAPI有如下四類本領(lǐng)：

q大西切

承翳釐融詞圖含解通1遑

可實現(xiàn)的主要功能有：點擊撥號、來/去電彈屏、通話記錄、錄音、狀態(tài)監(jiān)控、分機組和隊

列、IVR語音導(dǎo)航、滿意度調(diào)查、酒店叫醒服務(wù)、語音信箱、語音驗證碼、來電黑/白名單

等。

成功案例和合作共贏

迅時搭建了一個類似于第三方應(yīng)用市場的平臺——企業(yè)應(yīng)用平臺，所有利用OMAPI開發(fā)

的應(yīng)用產(chǎn)品都可以申請上架到該平臺。

上架該平臺至少有兩大好處：

1.擴展渠道：迅時的渠道就等于你的渠道。迅時在全國大約有1200家渠道和合作伙伴，

這些渠道會向用戶推薦你的應(yīng)用產(chǎn)品。當用戶需要購買時，渠道人員會聯(lián)系你。另外，

我們也會定期推廣優(yōu)質(zhì)的應(yīng)用產(chǎn)品。

2.數(shù)據(jù)統(tǒng)計和分析：迅時會定期將您的應(yīng)用產(chǎn)品的訪問量、用戶喜歡數(shù)量、排名等統(tǒng)計結(jié)

果以郵件或微信形式發(fā)送給你，讓你輕松掌握市場反饋。

迅時歡迎更多合作伙伴的參與，共同解決中小型企業(yè)的辦公和通信問題。

1.2交互原理

簡單認識OMAPI之后，我們來了解下OMAPI的通信方式。

傳輸協(xié)議

應(yīng)用服務(wù)器和OM之間基于HTTP協(xié)議進行通信，API消息封裝在HTTP包體中。

消息內(nèi)容如：

HTTP請求消息：

POST/xmlHTTP/1.0

Content-Type:text/xml

Content-Length:101

<?xmlversion="1.0"encoding="utf-8"?>

<Controlattribute="Query">

<Devicelnfo/>

</Control>

HTTP響應(yīng)消息：

HTTP/1.0200OK

<?xmlversion=n1.0uencoding=Hutf-8"?>

<Devicelnfo>

<manufacturer>NewRockTechnologies,lnc</manufacturer>

<model>Rev1.0.1WROC2000-1S/1</model>

<version>Rev1.1</version>

<mac>00:0E:A9:00:12:BD</mac>

<devices>

<extlineid=HPhone1nid=n200n/>

<extlineid="IPPhone50Mid="208H/>

<linelineid='Line2“id=""/>

dinelineid=HIPLine21'*id="n/>

</devices>

</Devicelnfo>

通信方式

應(yīng)用服務(wù)器和OM之間的交互是雙向的，雙方互為HTTP服務(wù)端和客戶端。

正向：應(yīng)用服務(wù)器作為HTTP客戶端，OM作為HTTP服務(wù)端

應(yīng)用服務(wù)器請求OM執(zhí)行某個功能（如，發(fā)起呼叫）或提供某些信息（如，查詢狀態(tài)）。

此時，采用的是HTTPPOST方法、TCP短連接方式（注：OM只支持TCP短連接接收）。

流程為：①請求②響應(yīng)③斷開。

交互圖如下:

應(yīng)用服務(wù)器(HTTPClient)0M設(shè)備(HTTPServer)

----------------由應(yīng)用服務(wù)器主動和OM建立TCP連接--------------?

----------------應(yīng)用服務(wù)器向OM發(fā)送HTTPPOST請求--------------?

POST.'xmlHTTP/LO

Content-rype:texVhtniI

Content-Length:!01

<?xmlvcrsion=M1.0Mcncoding=,*utf-8n?>

<Controlattributc=HQueryn>

<DcviccInta'>

</Control>

步驟3-----------應(yīng)用服務(wù)II接收OM回復(fù)的HTTP響應(yīng)

HTTP1.0200OK

Date:Eri,21Mar201409:3331GMI

Server:2.2,61

Cachc-Contn)l:no-cachc

Pragma:no-cachc

Expires:-!

Connection:close

Contcnt-Tji^c:tcxt'xml

Content-Length:504

<?xmlvcr5ion='*1.0°cncoding=Mutf-8**?>

<Devicelnfb>

<manutacturer>NewRockTechnologies,Inc<.nunutacturer>

<modd>Rcv1,0.1WROC2000-1<'modcl>

<vereion>Rev1<.Version>

<devices>

<extImei^Phonerid=H20R"Z>

<extlineicH'IPPhone10"id=-2(XF/>

<linelineid”Line2”id”61204321”》

Vinelincid=HIPLinc21Mid="6l2OO375”>

〈/devices〉

<.DeviceInfb>

步驟4----米------般情況下，由應(yīng)用服務(wù)器主動斷開TCP連接------X-------?

情況二：OM作為HTTP客戶端，應(yīng)用服務(wù)器作為HTTP服務(wù)端

OM主動向應(yīng)用服務(wù)器推送某些消息（如，分機振鈴事件），應(yīng)用服務(wù)器收到消息后斷開

TCP連接（注：這里不是標準的HTTP請求響應(yīng)流程，不需要應(yīng)用服務(wù)器回復(fù)響應(yīng)）。

此時，采用的是HTTPGET或POST方法（默認為GET,若參數(shù)API_METHOD=1,則

為POST）。

注：OM默認以短連接方式推送消息，也可通過參數(shù)CONTROL_TYPE配置為長連接。

建議采用短連接方式。

流程為：①接收消息②斷開。

應(yīng)用服務(wù)器（HTTPServer）OM設(shè)備(HTTPClient)

。監(jiān)聽TCP連接

<4--------------------------接受由OM發(fā)起的TCP連接請求-------------------

步賽3】----------------接收由QM發(fā)送的HTTPGET諳求------------------

GET/busy.htmHTTP/l.l

Host:53

Cache-Control:no-cachc

Content-Length:93

<?xmlversion-1.0*'encoding="ut08”?>

〈Eventattribute"BUSY"〉

<extid”218”3

〈/Event)

步驟4】X.........一般情況下，由應(yīng)用服務(wù)器主動斷開TCP連接--X-―

1.3測試demo

我們提供多種語言（如PHP、JAVA、C#、C）編寫的發(fā)送和接收消息的demo,詳情請參考

API新編開發(fā)指南?

下面，我們用測試工具（相當于一個簡單的應(yīng)用服務(wù)器）來演示OM和API應(yīng)用服務(wù)器的

配置方法及收發(fā)消息過程。

配置

注：這里我們采用IP認證方式。

步驟一：配置OM設(shè)備認證地址

登錄0M設(shè)備頁面，點擊應(yīng)用服務(wù)器〉A(chǔ)PI,在應(yīng)用服務(wù)器一欄選擇自定義（默認選中為

儂好，儂好是內(nèi)置在設(shè)備里的小型呼叫中心），填寫應(yīng)用服務(wù)器地址（即測試工具所在的電

腦IP：OM發(fā)送端口,可自定義）如，7:8989o

步驟二：配置分機和外線的API開關(guān)

進入應(yīng)用服務(wù)器>API,在API功能開關(guān)一欄將分機和外線的狀態(tài)監(jiān)控、來電應(yīng)答前/來電

應(yīng)答后控制開關(guān)打開，點擊保存，并重啟設(shè)備。

設(shè)備配置如下圖所示:

OM20產(chǎn)品饌中■憔?￡；?jfia

步驟三：配置測試工具

1.點擊這里下載測試工具及其源代碼，并在電腦桌面打開，填寫一個HTTP監(jiān)聽端口（該

端口與設(shè)備上配置的0M發(fā)送端口保持一致，應(yīng)為8989），點擊開始監(jiān)聽。（注：測

試工具的源碼可點擊這里下載）。

2.填寫發(fā)送地址（即0M的IP地址和HTTP端口），如19:80。

注；OM的HTTP端口默認為80,可在設(shè)備高級設(shè)置〉安全配置〉Web管理處修改。

測試工具配置如下圖所示:

跑個流程

完成了配置以后，接下來我們演示一個分機呼叫分機的流程，為第二章的接口使用和理解奠

定基礎(chǔ)。

發(fā)送命令

如何通過OMAPI實現(xiàn)分機呼分機呢？

只需向0M發(fā)送一條API消息：

<?xmlversion="1.0"encoding="utf-8"?>

<Transferattribute="Connect">

<extid="200"/>

<extid="2017>

</Transfer>

說明：

第一行是XML聲明，每個API消息都有且相同。它定義了XML的版本（1.0）和所使

用的編碼方式（utf-8）o

?第二行是XML的根。根元素Transfer表明這個是一個呼叫轉(zhuǎn)接類的API。屬性值

Connect表示本次轉(zhuǎn)接的屬性為連接。

?第三、第四行中ext是“分機’的英文單詞extension的簡寫，200為主叫分機號碼，201

為被叫分機號碼。

?第五行為根節(jié)點的閉合標簽。

注：更多XML的語法參見XML教程，更多OMAPI語法詳解請參見第二章。

觀察執(zhí)行結(jié)果

執(zhí)行完該API后，后續(xù)流程為：

1.主叫分機200會先振鈴（默認，先呼誰后呼誰由參數(shù)API_CALLING控制）；

2.將200摘機后，被叫分機201開始振鈴，并且200可以聽到“嘟嘟”的回鈴音；

3.將201也摘機后，雙方成功建立通話：

4.任意一方掛機后通話結(jié)束。

觀察收到的API消息

查看測試工具，可以看到接收到很多條API消息。這些消息中，有兩個消息是話單（CDR）,

其他的為事件（Event）。

?CDR為通話記錄，在通話結(jié)束時產(chǎn)生。2個CDR中一個是主叫分機的通話記錄，另一

個是被叫分機的通話記錄；

?Event表示事件消息，由呼叫過程中0M自動觸發(fā)。

1）事件

本次呼叫過程中，收到的事件屬性有這些：BUSY、IDLE、RING、ALERT、ANSWER、

ANSWERED.BYE。

其中：

?BUSY和IDLE是一對，在分機狀態(tài)發(fā)生變化時產(chǎn)生。BUSY表示分機由空閑變?yōu)槊?/p>

態(tài)，IDLE表示分機由忙變?yōu)榭臻e狀態(tài)；

?RING、ALERT,ANSWER.ANSWERED.BYE屬于一個系歹ij,在呼叫過程中產(chǎn)生。

其中：

oRING和ALERT是一對，RING表示分機開始振鈴，ALERT表示收到對方的回鈴

（ringback）信號。

oANSWER和ANWERED是一對，ANSWER表示分機應(yīng)答，ANSWERED表示收

到對方應(yīng)答的信號。

oBYE表示通話結(jié)束。

通過以上事件，你可以實時監(jiān)控分機的線路狀態(tài)和呼叫情況，并可以實現(xiàn)一些應(yīng)用功能，比

如：來/去電彈屏（當分機振鈴時將來電號碼對應(yīng)的客戶資料彈屏顯示在電腦屏幕上）。

注：更多關(guān)于事件的介紹，參見2.5章節(jié)。

2）通話記錄（CDR）

通話結(jié)束后，0M會立即將通話記錄推送給應(yīng)用服務(wù)器（這里指測試工具）。

消息格式

<?xmlversion="1.0"encoding="utf-8"?>

<Cdrid=H103713-0H>

<callid>32820</callid>

<TimeStart>209</TimeStart>

<Type>IN</Type>

<Route>IC</Route>

<CPN>200</CPN>

<CDPN>201</CDPN>

<TimeEnd>203</TimeEnd>

<Duration>2</Duration>

<TrunkNumberx/TrunkNumber>

<Recording>20170308/200_201_20170308_103711_8034_cd.wav</Recording>

<RecCodec>PCMU</RecCodec>

</Cdr>

參數(shù)說明

參數(shù)名稱解釋說明

Cdrid通話記錄的編號。格式：系列號+年月日時分秒+固定內(nèi)容卜0）

callid通話的相對唯一標識符

TimeStart呼叫起始時間戳，格式：年月日時分秒

Type話務(wù)類型，IN表示呼入，LO表示內(nèi)部呼叫

Route路由類型，IC表示內(nèi)部路由

參數(shù)名稱解釋說明

CPN主叫號碼

CDPN被叫號碼

TimeEnd呼叫釋放時間戳，格式：年月日時分秒

通話時長，單位：秒。即，從呼叫接通到呼叫釋放的時長，不包括振鈴

Duration

時間。

Trunk中繼號碼（本次是內(nèi)部呼叫，沒有用到中繼，所以值為空）

Recording錄音文件的相對保存路徑，格式：生成日期/錄音文件名稱

注：更多關(guān)于CDR的介紹，參見2.6章節(jié)。

1.4API認證

API認證方式包括正向認證和反向認證兩種。

正向認證：應(yīng)用服務(wù)器向0M發(fā)送請求命令時，需通過0M的認證。

反向認證：0M向應(yīng)用服務(wù)器發(fā)送消息時，需通過應(yīng)用服務(wù)器的認證。

一、正向認證

正向認證分為IP認證和數(shù)字簽名認證兩種方式，您可以根據(jù)自己的實際場景選擇一種來

完成認證。

IP認證

IP認證，只允許某一固定IP地址向0M發(fā)送API請求，其他地址統(tǒng)統(tǒng)認為沒有權(quán)限.

適用的應(yīng)用場景：

1.應(yīng)用服務(wù)器的IP地址/域名固定；

2.一個應(yīng)用服務(wù)器對接一臺0M；

3.應(yīng)用服務(wù)器和0M之間網(wǎng)絡(luò)互通。

配置

配置方法，如下圖所示:

參數(shù)說明：

?服務(wù)器地址：應(yīng)用服務(wù)器的IP地址/域名和監(jiān)聽端口，如：7:8989。

如果用戶未指定端口時默認為80端口。

?URL：接收API報告的相對路徑（也可不填寫）。格式為：

{parti}/{part2}/{part3}/{......},如:omapi/reporto

服務(wù)器地址和URL組合起來即為應(yīng)用服務(wù)器接收API報告的全路徑，如：

7:8989/omapi/report,

應(yīng)用服務(wù)器地址的作用：

1.接收API報告：0M會將API消息推送給這個地址；

2.訪問權(quán)限控制：0M只受理從該服務(wù)器的IP地址（端口不影響）發(fā)送的API請求;

拒絕受理從其它地址發(fā)送的API請求，并對該請求響應(yīng)Unauthorized?

點擊這里查看更多詳情。

數(shù)字簽名認證

數(shù)字簽名認證本質(zhì)上是通過驗證0M和應(yīng)用服務(wù)器雙方持有的秘鑰來完成認證。

版本要求

OM軟件版本：Rev9及其以上。

適用的應(yīng)用場景:

1.應(yīng)用服務(wù)器采用動態(tài)域名，IP地址不固定；

2.一個0M要對接多個API應(yīng)用服務(wù)器；

3.API應(yīng)用客戶端要直接訪問0M；

4.API消息的源地址容易發(fā)生變化；

5.應(yīng)用服務(wù)器通過迅時云平臺轉(zhuǎn)發(fā)消息給0M。

配置

配置參數(shù)：數(shù)字簽名認證密碼（接收）和數(shù)字簽名有效期。

配置界面，如下圖所示:

參數(shù)說明:

1.API數(shù)字認證密碼（接收）：0M對應(yīng)用服務(wù)器認證的秘鑰，可自定義，需和應(yīng)用服

務(wù)器發(fā)送請求時攜帶的秘鑰保持一致。

2.API數(shù)字認證有效期：可自定義，范圍：0-86400,單位：秒，只有在該有效期內(nèi)認

證參數(shù)才有效，0表示永久有效。

點擊這里查看更多詳情。

注：不論是IP認證還是數(shù)字簽名認證，都需要在OM頁面配置應(yīng)用服務(wù)器地址，用來接

收API消息。

二、反向認證

反向認證，即應(yīng)用服務(wù)器對OM的認證。OM向應(yīng)用服務(wù)器推送API消息時攜帶Auth認

證信息，應(yīng)用服務(wù)器根據(jù)收到的消息是否滿足認證條件來選擇是否接收該消息。

注：只有應(yīng)用服務(wù)器要求對OM進行認證時才配置，若不要求，可不配置。

版本要求

Rev16及以上

配置

配置參數(shù)：數(shù)字簽名認證密碼（發(fā)送）和數(shù)字簽名有效期。

配置界面，如下圖所示:

參數(shù)說明：

1.API數(shù)字認證密碼（發(fā)送）：應(yīng)用服務(wù)器對0M進行認證的秘鑰，可自定義，需和

應(yīng)用服務(wù)器接收消息時配置的秘鑰保持一致。

2.API數(shù)字認證有效期：可自定義，范圍：0-86400,單位：秒，只有在該有效期內(nèi)認

證參數(shù)才有效，0表示永久有效。

點擊這里查看更多詳情。

2OMAPI接口

本章為OMAPI接口部分，包括API請求命令和API報告兩部分內(nèi)容。

?API請求命令，指應(yīng)用服務(wù)器向OM發(fā)送的API消息，包括制命令、轉(zhuǎn)接命令和來電

受理命令三種類型。

?API報告，指OM主動向應(yīng)用服務(wù)器推送的API消息，包括事件報告和通話記錄報告

兩種類型。

2.1控制命令(Control)

控制命令包括查詢、配置、呼叫保持與接回、靜音與解除靜音、監(jiān)聽、強插、強拆。

2.1.1查詢(Query)

此類API用于查詢0M設(shè)備上指定對象的相關(guān)信息(如，配置參數(shù)和狀態(tài))。這些對象包括：

設(shè)備信息(deviceInfo)分機(ext)、中繼(trunk)>來電(visitor)去電(outer)、分

機組(group)、語音菜單(menu)。

查詢請求的規(guī)則說明

?最小的查詢單位是對象，即不支持單獨查詢該對象的某一個具體參數(shù)。

查詢結(jié)果的規(guī)則說明

?查詢結(jié)果中包含該對象的所有可提供的相關(guān)參數(shù)和狀態(tài)信息。

?如果查詢結(jié)果中沒有攜帶某個參數(shù)信息，則可能原因為：

°該參數(shù)值為默認值；

°該參數(shù)不存在；

°不支持查詢該參數(shù)。

查詢設(shè)備信息

該API用于查詢0M設(shè)備自身的相關(guān)信息，如：生產(chǎn)商、硬件版本、軟件版本，以及所有

的分機、分機組和中繼等。

請求示例

<?xmlversion="1.0"encoding="utf-8"?>

<Controlattribute="Query">

<Devicelnfo/>

</Control>

參數(shù)說明

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

<Devicelnfo>stringOM設(shè)備的基本信息無值

響應(yīng)示例

<?xmlversion="1.0"encoding=Hutf-8"?>

<Devicelnfo>

<manufacturer>NewRockTechnologies,lnc</manufacturer>

<model>Rev6.0.0OM20-2S/2</model>

<version>Rev11</version>

<mac>00:0E:A9:00:12:BD</mac>

<devices>

<extlineid=HPhone1nid=n200"/>

<extlineid=HIPPhone50"id="208M/>

dinelineid="Line2nid=""/>

dinelineid="IPLine21Hid=（m/>

<groupid=T>

<extid=M200"/>

</group>

</devices>

</Devicelnfo>

參數(shù)說明

說明：v>表示必選項，口表示可選項（當參數(shù)值為默認值或空時，響應(yīng)消息可能不攜帶該參

數(shù)），|表示或者關(guān)系

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

Devicelnf

objectOM設(shè)備信息無

0

<manufac

string生產(chǎn)商NewRockTechnologies,Inc

turer>

<model>string硬件版本如Rev6.0.0OM20-2S/2

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

<version>string軟件版本如Rev11

如00:0E:A9:00:12:BD（由系統(tǒng)

[mac]string物理地址參數(shù)API_MAC決定是否攜帶

MAC地址）

[ext]object分機

<ext分機的線路編號，是分<Phone|IPPhone>{NO.},如:

string

lineid>機的唯一固定標識Phone1

<extid>string分機號

line和trunk是指同一個對象，

[line]object中繼（外線）

即中繼（外線）

<line中繼的線路編號，是中<Line|IPLine>{NO.},如：Line

string

lineid>繼的唯一固定標識13

[lineid]string中繼號

[groupid]int分機組的序號1-50

注：

?響應(yīng)結(jié)果中包含所有的分機線路和中繼線路信息，如果設(shè)備線路量很大，注意查詢接收

的緩存空間；

?設(shè)備線路量大時，建議使用web的分頁查詢接口分別獲取分機或中繼線路。

查詢分機

該API用于查詢指定分機的相關(guān)信息，如：配置參數(shù)、分機狀態(tài)、通話方等。

請求示例

<?xmlversion="1.0"encoding="utf-8"?>

<Controlattribute="Query">

<extid="208"/>

</Control>

參數(shù)說明

參數(shù)名

類型參數(shù)說明參數(shù)值說明

稱

<extid>string分機號必須為0M上的有效分機，值不能為空

響應(yīng)示例

<?xmlversion="1.0"encoding="utf-8u?>

<Status>

<extid=M208M>

<lineid>Phone1</lineid>

<groupid="1V>

<groupid=M27>

<staffid>1304081</staffid>

<Call_Pickup>yes</Call_Pickup>

<Fwd_Numberx/Fwd_Number>

<Call_Restriction>3</Call_Restriction>

<Off_Line_Num>200</Off_Line_Num>

<mobilex/mobile>

<forkx/fork>

<emailx/email>

<record>on</record>

<api>7</api>

<voicefile>welcome</voicefile>

<state>active</state>

<outerid=M8"from=n208Hto='n,trunk』”callid=,,28680">

<state>talk</state>

</outer>

</ext>

</Status>

參數(shù)說明

說明：v>表示必選項，口表示可選項（當參數(shù)值為默認值或空時，響應(yīng)消息可能不攜帶該參

數(shù)），|表示或者關(guān)系

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

<extid>string分機號純數(shù)字字符串

分機的線路編號，是分機IPPhone|Phone

<lineid>string

的唯一固定標識XXX

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

工號，分機接通前會向來

[staffid]string純數(shù)字字符串

電方播放該工號

分機組，這里為該分機所

[group]int1-50

屬的分機組

語音文件，這里為分機隊

只支持.dat和.pcm格

[voicefile]string列中排隊等待時播放的

式

語音文件

員工的電子郵件地址（暫

[email]string

無對應(yīng)功能）

0:內(nèi)線，1:市話，

[Call_Restriction]int呼叫權(quán)限

2:國內(nèi)，3:國際

代接權(quán)限，是否允許來電

[Call_Pickup]stringYes:允許,no:不允許

被其它分機代接

免打擾功能開關(guān)，開啟免

[No_Disturb]string打擾后分機將屏蔽所有on:開啟，off:關(guān)閉

來電，但能主動發(fā)起呼叫

0:關(guān)閉，1:全轉(zhuǎn)，

[Fwd_Type]int呼叫轉(zhuǎn)移方式

2:遇忙或無應(yīng)答轉(zhuǎn)

[Fwd_Number]string呼叫轉(zhuǎn)移號碼值為空時關(guān)閉

[fork]string同振號碼值為空時關(guān)閉

分機綁定的手機號，該手

[mobile]string機號可作為呼叫轉(zhuǎn)移、離值為空時關(guān)閉

線轉(zhuǎn)移的缺省配置

[record]string實時錄音功能開關(guān)on:開啟，off:關(guān)閉

0：關(guān)閉API狀態(tài)監(jiān)控

7:開啟API狀態(tài)監(jiān)控

[api]intAPI的功能開關(guān)

點擊查看API功能開

關(guān)詳細介紹

[state]string線路狀態(tài)Ready:空閑可用

參數(shù)名稱類型參數(shù)說明參數(shù)值說明

Active:振鈴、回鈴或

通話中

Progress：模擬分機摘

機后等待撥號以及撥

號過程中

Offline:IP分機離線

Offhook：模擬分機聽

催掛音時的狀態(tài)

去電，這里作為該查詢分

[outer]object

機的通話方

去電的編號，可依據(jù)該參

[id]int

數(shù)進行呼叫轉(zhuǎn)接

[from]string原始主叫號碼

原始被叫號碼（對于

<to>stringvisitor而言，原始被叫為

來電呼入中繼號碼）

中繼號，即該去電從該中

[trunk]string

繼呼出

[callid]int通話的相對唯一標識符

Talk:通話進行中

Progre