一信通短信接口文檔(共11頁)

1、上海幟訊信息技術(shù)有限公司Page 2012.02一信通企業(yè)(qy)信息服務(wù)平臺接口(ji ku)手冊產(chǎn)品名稱一信通企業(yè)信息服務(wù)平臺接口手冊版本編號2.1.2文檔編號發(fā)布者發(fā)布日期2012-5-10目錄(ml) TOC o 1-3 h z u HYPERLINK l _Toc330475311 一信通企業(yè)(qy)信息服務(wù)平臺 PAGEREF _Toc330475311 h 1 HYPERLINK l _Toc330475312 1.概述(i sh) PAGEREF _Toc330475312 h 3 HYPERLINK l _Toc330475313 1.1編制目的 PAGEREF _Toc33

2、0475313 h 3 HYPERLINK l _Toc330475314 1.2內(nèi)容概述 PAGEREF _Toc330475314 h 3 HYPERLINK l _Toc330475315 1.3名稱解釋 PAGEREF _Toc330475315 h 3 HYPERLINK l _Toc330475316 1.4參考文獻(xiàn) PAGEREF _Toc330475316 h 3 HYPERLINK l _Toc330475317 2.短信 PAGEREF _Toc330475317 h 4 HYPERLINK l _Toc330475319 2.1http接口 PAGEREF _Toc330

3、475319 h 4 HYPERLINK l _Toc330475320 2.1.1消息協(xié)議 PAGEREF _Toc330475320 h 4 HYPERLINK l _Toc330475321 2.1.2發(fā)送短信 PAGEREF _Toc330475321 h 4 HYPERLINK l _Toc330475322 2.1.3回執(zhí)接口 PAGEREF _Toc330475322 h 5 HYPERLINK l _Toc330475323 2.1.4剩余短信條數(shù)查詢 PAGEREF _Toc330475323 h 6 HYPERLINK l _Toc330475324 2.1.5回復(fù)內(nèi)容接口

4、 PAGEREF _Toc330475324 h 7 HYPERLINK l _Toc330475325 2.2Webservice接口 PAGEREF _Toc330475325 h 7 HYPERLINK l _Toc330475326 2.2.1消息協(xié)議 PAGEREF _Toc330475326 h 7 HYPERLINK l _Toc330475327 2.2.2發(fā)送短信 PAGEREF _Toc330475327 h 8 HYPERLINK l _Toc330475328 2.2.3回執(zhí)接口 PAGEREF _Toc330475328 h 9 HYPERLINK l _Toc330

5、475329 2.2.4上行回復(fù)內(nèi)容查詢接口 PAGEREF _Toc330475329 h 10 HYPERLINK l _Toc330475330 2.2.5上行回復(fù)內(nèi)容確認(rèn)接口 PAGEREF _Toc330475330 h 10 HYPERLINK l _Toc330475331 2.2.6內(nèi)容審核 PAGEREF _Toc330475331 h 11修改歷史日期版本作者修改內(nèi)容評審號更改請求號概述(i sh)編制(binzh)目的 該接口文檔手冊編寫(binxi)在于描述易派企業(yè)信息服務(wù)平臺UMS（以下簡稱UMS）具體的接口協(xié)議，供第三方系統(tǒng)能夠順利接入一信通短信網(wǎng)關(guān)。內(nèi)容概述 本規(guī)

6、范主要講了第三方系統(tǒng)接入短信通系統(tǒng)的協(xié)議要求，協(xié)議三大狀態(tài)和協(xié)議指令的格式和響應(yīng)信息。名稱解釋縮略語英文全名中文全名UMSUnified Message Service一信通SMSShort Messaging Service短消息服務(wù)APIApplication Proframming Interface應(yīng)用程序編程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider服務(wù)提供商CPContent Provider內(nèi)容提供商參考文獻(xiàn)短信http接口(ji ku)消息(xio xi)協(xié)議接口(ji ku)地址： HYPE

7、RLINK :8899/sms/Api/ :8899/sms/Api/通過接口提交參數(shù)時(shí), 參數(shù)內(nèi)容必須為GB2312 編碼, 且經(jīng)過url編碼后的內(nèi)容。例如:“您好”的url編碼為“%C4%FA%BA%C3”接口返回的內(nèi)容是一些鍵值對的字符串集合，形式為:“k1=v1&k2=v2&k3=v3”返回內(nèi)容中的鍵值顯示為url編碼形式, 經(jīng)過url解碼后的鍵值是GB2312編碼的字符串。例如: 返回內(nèi)容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的實(shí)際內(nèi)容為“result=0&description=發(fā)送成功&faillis

8、t=”發(fā)送短信功能描述：短信發(fā)送調(diào)用格式： 對 HYPERLINK :8899/sms/Api/Send.do進(jìn)行post :8899/sms/Api/Send.do進(jìn)行post返回格式: result=&description=錯(cuò)誤描述&faillist=失敗號碼列表post參數(shù)說明：類別參數(shù)名稱類型說明輸入SpCodestring企業(yè)編號輸入LoginNamestring用戶名稱輸入Passwordstring用戶密碼輸入MessageContentstring短信內(nèi)容, 最大700個(gè)字符輸入U(xiǎn)serNumberstring手機(jī)號碼(多個(gè)號碼用”,”分隔)，最多1000個(gè)號碼輸入Seria

9、lNumberstring流水號，20位數(shù)字，唯一 輸入ScheduleTimestring預(yù)約發(fā)送時(shí)間，格式:yyyyMMddhhmmss,如20090901010101，立即發(fā)送請?zhí)羁蛰斎雈string提交時(shí)檢測方式1 提交號碼中有效的號碼仍正常發(fā)出短信，無效的號碼在返回參數(shù)faillist中列出不為1 或該參數(shù)不存在 提交號碼中只要有無效的號碼，那么所有的號碼都不發(fā)出短信，所有的號碼在返回參數(shù)faillist中列出返回值：返回值錯(cuò)誤描述0發(fā)送短信成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯(cuò)誤,4預(yù)約發(fā)送時(shí)間無效5IP不合法,6號碼中含有無效號碼或不在規(guī)定的號段,7內(nèi)容中含有非法關(guān)鍵字、

10、審核不通過、人工審核等8內(nèi)容長度超過上限，最大402字符9接受號碼過多，最大100010黑名單用戶11提交速度太快12您尚未訂購普通短信業(yè)務(wù)，暫不能發(fā)送該類信息13您的普通短信業(yè)務(wù)剩余數(shù)量發(fā)送不足，暫不能發(fā)送該類信息14流水號格式不正確15流水號重復(fù)16超出發(fā)送上限17余額不足18扣費(fèi)不成功20系統(tǒng)錯(cuò)誤21您只能發(fā)送聯(lián)通的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非聯(lián)通的手機(jī)號碼22您只能發(fā)送移動(dòng)的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非移動(dòng)的手機(jī)號碼23您只能發(fā)送電信的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非電信的手機(jī)號碼實(shí)際(shj)返回內(nèi)容為“result=0&description=發(fā)送(f s

11、n)成功”回執(zhí)(huzh)接口功能描述：短信回執(zhí)調(diào)用方式：ftp返回格式:文本文件ftp服務(wù)信息：參數(shù)名稱說明ftp地址端口21返回(fnhu)文本文件格式:文件名: arrive_000139_25288_0000000000000000000f_201107071556一行(yxng)內(nèi)容：SPID=197258 MESSAGEID=910320f1 ID=2432901361 CALLMDN=106550270102501 MDNRESULT=0 DESC=DELIVRD ARRIVE_TIME=20110707155402Java解析(ji x)這行的方法/

12、解析一行記錄public static Properties parse(String line) String parsePattern=(=t+)=(t*);Matcher m = Ppile(parsePattern).matcher(line);Properties result = new Properties();while (m.find() String key = m.group(1).trim();String value = m.group(2).trim();result.put(key.toUpperCase(), value);return result;如果要獲取

13、取接受短信的號碼則使用：String mdn= (String)result.get(MDN);即可其他字段類似方式剩余短信條數(shù)查詢功能描述：剩余短信條數(shù)查詢接口調(diào)用格式： 對 HYPERLINK :8899/sms/Api/SearchNumber.do進(jìn)行post :8899/sms/Api/SearchNumber.do進(jìn)行post返回格式: result=&description=錯(cuò)誤描述&faillist=失敗號碼列表post參數(shù)說明：類別參數(shù)名稱類型說明輸入SpCodestring企業(yè)編號輸入LoginNamestring用戶名稱輸入Passwordstring用戶密碼返回值:返回

14、值錯(cuò)誤描述0發(fā)送短信成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯(cuò)誤,5IP不合法,20系統(tǒng)錯(cuò)誤回復(fù)(huf)內(nèi)容接口功能(gngnng)描述：將上行回復(fù)的內(nèi)容通過(tnggu)http協(xié)議進(jìn)行post到企業(yè)方調(diào)用格式： url由企業(yè)方提供，然后對該url進(jìn)行post,post的格式為xml,格式如下： 1861633031810690067111111回復(fù)內(nèi)容測試2012-01-01 00:00:00返回格式: 返回格式為xml,格式如下：0post參數(shù)說明：類別參數(shù)名稱類型說明輸入mdnstring手機(jī)號碼輸入callmdn接入號輸入msgstring回復(fù)內(nèi)容輸入replytimestri

15、ng回復(fù)時(shí)間返回值:返回值錯(cuò)誤描述0接收成功Webservice接口消息協(xié)議接口地址： HYPERLINK :8899/sms_hb/services/Sms?wsdl :8899/sms_hb/services/Sms?wsdl發(fā)送(f sn)短信功能(gngnng)描述：短信發(fā)送(f sn)調(diào)用格式： 利用webservice客戶端進(jìn)行http請求返回格式: SmsResponseSmsRequest請求參數(shù)說明：類別參數(shù)名稱類型說明輸入In0string企業(yè)編號輸入In1string用戶名稱輸入In2string用戶密碼輸入In3string短信內(nèi)容, 最大402個(gè)字符輸入In4stri

16、ng手機(jī)號碼(多個(gè)號碼用”,”分隔)，最多1000個(gè)號碼輸入In5string流水號，20位數(shù)字，唯一 輸入In6string預(yù)約發(fā)送時(shí)間，格式:yyyyMMddhhmmss,如20090901010101， 立即發(fā)送請?zhí)羁蛰斎隝n7string提交時(shí)檢測方式1 提交號碼中有效的號碼仍正常發(fā)出短信，無效的號碼在返回參數(shù)faillist中列出不為1 或該參數(shù)不存在 提交號碼中只要有無效的號碼，那么所有的號碼都不發(fā)出短信，所有的號碼在返回參數(shù)faillist中列出輸入In8string保留SmsResponse返回值: 返回值錯(cuò)誤描述0發(fā)送短信成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯(cuò)誤,4預(yù)

17、約發(fā)送時(shí)間無效5IP不合法,6號碼中含有無效號碼或不在規(guī)定的號段,7內(nèi)容中含有非法關(guān)鍵字、審核不通過、人工審核等8內(nèi)容長度超過上限，最大402字符9接受號碼過多，最大100010黑名單用戶11提交速度太快12您尚未訂購普通短信業(yè)務(wù)，暫不能發(fā)送該類信息13您的普通短信業(yè)務(wù)剩余數(shù)量發(fā)送不足，暫不能發(fā)送該類信息14流水號格式不正確15流水號重復(fù)16超出發(fā)送上限17余額不足18扣費(fèi)不成功20系統(tǒng)錯(cuò)誤21您只能發(fā)送聯(lián)通的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非聯(lián)通的手機(jī)號碼22您只能發(fā)送移動(dòng)的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非移動(dòng)的手機(jī)號碼23您只能發(fā)送電信的手機(jī)號碼，本次發(fā)送的手機(jī)號碼中包含了非電信

18、的手機(jī)號碼實(shí)際(shj)返回(fnhu)內(nèi)容(nirng)為“result=0&description=發(fā)送成功”回執(zhí)接口功能描述：短信回執(zhí)調(diào)用方式：利用webservice客戶端進(jìn)行http請求返回格式: ReportResponseReportRequest請求參數(shù)說明：類別參數(shù)名稱類型說明輸入In0string企業(yè)編號輸入In1string用戶名稱輸入In2string用戶密碼ReportResponse返回值: 類別參數(shù)名稱類型說明輸入outstring回執(zhí)結(jié)果，每條回執(zhí)按分號隔開，每個(gè)字段按逗號隔開，每條回執(zhí)共包含3個(gè)字段，第1個(gè)字段為流水號，第2個(gè)字段為被發(fā)送的手機(jī)號碼，第3個(gè)字段

19、為回執(zhí)結(jié)果，0表示成功，其他值表示失敗實(shí)際返回內(nèi)容為“000000000000000000010; 000000000000000000010;000000000000000000010;”上行回復(fù)內(nèi)容查詢接口功能描述：上行回復(fù)內(nèi)容查詢調(diào)用方式：利用webservice客戶端進(jìn)行http請求返回格式: ReplyResponseReplyRequest請求參數(shù)說明：類別參數(shù)名稱類型說明輸入In0string企業(yè)編號輸入In1string用戶名稱輸入In2string用戶密碼ReplyResponse返回值: 類別參數(shù)名稱類型說明輸出resultstring返回碼輸出confirm_timestring回復(fù)時(shí)間，格式y(tǒng)yyy-MM-dd HH:mm:ss輸出replysreply數(shù)組多個(gè)relpy對象組成返回值錯(cuò)誤描述0成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯(cuò)誤,20系統(tǒng)錯(cuò)誤reply的屬性(shxng)值類別參數(shù)名稱類型說明輸出callMdnstring接入號輸出mdnstring用戶手機(jī)號輸出messagestring回復(fù)內(nèi)容輸出reply_timestring回復(fù)時(shí)間，格式y(tǒng)yyy-MM-dd HH:mm:ss上行回復(fù)