浙江融創(chuàng)OpenMAS移動代理服務(wù)器軟件產(chǎn)品-基礎(chǔ)組件接口設(shè)計文檔

中國移動浙江公司OpenMAS移動代理效勞器軟件產(chǎn)品v1.022/232023.06名目\l“_TOC_250008“概述 3\l“_TOC_250007“文檔概述 3\l“_TOC_250006“引用標準 3\l“_TOC_250005“OpenMAS業(yè)務(wù)簡介 4\l“_TOC_250004“OpenMAS業(yè)務(wù)定義 4\l“_TOC_250003“OpenMAS業(yè)務(wù)特征 4\l“_TOC_250002“接口說明 5短消息接口 5\l“_TOC_250001“業(yè)務(wù)功能 5流程說明 9數(shù)據(jù)類型定義 錯誤！未定義書簽。短信發(fā)送(SendSMS)接口 錯誤！未定義書簽。短信接收(GetSms)接口 錯誤！未定義書簽。彩信接口 14\l“_TOC_250000“業(yè)務(wù)功能 14流程說明 17彩信表示標準 14數(shù)據(jù)類型定義 錯誤！未定義書簽。彩信發(fā)送(SendMMS)接口 錯誤！未定義書簽。彩信接收(GetReceivedMms)接口 錯誤！未定義書簽。概述文檔概述本文檔描述了OpenMAS組件與SI/EC平臺交互的接口，包括短信、彩信引用標準中國移動通信集團公司《省BOSS與業(yè)務(wù)治理平臺〔業(yè)務(wù)平臺〕接口標準〔暫行》〔V1.1.0〕中國移動通信集團公司《全網(wǎng)行業(yè)應(yīng)用業(yè)務(wù)標準》中國移動通信集團公司《中國移動一級BOSS系統(tǒng)接口標準-全網(wǎng)行業(yè)應(yīng)用-SMS業(yè)務(wù)單行本-IAGW-M2.0.0》中國移動通信集團公司《中國移動一級BOSS系統(tǒng)接口標準V1.4.5》中國移動通信集團公司《省行業(yè)網(wǎng)關(guān)開發(fā)全網(wǎng)行業(yè)應(yīng)用總體技術(shù)要求－》[6]中國移動通信集團公司《省BOSS1.1.2》OpenMAS業(yè)務(wù)簡介OpenMAS業(yè)務(wù)定義OpenMAS，即OpenMobileAgentServer，其將行業(yè)客戶的各類應(yīng)用與移動通信業(yè)務(wù)應(yīng)SM〔ShortMessageServicUSSUnstructuredSupplementaryServiceData〕、MMS〔MultimediaMessagingService〕、WAP〔WirelessApplicationProtocol〕、KJava〔KiloJAVA〕IT應(yīng)用環(huán)境與移動網(wǎng)絡(luò)之間的橋動應(yīng)用的的應(yīng)用系統(tǒng)，豐富集團客戶應(yīng)用；對集成集團客戶已有系統(tǒng)，OPENMAS系統(tǒng)可以O(shè)PENMAS系統(tǒng)開發(fā)針對性的移動應(yīng)用。OpenMAS業(yè)務(wù)特征與OPENMAS效勞器所具備的特別地位對應(yīng)，可以將OPENMAS效勞器的應(yīng)用分為三個層次。作為集團客戶應(yīng)用系統(tǒng)的統(tǒng)一移動接入手段：為集團客戶應(yīng)用系統(tǒng)供給包括短信、彩信、USSD、WAP、WEB、定位等在內(nèi)的統(tǒng)一通信力量。功能的側(cè)重點是供給通信力量的支持。在這個層次，MAS作為統(tǒng)一移動接入力量供給者，不參與業(yè)務(wù)的核心邏輯；IT實現(xiàn)移動化的集團客戶應(yīng)用MAS效勞器也成為集團客戶應(yīng)用系統(tǒng)不行或缺的局部。為了實現(xiàn)移動化的需求，集團客戶應(yīng)用系統(tǒng)不需要進展大的改動，在MAS效勞器上需對集團客戶應(yīng)用系統(tǒng)的功能進展必要的擴大，MAS效勞器成為集團客戶應(yīng)用系統(tǒng)的延長。MASMAS效勞器供給的應(yīng)用相對應(yīng)用系統(tǒng)的范疇，并與其它集團客戶應(yīng)用系統(tǒng)共同使用MAS效勞器所供給的接入和移動化支撐功能。接口說明WebService接口業(yè)務(wù)功能集團客戶應(yīng)用系統(tǒng)通過此接口實現(xiàn)短信的收發(fā)和狀態(tài)查詢。集團客戶應(yīng)用系統(tǒng)調(diào)用SendMessage接口發(fā)送短信，OpenMAS接收懇求進展發(fā)送。在提交短信發(fā)送懇求之后，OpenMAS依據(jù)集團客戶預(yù)先注冊的插件主動通知短信發(fā)送狀態(tài)。66/23 短信發(fā)送接口流程說明發(fā)送接口描述：集團客戶應(yīng)用系統(tǒng)在OpenMAS根底組件上注冊〔并登記狀態(tài)報告的接收UR，并在OpenMAS根底組件上生成賬號；集團客戶應(yīng)用系統(tǒng)調(diào)用OpenMAS根底組件的sendMessageOpenMAS接收到短信，然后將短信發(fā)送到短信網(wǎng)關(guān)；OpenMAS接收短信網(wǎng)關(guān)的狀態(tài)報告〔結(jié)果回執(zhí)；OpenMAS依據(jù)注冊的URLNotifySmsDeliveryReport〔帶上回執(zhí)的結(jié)果參數(shù)。集團客戶應(yīng)用系統(tǒng)獵取到具體的狀態(tài)報告信息。77/23調(diào)用方式接口接口接口定義發(fā)起方落地方說明發(fā)送短信SendMessage應(yīng)用系統(tǒng)OpenMAS應(yīng)用系統(tǒng)必需通知發(fā)送狀態(tài)NotifySmsDeliveryStatusOpenMAS應(yīng)用系統(tǒng)提前注冊對應(yīng)插件發(fā)送方法(SendMessage)發(fā)起方：應(yīng)用系統(tǒng)落地方：OpenMas平臺stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessage);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessagestringExtendCode);備注：MessageUTF-8懇求參數(shù)定義ApplicationIDID〔類型：string〕2、Password：應(yīng)用程序發(fā)送短信密碼，用來防止有人惡意仿照顧用程序發(fā)送短信〔類型：string〕3DestinationAddresses：短信接收方號碼，可同時發(fā)多人〔類型：string〕4ExtendCode：由該應(yīng)用填寫的應(yīng)用內(nèi)部擴展號碼?！差愋停簊tring〕Message：短信內(nèi)容〔類型：string〕返回值定義6、返回此次發(fā)送信息的唯一標識符，用于用戶查詢發(fā)送狀態(tài)。(類型：string)狀態(tài)報告方法(NotifySmsDeliveryReport)發(fā)起方：OpenMas平臺落地方：應(yīng)用系統(tǒng)限制條件：應(yīng)用系統(tǒng)必需注冊指定插件voidNotifySmsDeliveryReport(DeliveryReportdeliveryReport);懇求參數(shù)定義deliveryReport：短信發(fā)送狀態(tài)，與發(fā)送懇求數(shù)組一一對應(yīng)〔類型：DeliveryReport〕0Delivered發(fā)送成功。1WaitingForDelivery等待發(fā)送。2WaitingForDeliveryStatus已發(fā)送,等待狀態(tài)報告。0Delivered發(fā)送成功。1WaitingForDelivery等待發(fā)送。2WaitingForDeliveryStatus已發(fā)送,等待狀態(tài)報告。3DeliveryFailed發(fā)送失敗。2ReceivedAddress：接收方地址〔string〕3、StatusCode：狀態(tài)碼，假設(shè)發(fā)送失敗可確定錯誤緣由〔string〕4SendAddress：發(fā)送地址5MessageId：發(fā)送標識返回值定義3、無返回值1010/23短信接收接口接收短信流程說明：流程說明接收短信流程說明：由應(yīng)用系統(tǒng)提前在OpenMAS根底組件注冊插件，并登記用于接收短信的URL；然后OpenMAS根底組件從短信網(wǎng)關(guān)接收短信信息；OpenMAS組件依據(jù)插件注冊時登記的URLURL對應(yīng)的NotifySMS方法；集團客戶應(yīng)用系統(tǒng)收到OpenMAS的調(diào)用，獵取上行短信唯一標識的MessageID；集團客戶應(yīng)用系統(tǒng)調(diào)用OpenMAS組件方法〔GetMessage〕，獵取上行短信的具體內(nèi)容。調(diào)用方式接口接口接口定義發(fā)起方落地方說明上行短信通知上行短信通知NotifySmsOpenMAS應(yīng)用系統(tǒng)應(yīng)用系統(tǒng)必需提前注冊對應(yīng)插件接收短信GetMessage應(yīng)用系統(tǒng)OpenMAS上行短信通知方法(NotifySms)發(fā)起方：OpenMas平臺落地方：應(yīng)用系統(tǒng)voidNotifySms(stringMessageID);懇求參數(shù)定義1、MessageID：上行短信唯一標識，用來獵取信息〔類型：string〕返回值定義2、無返回值接收短信方法(GetMessage)發(fā)起方：應(yīng)用系統(tǒng)落地方：OpenMas平臺SmsMessageGetMessage(stringMessageID);懇求參數(shù)定義1MessageID：上行短信唯一標識〔類型：string〕返回值定義返回指定應(yīng)用程序的上行短信?！差愋停篠msMessage數(shù)組〕,類型說明如下：1Message：短信正文〔string〕2ReceivedAddress：接收方地址〔string〕3SendAddress：發(fā)送方地址〔string〕短信數(shù)據(jù)庫接口集團客戶應(yīng)用系統(tǒng)與OpenMASSQLSERVER2023，同時數(shù)據(jù)庫部署在OpenMAS根底組件側(cè)。業(yè)務(wù)功能集團客戶應(yīng)用系統(tǒng)通過此接口實現(xiàn)短信的收發(fā)和狀態(tài)查詢送短信到數(shù)據(jù)庫，OpenMAS從數(shù)據(jù)庫中獵取待發(fā)短信并進展發(fā)送。在提交短信發(fā)送懇求之后，OpenMAS回寫狀態(tài)報告到短信發(fā)送結(jié)果表。短信發(fā)送接口業(yè)務(wù)流程應(yīng)用系統(tǒng)應(yīng)用系統(tǒng)中間數(shù)據(jù)庫OpenMAS提交短信獵取待發(fā)送短信發(fā)送短信獵取狀態(tài)報告提交狀態(tài)報告獵取狀態(tài)報告流程說明:應(yīng)用系統(tǒng)提交待發(fā)送短信到中間數(shù)據(jù)庫；OpenMAS根底組件定期從中間數(shù)據(jù)庫中獵取待發(fā)送短信；OpenMAS根底組件發(fā)送短信；OpenMAS根底組件獵取短信的狀態(tài)報告；OpenMAS根底組件提交狀態(tài)報告到中間數(shù)據(jù)庫；1212/23 應(yīng)用系統(tǒng)定期從數(shù)據(jù)庫獵取狀態(tài)報告。表構(gòu)造說明短信待發(fā)送表：COM_SmsSent_+擴展號，如：COM_SmsSent_1字段名IDMessageID數(shù)據(jù)類型IntString長度-50必填是是描述主鍵短信編號備注自動生成使用GUIDApplicationIDString40是應(yīng)用程序編號OpenMAS根底組件上注冊的賬號MessageContentString1000否發(fā)送的短信內(nèi)容SendAddressString40是根底接入號ExtendCodeString40否接入號擴展碼DestinationAddressString40是短信接收手機SendTimeDateTime-否短信創(chuàng)立時間默認取當前時間注：短信待發(fā)送表中的數(shù)據(jù)被發(fā)送后，OpenMAS根底組件將自動刪除。短信狀態(tài)報告表：(DELIVRD表示成功)(DELIVRD表示成功)CreateTimeDateTime-是狀態(tài)報告返回時間字段名數(shù)據(jù)類型長度必填描述備注IDApplicationIDIntString-40是是主鍵應(yīng)用程序編號標識字段，自動遞增MessageIDString50是短信編號必需為唯一值SendAddressString40否根底接入號ExtendCodeString40否接入號擴展碼DestinationAddressSendStatusStringInt40-是否短信接收手機短信提交結(jié)果0GatawayStatusString20否短信發(fā)送結(jié)果網(wǎng)關(guān)返回錯誤注：應(yīng)用程序務(wù)必刪除已讀取的狀態(tài)報告，以免表數(shù)據(jù)越來越大影響性能。另外，假設(shè)OpenMAS從短信網(wǎng)關(guān)未獵取到狀態(tài)報告，則短信狀態(tài)報告表中將沒有數(shù)據(jù)。1313/23短信接收接口業(yè)務(wù)流程應(yīng)用系統(tǒng)應(yīng)用系統(tǒng)中間數(shù)據(jù)庫OpenMAS獵取上行短信提交到數(shù)據(jù)庫獵取短信流程說明:OpenMAS根底組件從行業(yè)網(wǎng)關(guān)獵取上行短信；OpenMAS根底組件將上行短信提交到中間數(shù)據(jù)庫；應(yīng)用系統(tǒng)定期從中間數(shù)據(jù)庫獵取上行短信。表構(gòu)造說明短信上行表COM_SmsIn_+擴展碼，如：COM_SmsIn_1字段名數(shù)據(jù)類型長度必填描述備注IDInt-是主鍵遞增MessageIDString50是短信編號必需為唯一值A(chǔ)pplicationIDString40是應(yīng)用程序編號MessageContentString1000否上行的短信內(nèi)容SendAddressString40是上行手機號碼DestinationAddress StringDestinationAddress StringExtendCode StringCreateTime DateTime4040-是否否根底接入號接入號擴展碼上行時間注：應(yīng)用程序務(wù)必刪除已讀取的上行短信，以免表數(shù)據(jù)越來越大影響性能。WebService接口業(yè)務(wù)功能集團客戶應(yīng)用系統(tǒng)通過此接口實現(xiàn)彩信的收發(fā)和狀態(tài)查詢。集團客戶應(yīng)用系統(tǒng)調(diào)用SendMessage接口發(fā)送彩信，OpenMASOpenMAS依據(jù)集團客戶預(yù)先注冊的插件主動通知彩信發(fā)送狀態(tài)。彩信表示標準元素屬性說明<masmms>-元素屬性說明<masmms>-根元素消息體,消滅屢次,并且在content中沒有消滅smil文件,則按挨次顯示,smil文件,smil掌握顯示contentType屬性包括:contentid<content>ContentType:mime內(nèi)容類型contentLocationContentid:smilid,smil,則charset可自行定義.媒體對象的文件名Charset:編碼格式,可選1515/23Content-Type支持格式：TEXT:text/plainXML:text/xmlSMIL:application/smilAMR:audio/amrMIDI:audio/midiGIF:image/gifJPEG:image/jpegWBMP:image/vnd.wap.wbmpPNG:image/pngXml例如：<?xmlversion=“1.0“encoding=“utf-8“?><masmms><contentcontentType=“image/gif“charset=““contentId=“1.gif“contentLocation=“1.gif“>R0lGODlhgACAAPf/ hDjEijV1ELSAAOw==</content><contentcontentType=“text/plain“charset=““contentId=“1.txt“contentLocation=“1.txt“>uafPsreissY=</content><contentcontentType=“application/smil“charset=““contentId=“2.smil“contentLocation=“2.smil“>PHNtaWw+PGhlYWQ+PGxhe eT48L3NtaWw+</content></masmms>假設(shè)Content中沒有SMILlContent在xmlSMIL1717/23 彩信發(fā)送接口流程說明 發(fā)送流程說明：發(fā)集團客戶應(yīng)用系統(tǒng)在OpenMAS根底組件上注冊〔并登記狀態(tài)報告的接收UR，并OpenMAS根底組件上生成賬號；集團客戶應(yīng)用系統(tǒng)調(diào)用OpenMAS根底組件的sendMessageOpenMAS接收到彩信，然后將彩信發(fā)送到彩信網(wǎng)關(guān)；OpenMAS接收彩信網(wǎng)關(guān)的狀態(tài)報告〔結(jié)果回執(zhí)；OpenMASURLNotifyMmsDeliveryReport方法〔帶上回1818/23執(zhí)的結(jié)果參數(shù)。集團客戶應(yīng)用系統(tǒng)獵取到具體的狀態(tài)報告信息。調(diào)用方式接口接口接口定義發(fā)起方落地方說明發(fā)送彩信SendMessage應(yīng)用系統(tǒng)OpenMAS應(yīng)用系統(tǒng)必需提前注冊通知發(fā)送狀態(tài) NotifyMmsDeliveryReportOpenMAS應(yīng)用系統(tǒng)對應(yīng)插件發(fā)送方法(SendMessage)發(fā)起方：應(yīng)用系統(tǒng)落地方：OpenMas平臺stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent,stringExtendCode);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent,stringExtendCode,PriorityPriority);懇求參數(shù)定義ApplicationIDID〔string〕2Password：應(yīng)用程序發(fā)送彩信密碼，用來防止有人惡意發(fā)送彩信〔類型：string〕3DestinationAddresses：彩信接收方號碼，可同時發(fā)多人〔string〕4ExtendCode：由該應(yīng)用填寫的應(yīng)用內(nèi)部擴展號碼。5Subject：主題〔string〕值名稱描述0Default缺省消息優(yōu)先級值名稱描述0Default缺省消息優(yōu)先級11Low低的消息優(yōu)先級2Normal正常的消息優(yōu)先級3High高的消息優(yōu)先級7Contentxml3.2.3〔string〕返回值定義7、返回此次發(fā)送信息的唯一標識符，用于用戶查詢發(fā)送狀態(tài)。類型：string彩信發(fā)送狀態(tài)通知接口〔NotifyDeliveryStatus〕發(fā)起方：OpenMas平臺落地方：應(yīng)用系統(tǒng)限制條件：應(yīng)用系統(tǒng)必需注冊指定插件voidNotifyMmsDeliveryReport(DeliveryReportDeliveryReport);懇求參數(shù)定義1、deliveryReport：彩信發(fā)送狀態(tài)〔見彩信發(fā)送狀態(tài)表〕0Delivered發(fā)送成功。1WaitingForDelivery等待發(fā)送。2WaitingForDeliveryStatus0Delivered發(fā)送成功。1WaitingForDelivery等待發(fā)送。2WaitingForDeliveryStatus已發(fā)送,等待狀態(tài)報告。3DeliveryFailed發(fā)送失敗。ReceivedAddress：接收方地址〔string〕StatusCode：狀態(tài)碼，假設(shè)發(fā)送失敗可確定錯誤緣由〔string〕SendAddress：發(fā)送地址MessageId：發(fā)送標識返回值定義3、無返回值2020/23 彩信接收接口流程說明接收短信流程說明：由應(yīng)用系統(tǒng)提前在OpenMAS根底組件注冊插件，并登記用于