一信通短信接口文檔.doc

上海幟訊信息技術(shù)有限公司 2012 02 Page 1 of 12 一信通企業(yè)信息服務(wù)平臺一信通企業(yè)信息服務(wù)平臺 接口手冊接口手冊 產(chǎn)品名稱一信通企業(yè)信息服務(wù)平臺接口手冊 版本編號 2 1 2 文檔編號 發(fā)布者 發(fā)布日期 2012 5 10 上海幟訊信息技術(shù)有限公司 2012 02 Page 2 of 12 目錄目錄 一信通企業(yè)信息服務(wù)平臺一信通企業(yè)信息服務(wù)平臺 1 1 概述概述 3 1 1編制目的 3 1 2內(nèi)容概述 3 1 3名稱解釋 3 1 4參考文獻 3 2 短信短信 4 2 1HTTP接口 4 2 1 1消息協(xié)議 4 2 1 2發(fā)送短信 4 2 1 3回執(zhí)接口 5 2 1 4剩余短信條數(shù)查詢 6 2 1 5回復(fù)內(nèi)容接口 7 2 2WEBSERVICE接口 7 2 2 1消息協(xié)議 7 2 2 2發(fā)送短信 8 2 2 3回執(zhí)接口 9 2 2 4上行回復(fù)內(nèi)容查詢接口 10 2 2 5上行回復(fù)內(nèi)容確認(rèn)接口 10 2 2 6內(nèi)容審核 11 修改歷史修改歷史 日期日期版本版本作者作者修改內(nèi)容修改內(nèi)容評審號評審號更改請求號更改請求號 上海幟訊信息技術(shù)有限公司 2012 02 Page 3 of 12 1 概述概述 1 1 編制目的編制目的 該接口文檔手冊編寫在于描述易派企業(yè)信息服務(wù)平臺 UMS 以下簡稱 UMS 具體的接 口協(xié)議 供第三方系統(tǒng)能夠順利接入一信通短信網(wǎng)關(guān) 1 2 內(nèi)容概述內(nèi)容概述 本規(guī)范主要講了第三方系統(tǒng)接入短信通系統(tǒng)的協(xié)議要求 協(xié)議三大狀態(tài)和協(xié)議指令的格式 和響應(yīng)信息 1 3 名稱解釋名稱解釋 縮略語縮略語英文全名英文全名中文全名中文全名 UMSUnified Message Service一信通 SMSShort Messaging Service短消息服務(wù) APIApplication Proframming Interface應(yīng)用程序編程接口 MOMessage Original消息上行 MTMessage Terminal消息下行 SPService Provider服務(wù)提供商 CPContent Provider內(nèi)容提供商 1 4 參考文獻參考文獻 上海幟訊信息技術(shù)有限公司 2012 02 Page 4 of 12 2 短信短信 http 接口接口 2 1 1 消息協(xié)議消息協(xié)議 接口地址 8899 sms Api 通過接口提交參數(shù)時 參數(shù)內(nèi)容必須為 GB2312 編碼 且經(jīng)過 url 編碼后的內(nèi)容 例如 您好 的 url 編碼為 C4 FA BA C3 接口返回的內(nèi)容是一些鍵值對的字符串集合 形式為 k1 v1 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 如果要獲取取接受短信的號碼則使用 String mdn String result get MDN 即可 其他字段類似方式 2 1 4 剩余短信條數(shù)查詢剩余短信條數(shù)查詢 功能描述 功能描述 剩余短信條數(shù)查詢接口 調(diào)用格式調(diào)用格式 對 8899 sms Api SearchNumber do 進行 post 返回格式返回格式 result 000000000000000000010 000000000000000000010 上海幟訊信息技術(shù)有限公司 2012 02 Page 10 of 12 2 2 4 上行回復(fù)內(nèi)容查詢接口上行回復(fù)內(nèi)容查詢接口 功能描述 功能描述 上行回復(fù)內(nèi)容查詢 調(diào)用方式調(diào)用方式 利用 webservice 客戶端進行 http 請求 返回格式返回格式 ReplyResponse ReplyRequest請求參數(shù)說明請求參數(shù)說明 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 輸入In0 string 企業(yè)編號 輸入In1 string 用戶名稱 輸入In2 string 用戶密碼 ReplyResponse返回值返回值 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 輸出result string 返回碼 輸出confirm time string 回復(fù)時間 格式 yyyy MM dd HH mm ss 輸出replysreply 數(shù)組多個 relpy 對象組成 返回值返回值錯誤描述錯誤描述 0 成功 1 提交參數(shù)不能為空 2 賬號無效 3 賬號密碼錯誤 20 系統(tǒng)錯誤 reply 的屬性值 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 輸出callMdn string 接入號 輸出mdn string 用戶手機號 輸出message string 回復(fù)內(nèi)容 輸出reply time string 回復(fù)時間 格式 yyyy MM dd HH mm ss 2 2 5 上行回復(fù)內(nèi)容確認(rèn)接口上行回復(fù)內(nèi)容確認(rèn)接口 功能描述 功能描述 上行回復(fù)內(nèi)容查詢 調(diào)用方式調(diào)用方式 利用 webservice 客戶端進行 http 請求 返回格式返回格式 ReplyConfirmResponse ReplyConfirmRequest請求參數(shù)說明請求參數(shù)說明 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 上海幟訊信息技術(shù)有限公司 2012 02 Page 11 of 12 輸入In0 string 企業(yè)編號 輸入In1 string 用戶名稱 輸入In2 string 用戶密碼 輸入In3 string 上行回復(fù)內(nèi)容查詢接口返回的時間 格式 yyyy MM dd HH mm ss ReplyConfirmResponse返回值返回值 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 輸出result string 返回碼 返回值返回值錯誤描述錯誤描述 0 成功 1 提交參數(shù)不能為空 2 賬號無效 3 賬號密碼錯誤 4 時間格式不正確 格式為 yyyy MM dd HH mm ss 20 系統(tǒng)錯誤 2 2 6 內(nèi)容審核內(nèi)容審核 功能描述 功能描述 短信發(fā)送 調(diào)用格式調(diào)用格式 利用 webservice 客戶端進行 http 請求 返回格式返回格式 AuditingResponse AuditingRequest請求參數(shù)說明請求參數(shù)說明 類別類別參數(shù)名稱參數(shù)名稱類型類型說明說明 輸入In0 string 企業(yè)編號 輸入In1 string 用戶名稱 輸入In2 string 用戶密碼 輸入In3 string 短信內(nèi)容 最大 402 個字符 AuditingResponse返回值返回值 返回值返回值錯誤描述錯誤描述 0