行業(yè)移動(dòng)平臺(tái)組件接口設(shè)計(jì)說明書

1、移動(dòng)平臺(tái)接口設(shè)計(jì)說明書1. 概述1.1. 文檔概述本文檔描述了短信平臺(tái)與第三方it系統(tǒng)交互的短信接口。1.2. 術(shù)語定義和縮略語縮寫詞英文解析中文解析crmcustomer relationship managerment客戶資源管理erpenterprise resource planning企業(yè)資源規(guī)劃ftpfile transfer protocol文件傳輸協(xié)議gprsgeneral packet radio service通用無線分組業(yè)務(wù)httphypertext transfer protocol超文本傳輸協(xié)議httpssecure http加密的http協(xié)議soapsimple o

2、bject access protocol簡單對(duì)象訪問協(xié)議oaoffice automation辦公自動(dòng)化2. 接口說明2.1. 短消息接口2.1.1. 接口說明第三方it系統(tǒng)通過此接口收發(fā)短消息。webservice方式通信收到第三方it系統(tǒng)的發(fā)送請(qǐng)求后，通過短信平臺(tái)中的sms通信協(xié)議模塊發(fā)送sms；當(dāng)從sms通信協(xié)議模塊收到sms后，通過此接口將短消息發(fā)送給第三方it系統(tǒng)。2.1.2. 流程說明短消息接口包括發(fā)送和接收兩個(gè)流程。圖1-1 短消息發(fā)送流程示意圖發(fā)送短信由第三方it系統(tǒng)發(fā)起，通過sendsms操作實(shí)現(xiàn)。在提交短信發(fā)送請(qǐng)求之后，第三方it系統(tǒng)可以主動(dòng)獲取短信發(fā)送狀態(tài)（getsms

3、deliverystatus操作），或由短信平臺(tái)調(diào)用接口通知第三方it系統(tǒng)發(fā)送狀態(tài)（notifysmsdeliverystatus操作）。圖1-2 短消息接收流程示意圖接收短信可以通過兩種方式，一種是由第三方it系統(tǒng)發(fā)起（getreceivedsms操作），然后短信平臺(tái)將所接收到的短信發(fā)往該第三方it系統(tǒng)；第二種是由第三方it系統(tǒng)提前注冊接口，然后短信平臺(tái)調(diào)用接口(notifysmsreceptions)通知第三方it系統(tǒng)接有上行短信(無特殊要求目前采用第一種方式)2.1.3. 數(shù)據(jù)類型定義. 短信實(shí)體(smsmessage)定義1、 message：短信正文（string）2、

4、 receivedaddress：接收方地址（string）3、 sendaddress：發(fā)送方地址（string）4、 messageformat:編碼格式(int)5、 channelid:通道編號(hào). 短信發(fā)送狀態(tài)(deliverystatus)定義枚舉值參數(shù)描述0delivered發(fā)送成功。1waitingfordelivery等待發(fā)送。2waitingfordeliverystatus已發(fā)送,等待狀態(tài)報(bào)告。3deliveryfailed發(fā)送失敗。. 短信發(fā)送狀態(tài)實(shí)體(deliveryinformation)定義1、 deliverystatus：發(fā)送狀態(tài)（d

5、eliverystatus）2、 receivedaddress：接收方地址（string）3、statuscode：狀態(tài)碼，如果發(fā)送失敗可確定錯(cuò)誤原因（string）2.1.4. 短信發(fā)送接口. 調(diào)用方式：接口接口定義發(fā)起方落地方說明發(fā)送短信sendsms第三方it系統(tǒng)短信平臺(tái)發(fā)送文件sendfile第三方it系統(tǒng)短信平臺(tái)發(fā)送之前文件必須通過ftp 上傳到短信平臺(tái)上,文件可重復(fù)使用.發(fā)送點(diǎn)點(diǎn)通文件sendppfile第三方it系統(tǒng)短信平臺(tái)發(fā)送之前文件必須通過ftp 上傳到短信平臺(tái)上,文件可重復(fù)使用.獲取發(fā)送狀態(tài)getsmsdeliverystatus第三方it系統(tǒng)短信平臺(tái)通知發(fā)

6、送狀態(tài)notifysmsdeliverystatus短信平臺(tái)第三方it系統(tǒng)第三方it系統(tǒng)必須提前注冊對(duì)應(yīng)的接口. 接口定義.1. 發(fā)送短信接口(sendsms)發(fā)起方：第三方it系統(tǒng)落地方：短信平臺(tái)string sendsms(string operatorid,string password,string destinationaddresses, string message,string wappushurl,int messageformat,int sendmethod,string extendcode,bool deliveryresultreques

7、t,string channelid)備注： .1.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述operatoridxsd:stringm操作員idpasswordxsd:stringm操作員密碼destinationaddressesxsd:string m短消息要被發(fā)送到的地址。多個(gè)號(hào)碼以”,”隔開。extendcodexsd:stringo內(nèi)部擴(kuò)展號(hào)碼。messagexsd:stringm在短消息中發(fā)送的文本。為十六進(jìn)制字符串wappushurlxsd:stringo發(fā)送wappush地址,當(dāng)messageformat=15，sendmethod=3時(shí)有效messageformat

8、xsd:intm消息編碼類型。0:ascii4:binary8:ucs215:含gb漢字sendmethodxsd:intm發(fā)送消息選項(xiàng)。0:普通短信1:閃電短信2:長短信3:wap pushdeliveryresultrequestxsd:booleano指示是否需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。true表示需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告，false表示不需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。channelidxsd:string0短信通道id,由短信平臺(tái)指定,如果有多個(gè)短信通道,第三方it系統(tǒng)可以指定使用某個(gè)短信通道.1.2. 返回值定義1、 成功則返回此次發(fā)送信息的唯一標(biāo)識(shí)符，用于用戶查詢發(fā)送

9、狀態(tài)。2、 如果調(diào)用失敗,則返回錯(cuò)誤代碼.2. 發(fā)送文件接口(sendfile)發(fā)起方：第三方it系統(tǒng)落地方：短信平臺(tái) string sendfile(string operatorid,string password,string filename, string message,string wappushurl,int messageformat,int sendmethod,string extendcode,bool deliveryresultrequest,string channelid).2.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述operatorid

10、xsd:stringm操作員idpasswordxsd:stringm操作員密碼filenamexsd:string m號(hào)碼文件名。通過ftp 上傳到短信平臺(tái)上,文件可重復(fù)使用.上傳文件須是每行為一個(gè)手機(jī)號(hào)碼的txt文件extendcodexsd:stringo內(nèi)部擴(kuò)展號(hào)碼。messagexsd:stringm在短消息中發(fā)送的文本。十六進(jìn)制字符串標(biāo)示wappushurlxsd:stringo發(fā)送wappush地址,當(dāng)messageformat=15，sendmethod=3時(shí)有效messageformatxsd:intm消息編碼類型。0:ascii4:binary8:ucs215:含gb漢字s

11、endmethodxsd:intm發(fā)送消息選項(xiàng)。0:普通短信1:閃電短信2:長短信3:wap pushdeliveryresultrequestxsd:booleano指示是否需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。true表示需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告，false表示不需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。channelidxsd:string0短信通道id,由短信平臺(tái)指定,如果有多個(gè)短信通道,第三方it系統(tǒng)可以指定使用某個(gè)短信通道.2.2. 返回值定義1、 成功則返回此次發(fā)送信息的唯一標(biāo)識(shí)符，用于用戶查詢發(fā)送狀態(tài)2、 如果調(diào)用失敗,則返回錯(cuò)誤代碼.3. 發(fā)送點(diǎn)點(diǎn)通文件接口發(fā)起方：第三

12、方it系統(tǒng)落地方：短信平臺(tái)string sendppfile(string operatorid,string password,string filename,string wappushurl,int messageformat,int sendmethod,string extendcode,bool deliveryresultrequest,string channelid).3.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述operatoridxsd:stringm操作員idpasswordxsd:stringm操作員密碼filenamexsd:string m號(hào)碼文件名。通過

13、ftp 上傳到短信平臺(tái)上,文件可重復(fù)使用.上傳文件的類型必須是txt文本文件、excel文件和csv文件。文本文件每行格式為:手機(jī)號(hào)碼 短信內(nèi)容;csv文件每行格式為:手機(jī)號(hào)碼,短信內(nèi)容;excel文件每行的格式為:第一列是手機(jī)號(hào)碼 第二列是短信內(nèi)容。extendcodexsd:stringo內(nèi)部擴(kuò)展號(hào)碼。messageformatxsd:intm消息編碼類型。0:ascii4:binary8:ucs215:含gb漢字sendmethodxsd:intm發(fā)送消息選項(xiàng)。0:普通短信1:閃電短信2:長短信3:wap pushdeliveryresultrequestxsd:booleano指示是否

14、需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。true表示需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告，false表示不需要網(wǎng)絡(luò)側(cè)返回遞交狀態(tài)報(bào)告。channelidxsd:string0短信通道id,由短信平臺(tái)指定,如果有多個(gè)短信通道,第三方it系統(tǒng)可以指定使用某個(gè)短信通道.3.2. 返回值定義1、 成功則返回此次發(fā)送信息的唯一標(biāo)識(shí)符，用于用戶查詢發(fā)送狀態(tài)2、 如果調(diào)用失敗,則返回錯(cuò)誤代碼.4. 查詢短信發(fā)送狀態(tài)接口(getsmsdeliverystatus)發(fā)起方：第三方it系統(tǒng)落地方：短信平臺(tái)deliveryinformation getsmsdeliverystatus(string oper

15、atorid,string password, string requestidentifier);.4.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述operatoridxsd:stringm操作員idpasswordxsd:stringm操作員密碼requestidentifierxsd:stringm發(fā)送短信時(shí),由短信平臺(tái)分配的請(qǐng)求標(biāo)示.4.2. 返回值定義1、 返回發(fā)送狀態(tài)列表。（類型：deliveryinformation數(shù)組）.5. 短信發(fā)送狀態(tài)通知接口(notifysmsdeliverystatus)發(fā)起方：短信平臺(tái)平臺(tái)落地方：第三方it系統(tǒng)限制條

16、件：第三方it系統(tǒng)必須注冊接口void notifysmsdeliverystatus(string requestidentifier,deliveryinformation deliverystatus);.5.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述requestidentifierxsd:stringm標(biāo)識(shí)一個(gè)短消息發(fā)送請(qǐng)求。deliveryinformationdeliveryinformationm短消息遞交狀態(tài)參數(shù)。.5.2. 返回值定義1、 無返回值2.1.5. 短信接收接口. 調(diào)用方式：接口接口定義發(fā)起方落地方說明接收短信getrecei

17、ved第三方it系統(tǒng)短信平臺(tái)上行短信通知notifysmsreception短信平臺(tái)第三方it系統(tǒng)第三方it系統(tǒng)必須提前注冊對(duì)應(yīng)接口. 接口定義.1. 接收短信接口（getreceived）發(fā)起方：第三方it系統(tǒng)落地方：短信平臺(tái)smsmessage getreceived(string operatorid,string password, string extcode, string channelid);.1.1. 請(qǐng)求參數(shù)定義參數(shù)類型可選性描述operatoridxsd:stringm操作員idpasswordxsd:stringm操作員密碼extcodexsd:stringo擴(kuò)展碼channelidxsd:st