一信通接口規(guī)范江蘇樣本_第1頁
一信通接口規(guī)范江蘇樣本_第2頁
一信通接口規(guī)范江蘇樣本_第3頁
一信通接口規(guī)范江蘇樣本_第4頁
一信通接口規(guī)范江蘇樣本_第5頁
已閱讀5頁,還剩17頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

一信通平臺能力接口規(guī)范UMSFundamentalServiceAPIGuide中華人民共和國聯(lián)通-04-08目錄1. 前言 41.1 文檔概述 41.2 合用范疇 41.3 縮略詞典 41.4 注意事項 42. 短信接口定義 52.1 HTTP接口 52.1.1 消息合同 52.1.2 發(fā)送短信 52.1.3 回執(zhí)接口 72.1.4 剩余短信條數(shù)查詢 72.1.5 上行回答內容查詢接口 82.1.6 上行回答內容確認接口 92.2 WebService接口 92.2.1 消息合同 92.2.2 發(fā)送短信 92.2.3 回執(zhí)接口 112.2.4 上行回答內容查詢接口 112.2.5 上行回答內容確認接口 122.2.6 內容審核 132.3 Socket接口 142.3.1 通信方式 142.3.2 消息定義 152.3.3 常量定義 20HISTORY 21

前言文檔概述本規(guī)范重要講了第三方應用系統(tǒng)接入一信通平臺合同規(guī)定,合同三大狀態(tài)和合同指令格式和響應信息。合用范疇本規(guī)范描述一信通平臺(如下簡稱UMS)詳細接口合同,供第三方應用系統(tǒng)可以順利接入一信通短信網關。縮略詞典UMS UnifiedMessageSystemAPI ApplicationProgrammingInterfaceCP ContentProviderMO MessageOriginal消息上行MT MessageTerminal消息下行SMS ShortMessageServiceSP ServiceProvider注意事項指公司使用業(yè)務時登錄門戶地址,如

短信接口定義測試帳戶測試模板:您驗證碼為{xxxxxxxx}發(fā)送示例:您驗證碼為123456HTTP接口采用GB2312編碼消息合同接口地址::8899/sms/Api/發(fā)送短信功能描述:短信發(fā)送調用格式:對:8899/sms/Api/Send.do進行post返回格式:result=&description=錯誤描述&faillist=失敗號碼列表POST參數(shù)闡明:類別參數(shù)名稱類型闡明輸入SpCodestring公司編號輸入LoginNamestring顧客名稱輸入Passwordstring顧客密碼輸入MessageContentstring短信內容,最大1000個字符(短信內容規(guī)定編碼為gb2312或gbk)輸入UserNumberstring手機號碼(各種號碼用”,”分隔),最多1000個號碼輸入SerialNumberstring流水號,20位數(shù)字,唯一(規(guī)則自定義,建議時間格式精準到毫秒)輸入ScheduleTimestring預約發(fā)送時間,格式:yyyyMMddhhmmss,如‘01’,及時發(fā)送請?zhí)羁眨A約時間要寫當前時間5分鐘之后時間,若預約時間少于5分鐘,則即時發(fā)送)輸入ExtendAccessNumstring接入號擴展號(默認不填,擴展號為數(shù)字,擴展位數(shù)由當前所配接入號長度決定,整個接入號最長20位)輸入fstring提交時檢測方式1提交號碼中有效號碼仍正常發(fā)出短信,無效號碼在返回參數(shù)faillist中列出不為1或該參數(shù)不存在提交號碼中只要有無效號碼,那么所有號碼都不發(fā)出短信,所有號碼在返回參數(shù)faillist中列出GET::8899/sms/Api/Send.do?SpCode=000001

&LoginName=admin&Password=admin&MessageContent=短信內容&UserNumber=&SerialNumber=&ScheduleTime=&f=1返回值:返回值錯誤描述0發(fā)送短信成功1提交參數(shù)不能為空2賬號無效或權限局限性3賬號密碼錯誤,4預約發(fā)送時間格式不對的,應為yyyyMMddHHmmss5IP不合法,6號碼中具有無效號碼或不在規(guī)定號段或為免打擾號碼7非法核心字8內容長度超過上限,最大402字符9接受號碼過多,最大100010黑名單顧客11提交速度太快12您尚未訂購[普通短信業(yè)務],暫不能發(fā)送該類信息13您[普通短信業(yè)務]剩余數(shù)量發(fā)送局限性,暫不能發(fā)送該類信息14流水號格式不對的15流水號重復16超過發(fā)送上限(操作員帳戶當天發(fā)送上限)17余額局限性18扣費不成功20系統(tǒng)錯誤21密碼錯誤次數(shù)達到5次24帳戶狀態(tài)不正常25賬戶權限局限性26需要人工審核28發(fā)送內容與模板不符29擴展號太長或不是數(shù)字&accnum=32同一號碼相似內容發(fā)送次數(shù)太多實際返回內容為“result=&description=錯誤描述&faillist=失敗號碼列表”回執(zhí)接口HTTP接口功能描述:公司方通過調用http回執(zhí)接口獲取短信回執(zhí)信息。調用格式::8899/sms/Api/report.dopost參數(shù)闡明:類別參數(shù)名稱類型闡明輸入SpCodestring公司編號輸入LoginNamestring顧客名稱輸入Passwordstring顧客密碼返回成果參數(shù)闡明:類別參數(shù)名稱類型闡明輸入outstring回執(zhí)成果,每條回執(zhí)按分號隔開,每個字段按逗號隔開,每條回執(zhí)共包括3個字段,第1個字段為流水號,第2個字段為被發(fā)送手機號碼,第3個字段為回執(zhí)成果,0表達到功,其她值表達失敗實際返回內容為“00000001,,0;00000001,,0;00000001,,0;”注:回執(zhí)信息在接口收到后只保存6個小時,6小時后將會清除,建議查詢頻次1分鐘,接口單次查詢返回回執(zhí)條數(shù)為100.2剩余短信條數(shù)查詢功能描述:剩余短信條數(shù)查詢接口調用格式:對:8899/sms/Api/SearchNumber.do進行post返回格式:result=0&description=剩余條數(shù)(涉及套內和可超發(fā)條數(shù))&number=條數(shù)post參數(shù)闡明:類別參數(shù)名稱類型闡明輸入SpCodestring公司編號輸入LoginNamestring顧客名稱輸入Passwordstring顧客密碼返回值:返回值錯誤描述0查詢剩余條數(shù)成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯誤,5IP不合法,20系統(tǒng)錯誤上行回答內容查詢接口功能描述:短信上行回答查詢調用格式:對:8899/sms/Api/reply.do進行postPOST參數(shù)闡明:類別參數(shù)名稱類型闡明輸入SpCodestring公司編號輸入LoginNamestring顧客名稱輸入Passwordstring顧客密碼返回值錯誤描述0成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯誤,20系統(tǒng)錯誤reply屬性值:類別參數(shù)名稱類型闡明輸出mdnstring手機號碼輸出callmdn接入號輸出contentstring回答內容輸出reply_timestring回答時間,格式y(tǒng)yyy-MM-ddHH:mm:ss輸出idstring回答id編號:8899/sms/Api/reply.do?SpCode=000001&LoginName=admin&Password=admin注:執(zhí)行此接口必要以本次查詢到最后一條回答信息所相應ID來同步執(zhí)行2.1.5中上行內容確認接口,否則您是無法查詢到新回答信息。上行回答內容確認接口功能描述:短信上行回答查詢調用格式:對:8899/sms/Api/replyConfirm.do進行postPOST參數(shù)闡明:類別參數(shù)名稱類型闡明輸入SpCodestring公司編號輸入LoginNamestring顧客名稱輸入Passwordstring顧客密碼輸入idstring上次查詢返回最后一條回答id號返回值錯誤描述0成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯誤,20系統(tǒng)錯誤:8899/sms/Api/replyConfirm.do?SpCode=000001&LoginName=admin&Password=admin&id=211128WebService接口消息合同接口地址::8899/sms_hb/services/Sms?wsdl發(fā)送短信功能描述:短信發(fā)送調用格式:運用WebService客戶端進行HTTP祈求SMS辦法返回格式:SmsResponseSmsRequest祈求參數(shù)闡明:類別參數(shù)名稱類型闡明輸入In0string公司編號輸入In1string顧客名稱輸入In2string顧客密碼輸入In3string短信內容,最大402個字符輸入In4string手機號碼(各種號碼用”,”分隔),最多1000個號碼輸入In5string流水號,20位數(shù)字,唯一(規(guī)則自定義,建議時間格式精準到毫秒)輸入In6string預約發(fā)送時間,格式:yyyyMMddhhmmss,如‘01’,及時發(fā)送請?zhí)羁蛰斎隝n7string提交時檢測方式1提交號碼中有效號碼仍正常發(fā)出短信,無效號碼在返回參數(shù)faillist中列出不為1或該參數(shù)不存在提交號碼中只要有無效號碼,那么所有號碼都不發(fā)出短信,所有號碼在返回參數(shù)faillist中列出輸入In8string保存(空值)輸入In9string接入號擴展號(默認不填,擴展號為數(shù)字,擴展位數(shù)由當前所配接入號長度決定,整個接入號最長20位)輸入In10string保存(空值)SmsResponse返回值:返回值錯誤描述0發(fā)送短信成功1提交參數(shù)不能為空2賬號無效或未開戶3賬號密碼錯誤,4預約發(fā)送時間格式不對的,應為yyyyMMddHHmmss5IP不合法,6號碼中具有無效號碼或不在規(guī)定號段,7非法核心字8內容長度超過上限,最大402字符9接受號碼過多,最大100011提交速度太快12您尚未訂購[普通短信業(yè)務],暫不能發(fā)送該類信息13您[普通短信業(yè)務]剩余數(shù)量發(fā)送局限性,暫不能發(fā)送該類信息14流水號格式不對的15流水號重復16超過發(fā)送上限(操作員帳戶當天發(fā)送上限)17余額局限性18扣費不成功20發(fā)送失敗24賬戶狀態(tài)不正常25賬戶權限局限性26需要人工審核28發(fā)送內容與模板不符29擴展號太長或不是數(shù)字&accnum=32同一號碼相似內容發(fā)送次數(shù)太多實際返回內容為“result=0&description=發(fā)送成功&faillist=”回執(zhí)接口功能描述:短信回執(zhí)調用方式:運用WebService客戶端進行HTTP祈求report辦法返回格式:ReportResponseReportRequest祈求參數(shù)闡明:類別參數(shù)名稱類型闡明輸入In0string公司編號輸入In1string顧客名稱輸入In2string顧客密碼ReportResponse返回值:類別參數(shù)名稱類型闡明輸入outstring回執(zhí)成果,每條回執(zhí)按分號隔開,每個字段按逗號隔開,每條回執(zhí)共包括3個字段,第1個字段為流水號,第2個字段為被發(fā)送手機號碼,第3個字段為回執(zhí)成果,0表達到功,其她值表達失敗實際返回內容為“00000001,,0;00000001,,0;00000001,,0;”注:回執(zhí)信息在接口收到后只保存6個小時,6小時后將會清除,建議查詢頻次1分鐘,接口單次查詢返回回執(zhí)條數(shù)為1000.上行回答內容查詢接口功能描述:上行回答內容查詢調用方式:運用webservice客戶端進行http祈求reply辦法返回格式:ReplyResponseReplyRequest祈求參數(shù)闡明:類別參數(shù)名稱類型闡明輸入In0string公司編號輸入In1string顧客名稱輸入In2string顧客密碼輸入In3string保存(空值)ReplyResponse返回值:類別參數(shù)名稱類型闡明輸出resultstring返回碼輸出confirm_timestring回答時間,格式y(tǒng)yyy-MM-ddHH:mm:ss輸出replysreply數(shù)組各種relpy對象構成輸出IdString最后一條回答信息ID返回值錯誤描述0成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯誤,20系統(tǒng)錯誤reply屬性值:類別參數(shù)名稱類型闡明輸出callMdnstring接入號輸出mdnstring顧客手機號輸出messagestring回答內容輸出reply_timestring回答時間,格式y(tǒng)yyy-MM-ddHH:mm:ss注:執(zhí)行此接口必要以本次查詢到最后一條回答信息所相應ID來同步執(zhí)行2.2.5中上行內容確認接口,否則您是無法查詢到新回答信息。上行回答內容確認接口功能描述:上行回答內容查詢調用方式:運用webservice客戶端進行http祈求replyConfirm辦法返回格式:ReplyConfirmResponseReplyConfirmRequest祈求參數(shù)闡明:類別參數(shù)名稱類型闡明輸入In0string公司編號輸入In1string顧客名稱輸入In2string顧客密碼輸入In3string保存(空值)輸入In4string最后一條回答信息idReplyConfirmResponse返回值:類別參數(shù)名稱類型闡明輸出resultstring返回碼返回值錯誤描述0成功1提交參數(shù)不能為空2賬號無效,3賬號密碼錯誤,4時間格式不對的,格式為:yyyy-MM-ddHH:mm:ss20系統(tǒng)錯誤Socket接口通信方式SP和SMG之間通信由客戶端向服務器端發(fā)起連接。連接建立后來,由客戶端向服務器端發(fā)送命令,服務器端必要對接受到每一條命令返回一條應答消息。SP和SMG互為客戶端和服務器端。通信初始化客戶端有命令要向服務器端發(fā)送時,由客戶端一方面通過Bind命令向服務器端發(fā)起連接。服務器端依照Bind命令之中登錄名和密碼,對客戶端合法性進行驗證,然后返回一條Bind_Resp應答給客戶端。如果驗證通過,則客戶端和服務器端通信開始,否則中斷連接。通信過程短信發(fā)送客戶端與服務端之間發(fā)送任何一條命令都帶有一種序列號,序列號由命令源產生??蛻舳伺c服務器端通信開始后來,客戶端可以向服務器端發(fā)送相應命令,服務器端對收到命令返回應答。圖SP和SMG通信消息樣例(SP為客戶端)圖SP和SMG通信消息樣例(SMG為客戶端)命令在客戶端和服務器之間傳播是采用類似接力方式,每條命令和相應應答僅僅表達該次命令發(fā)送成果與否對的。例如,客戶端向某一種手機發(fā)送一條短消息,是通過向本地服務器端發(fā)送一條Submit命令實現(xiàn),隨后,客戶端會從服務器端接受到一條Submit_Resp應答。但是,雖然應答表達Submit命令已對的接受,也不表達Submit命令內短消息已經發(fā)送到手機上了,而僅僅表達該短消息已經傳送到服務器端,服務器端將會作下一步解決,或者發(fā)送給SMSC,或者路由到此外服務器端,最后由目SMSC發(fā)送到手機上。這中間任何一種環(huán)節(jié)浮現(xiàn)錯誤,系統(tǒng)會終結信息繼續(xù)發(fā)送,并且通過向原客戶端發(fā)送Report命令告訴發(fā)送出錯因素(如果SP指定規(guī)定反饋話)。通信結束如果客戶端以為和服務器端通信已結束,則客戶端應當向服務器端發(fā)送Unbind命令,服務器端隨后返回Unbind_Resp應答,然后雙方斷開連接。接口地址:18888消息定義系統(tǒng)中消息分二種:基于TCP/IP消息和鑒權消息,系統(tǒng)中每個消息包最大不超過2K字節(jié)?;诨赥CP/IP消息定義專用SGIP合同中定義消息由消息頭和消息體構成。項目闡明消息頭消息頭某些消息體消息體某些表消息構成數(shù)據(jù)類型消息中運用到如下數(shù)據(jù)類型類型闡明Integer無符號整數(shù)Text定長字符串,左對齊存儲,空余位置補’\0’表消息數(shù)據(jù)類型消息中所有Integer類型字段均采用網絡字節(jié)順序。所有消息中序列號字段均占12個字節(jié),分為3個4字節(jié)整數(shù);通信傳播時每個整數(shù)都使用網絡字節(jié)順序,但整多順序并不變化。也就是說,通信傳播時候,序列號字段應當按照三個持續(xù)4字節(jié)整數(shù)來解決。消息頭格式字段長度(字節(jié))類型闡明MessageLength8Text消息總長度(字節(jié))CommandID8Text命令IDSequenceNumber16Text序列號表消息頭格式消息體格式1Bind操作Bind操作由Bind命令和Bind_Resp應答構成??蛻舳艘环矫姘l(fā)送Bind命令,服務器端收到Bind命令后,對命令發(fā)送方進行驗證,然后返回Bind_Resp應答。Bind命令語法字段長度(字節(jié))類型闡明SpCode6Text公司編碼LoginName16Text服務器端給客戶端分派登錄名LoginPassowrd16Text服務器端和LoginName相應密碼Reserve8Text保存,擴展用表Bind消息格式Bind_Resp應答語法字段長度(字節(jié))類型闡明Result2TextBind執(zhí)行命令與否成功。0:執(zhí)行成功其他:錯誤碼Reserve8Text保存,擴展用表Bind_Resp消息格式Unbind操作Unbind操作由Unbind命令和Unbind_Resp應答構成。通信連接建立后來,客戶端如果要停止通信,需要發(fā)送Unbind命令;服務器端收到Unbind命令后,向客戶端發(fā)送Unbind_Resp相應,然后雙方斷開連接。Unbind命令語法Unbind命令沒有消息體Unbind_Resp應答語法Unbind_Resp應答沒有消息體。Submit操作(發(fā)送短信)在submit操作是由發(fā)送短信方向咱們發(fā)送消息,咱們做服務器端,對方做客戶端。Submit命令語法字段長度(字節(jié))類型闡明UserCount3Text接受短消息手機數(shù)量,取值范疇1至100UserNumber21Text接受該短消息手機號…………ScheduleTime14Text短消息定期發(fā)送時間,如果為空,表達立即發(fā)送該短消息。時間內容為14個字符,格式為“yyyymmddhhmmss”,即默認系統(tǒng)為北京時間MessageCoding1Text短消息編碼格式。0:純ASCII字符串1:GBK編碼2:utf-8編碼MessageLength8Text短消息長度MessageContentMessageLengthText短消息內容Reserve8Text保存,擴展用表Submit消息格式Submit_Resp應答語法字段長度(字節(jié))類型闡明Result2TextSubmit命令與否成功接受。0:接受成功其他:錯誤碼Reserve8Text保存,擴展用表Submit_Resp消息格式Deliver操作(上行回答)Deliver操作是由咱們向發(fā)送短信一方傳送手機顧客上行消息,即咱們做客戶端,發(fā)送短信方做服務器端。Deliver命令語法字段長度(字節(jié))類型闡明UserNumber21Text發(fā)送短消息顧客手機號MessageCoding1Text短消息編碼格式。短消息編碼格式。0:純ASCII字符串1:GBK編碼2:utf-8編碼MessageLength8Text短消息長度MessageContentMessageLengthText短消息內容Reserve8Text保存,擴展用表Deliver消息格式Deliver_Resp應答語法字段長度(字節(jié))類型闡明Result2TextDeliver命令與否成功接受。0:接受成功其他:錯誤碼Reserve8Text保存,擴展用表Del.iver_Resp消息格式Report操作(狀態(tài)報告)Report操作是由咱們向發(fā)送短信一方傳送手機顧客狀態(tài)報告,即咱們做客戶端,發(fā)送短信方做服務器端。Report命令語法字段長度(字節(jié))類型闡明SubmitSequenceNumber16Text該命令所涉及Submit或deliver命令序列號UserNumber21Text接受短消息手機號State1Text該命令所涉及短消息當前執(zhí)行狀態(tài)0:發(fā)送成功1:等待發(fā)送2:發(fā)送失敗ErrorCode2Text當State=2時為錯誤碼值,否則為0Reserve8Text保存,擴展用表Report消息格式Report_Resp應答語法字段長度(字節(jié))類型闡明Resul

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論