1、-作者xxxx-日期xxxx浙江融創OpenMAS移動代理服務器軟件產品-基礎組件接口設計文檔【精品文檔】中國移動浙江公司OpenMAS移動代理服務器軟件產品基礎組件接口設計文檔目錄1. 概述21.1. 文檔概述21.2. 引用標準22. OpenMAS業務簡介32.1. OpenMAS業務定義32.2. OpenMAS業務特征33. 接口說明43.1. 短消息接口43.1.1. 業務功能43.1.2. 流程說明43.1.3. 數據類型定義63.1.4. 短信發送(SendSMS)接口73.1.5. 短信接收(GetSms)接口83.2. 彩信接口103.2.1. 業務功能103.2.2. 流

2、程說明103.2.3. 彩信表示規范113.2.4. 數據類型定義133.2.5. 彩信發送(SendMMS)接口143.2.6. 彩信接收(GetReceivedMms)接口161. 概述1.1. 文檔概述本文檔描述了OpenMAS組件與SI/EC平臺交互的接口，包括短信、彩信、。1.2. 引用標準1中國移動通信集團公司 省BOSS與業務管理平臺（業務平臺）接口規范（暫行）（V）2中國移動通信集團公司 全網行業應用業務規范3中國移動通信集團公司中國移動一級BOSS系統接口規范-全網行業應用-SMS業務單行本-IAGW-M部分4中國移動通信集團公司中國移動一級BOSS系統接口規范V5中國移動通

3、信集團公司省行業網關開發全網行業應用總體技術要求報批稿6中國移動通信集團公司省BOSS與省行業網關接口規范2. OpenMAS業務簡介2.1. OpenMAS業務定義OpenMAS，即Open Mobile Agent Server，其將行業客戶的各類應用與移動通信業務應用集成結合，實現SMS（Short Message Service）、USSD（Unstructured Supplementary Service Data）、MMS（Multimedia Messaging Service）、WAP（Wireless Application Protocol）、KJava（Kilo JAV

4、A）等方面的移動數據應用，是溝通集團客戶IT應用環境與移動網絡之間的橋梁，為集團客戶提供面向移動網絡的統一的界面和接口，并可衍生出結合移動終端和其它移動應用的新的應用系統，豐富集團客戶應用；對集成集團客戶已有系統，OPENMAS系統可以簡化開發流程、縮短開發周期，可以快速在已有應用系統中集成移動化功能，也可以根據OPENMAS系統開發針對性的移動應用。2.2. OpenMAS業務特征與OPENMAS服務器所具備的特殊地位對應，可以將OPENMAS服務器的應用分為三個層次。ü 作為集團客戶應用系統的統一移動接入手段：為集團客戶應用系統提供包括短信、彩信、USSD、WAP、WEB、定位等

5、在內的統一通信能力。功能的側重點是提供通信能力的支持。在這個層次，MAS作為統一移動接入能力提供者，不參與業務的核心邏輯；ü 實現集團客戶應用的移動化：將集團客戶IT系統的應用環境擴展到移動網絡，從而實現移動化的集團客戶應用。此時，移動化成為集團客戶應用系統必備的功能需求，MAS服務器也成為集團客戶應用系統不可或缺的部分。為了實現移動化的需求，集團客戶應用系統不需要進行大的改動，在MAS服務器上需對集團客戶應用系統的功能進行必要的擴充，MAS服務器成為集團客戶應用系統的延伸。ü 提供新業務：在MAS服務器上運行一個或多個應用模塊。MAS服務器提供的應用相對獨立，或是由于移動

6、網絡環境而衍生出的新的業務系統，這些應用也屬于集團客戶應用系統的范疇，并與其它集團客戶應用系統共同使用MAS服務器所提供的接入和移動化支撐功能。3. 接口說明3.1. 短消息WebService接口3.1.1. 業務功能集團客戶應用系統通過此接口實現短信的收發和狀態查詢。集團客戶應用系統調用SendMessage接口發送短信，OpenMAS接收請求進行發送。在提交短信發送請求之后， OpenMAS根據集團客戶預先注冊的插件主動通知短信發送狀態。3.1.2. 短信發送接口3.1.2.1. 流程說明發送接口描述：· 集團客戶應用系統在OpenMAS基礎組件上注冊（并登記狀態報告的接收UR

7、L），并在OpenMAS基礎組件上生成賬號；· 集團客戶應用系統調用OpenMAS基礎組件的sendMessage接口，發起短信發送的操作；· OpenMAS接收到短信，然后將短信發送到短信網關；· OpenMAS接收短信網關的狀態報告（結果回執）；· OpenMAS根據注冊的URL，調用基礎組件的NotifySmsDeliveryReport方法（帶上回執的結果參數）。· 集團客戶應用系統獲取到具體的狀態報告信息。3.1.2.2. 調用方式接口接口定義發起方落地方說明發送短信SendMessage應用系統OpenMAS通知發送狀態Notify

8、SmsDeliveryStatusOpenMAS應用系統應用系統必須提前注冊對應插件3.1.2.3. 發送方法(SendMessage)發起方：應用系統落地方：OpenMas平臺string SendMessage(string ApplicationID, string Password, string DestinationAddresses, string Message);string SendMessage(string ApplicationID, string Password,string DestinationAddresses, string Message string

9、ExtendCode);備注：消息內容Message為UTF-8編碼。請求參數定義1、 ApplicationID：應用程序ID（類型：string）2、 Password：應用程序發送短信密碼，用來防止有人惡意模仿應用程序發送短信（類型：string）3、 DestinationAddresses：短信接收方號碼，可同時發多人（類型：string數組）4、 ExtendCode：由該應用填寫的應用內部擴展號碼。（類型：string）5、 Message：短信內容（類型：string）返回值定義6、 返回此次發送信息的唯一標識符，用于用戶查詢發送狀態。(類型：string)3.1.2.4. 狀

10、態報告方法 (NotifySmsDeliveryReport)發起方：OpenMas平臺落地方：應用系統限制條件：應用系統必須注冊指定插件void NotifySmsDeliveryReport(DeliveryReport deliveryReport);請求參數定義deliveryReport：短信發送狀態，與發送請求數組一一對應（類型：DeliveryReport）1、 DeliveryStatus：發送狀態（DeliveryStatus），枚舉類型0Delivered發送成功。1WaitingForDelivery等待發送。2WaitingForDeliveryStatus已發送,等待

11、狀態報告。3DeliveryFailed發送失敗。2、 ReceivedAddress：接收方地址（string）3、 StatusCode：狀態碼，如果發送失敗可確定錯誤原因（string）4、 SendAddress：發送地址5、 MessageId：發送標識返回值定義3、無返回值3.1.3. 短信接收接口3.1.3.1. 流程說明·· 接收短信流程說明：· 由應用系統提前在OpenMAS基礎組件注冊插件，并登記用于接收短信的URL；· 然后OpenMAS基礎組件從短信網關接收短信信息；· OpenMAS組件根據插件注冊時登記的URL信息，

12、調用URL對應的NotifySMS方法；· 集團客戶應用系統收到OpenMAS的調用，獲取上行短信唯一標識的MessageID；· 集團客戶應用系統調用OpenMAS組件方法（GetMessage），獲取上行短信的詳細內容。3.1.3.2. 調用方式接口接口定義發起方落地方說明上行短信通知NotifySmsOpenMAS應用系統應用系統必須提前注冊對應插件接收短信GetMessage應用系統OpenMAS3.1.3.3. 上行短信通知方法(NotifySms)發起方：OpenMas平臺落地方：應用系統void NotifySms(string MessageID);請求參數

13、定義1、MessageID：上行短信唯一標識，用來獲取信息（類型：string）返回值定義2、無返回值3.1.3.4. 接收短信方法(GetMessage)發起方：應用系統落地方：OpenMas平臺SmsMessage GetMessage(string MessageID);請求參數定義1、 MessageID：上行短信唯一標識（類型：string）返回值定義返回指定應用程序的上行短信。（類型：SmsMessage數組）,類型說明如下：1、 Message：短信正文（string）2、 ReceivedAddress：接收方地址（string）3、 SendAddress：發送方地址（str

14、ing）3.2. 短信數據庫接口集團客戶應用系統與OpenMAS基礎組件的數據庫可接口，只支持SQL SERVER 2005，同時數據庫部署在OpenMAS基礎組件側。3.2.1. 業務功能集團客戶應用系統通過此接口實現短信的收發和狀態查詢。集團客戶應用系統提交待發送短信到數據庫，OpenMAS從數據庫中獲取待發短信并進行發送。在提交短信發送請求之后， OpenMAS回寫狀態報告到短信發送結果表。3.2.2. 短信發送接口3.2.2.1. 業務流程流程說明:· 應用系統提交待發送短信到中間數據庫；· OpenMAS基礎組件定期從中間數據庫中獲取待發送短信；· Op

15、enMAS基礎組件發送短信；· OpenMAS基礎組件獲取短信的狀態報告；· OpenMAS基礎組件提交狀態報告到中間數據庫；· 應用系統定期從數據庫獲取狀態報告。3.2.2.2. 表結構說明短信待發送表：COM_SmsSent_+擴展號，如：COM_SmsSent_1字段名數據類型長度必填描述備注IDInt-是主鍵自動生成MessageIDString50是短信編號必須為唯一值，建議使用GUIDApplicationIDString40是應用程序編號OpenMAS基礎組件上注冊的賬號MessageContentString1000否發送的短信內容SendAddr

16、essString40是基礎接入號ExtendCodeString40否接入號擴展碼DestinationAddressString40是短信接收手機SendTimeDateTime-否短信創建時間默認取當前時間注：短信待發送表中的數據被發送后，OpenMAS基礎組件將自動刪除。短信狀態報告表：COM_SmsReport_+擴展碼，如：COM_SmsReport_1字段名數據類型長度必填描述備注IDInt-是主鍵標識字段，自動遞增ApplicationIDString40是應用程序編號MessageIDString50是短信編號必須為唯一值SendAddressString40否基礎接入號Ex

17、tendCodeString40否接入號擴展碼DestinationAddressString40是短信接收手機SendStatusInt-否短信提交結果0：成功，其他值為失敗GatawayStatusString20否短信發送結果網關返回錯誤(DELIVRD表示成功)CreateTimeDateTime-是狀態報告返回時間注：應用程序務必刪除已讀取的狀態報告，以免表數據越來越大影響性能。另外，如果OpenMAS從短信網關未獲取到狀態報告，則短信狀態報告表中將沒有數據。3.2.3. 短信接收接口3.2.3.1. 業務流程流程說明:· OpenMAS基礎組件從行業網關獲取上行短信；&#

18、183; OpenMAS基礎組件將上行短信提交到中間數據庫；· 應用系統定期從中間數據庫獲取上行短信。3.2.3.2. 表結構說明短信上行表COM_SmsIn_+擴展碼，如：COM_SmsIn_1字段名數據類型長度必填描述備注IDInt-是主鍵標識字段，自動遞增MessageIDString50是短信編號必須為唯一值ApplicationIDString40是應用程序編號MessageContentString1000否上行的短信內容SendAddressString40是上行手機號碼DestinationAddressString40是基礎接入號ExtendCodeString40

19、否接入號擴展碼CreateTimeDateTime-否上行時間注：應用程序務必刪除已讀取的上行短信，以免表數據越來越大影響性能。3.3. 彩信WebService接口3.3.1. 業務功能集團客戶應用系統通過此接口實現彩信的收發和狀態查詢。集團客戶應用系統調用SendMessage接口發送彩信，OpenMAS接收請求進行發送。在提交彩信發送請求之后，集團客戶應用系統可以主動請求查詢彩信發送狀態，或者由OpenMAS根據集團客戶預先注冊的插件主動通知彩信發送狀態。3.3.2. 彩信表示規范彩信可包含文字、圖片和鈴聲，所以采用XML格式來表示一條彩信。規范如下：元素屬性說明<masmms&g

20、t;-根元素<content>contentTypecontentidcontentLocationcharset消息體,出現多次,并且在content中沒有出現smil文件,則按順序顯示,如果有smil文件,則按照smil控制顯示屬性包括:ContentType:mime內容類型Contentid:smil正文中的內容id,如果沒有smil,則可自行定義.ContentLocation:媒體對象的文件名Charset: 編碼格式,可選 Content-Type支持格式：TEXT : text/plainXML: text/xmlSMIL: application/smilAMR:

21、 audio/amrMIDI: audio/midiGIF :image/gifJPEG: image/jpegWBMP:PNG: image/pngXml示例：<?xml version="1.0" encoding="utf-8"?><masmms><content contentType="image/gif" charset="" contentId="1.gif" contentLocation="1.gif">R0lGODlhg

22、ACAAPf/. hDjEijV1ELSAAOw=</content><content contentType="text/plain" charset="" contentId="1.txt" contentLocation="1.txt">uafPsreissY=</content><content contentType="application/smil" charset="" contentId="2.smil&q

23、uot; contentLocation="2.smil">PHNtaWw+PGhlYWQ+PGxheeT48L3NtaWw+</content></masmms>說明：如果Content中沒有SMILl類型文件，文本中文字、圖片和音頻的顯示順序按照Content在xml中的先后順序，如果有，則按照SMIL來控制顯示。3.3.3. 彩信發送接口3.3.3.1. 流程說明·· 發送流程說明：· 發集團客戶應用系統在OpenMAS基礎組件上注冊（并登記狀態報告的接收URL），并在OpenMAS基礎組件上生成賬號；

24、83; 集團客戶應用系統調用OpenMAS基礎組件的sendMessage接口，發起彩信發送的操作；· OpenMAS接收到彩信，然后將彩信發送到彩信網關；· OpenMAS接收彩信網關的狀態報告（結果回執）；· OpenMAS根據注冊的URL，調用基礎組件的NotifyMmsDeliveryReport方法（帶上回執的結果參數）。· 集團客戶應用系統獲取到具體的狀態報告信息。3.3.3.2. 調用方式接口接口定義發起方落地方說明發送彩信SendMessage應用系統OpenMAS通知發送狀態NotifyMmsDeliveryReportOpenMAS應

25、用系統應用系統必須提前注冊對應插件3.3.3.3. 發送方法(SendMessage)發起方：應用系統落地方：OpenMas平臺string SendMessage(string ApplicationID, string Password,string DestinationAddresses, string Subject, string Content);string SendMessage(string ApplicationID, string Password,string DestinationAddresses, string Subject, string Content,

26、string ExtendCode);string SendMessage(string ApplicationID, string Password,string DestinationAddresses, string Subject, string Content, string ExtendCode, Priority Priority);請求參數定義1、 ApplicationID：應用程序ID（string）2、 Password：應用程序發送彩信密碼，用來防止有人惡意發送彩信（類型：string）3、 DestinationAddresses：彩信接收方號碼，可同時發多人（str

27、ing數組）4、 ExtendCode：由該應用填寫的應用內部擴展號碼。5、 Subject：主題（string）6、 Priority：優先級（Priority）值名稱描述0Default缺省消息優先級1Low低的消息優先級2Normal正常的消息優先級3High高的消息優先級7、 Content：彩信內容-彩信的xml表示參見3表示規范。（string）返回值定義7、返回此次發送信息的唯一標識符，用于用戶查詢發送狀態。類型：string3.3.3.4. 彩信發送狀態通知接口（NotifyDeliveryStatus）發起方：OpenMas平臺落地方：應用系統限制條件：應用系統必須注冊指定插

28、件void NotifyMmsDeliveryReport(DeliveryReport DeliveryReport);請求參數定義1、 deliveryReport：彩信發送狀態（見彩信發送狀態表）DeliveryStatus：發送狀態（DeliveryStatus），枚舉類型0Delivered發送成功。1WaitingForDelivery等待發送。2WaitingForDeliveryStatus已發送,等待狀態報告。3DeliveryFailed發送失敗。ReceivedAddress：接收方地址（string）StatusCode：狀態碼，如果發送失敗可確定錯誤原因（string）SendAddress：發送地址MessageId：發送標識返回值定義3、無返回值3.3.4. 彩信接收接口3.3.4.1. 流程說明·· 接收短信流程說明：· 由應用系統提前在