企業(yè)短信接口文檔說明

1、 企業(yè)短信接口文檔企業(yè)短信接口文檔說明 TOC o 1-3 h z u HYPERLINK l _Toc332724032 客戶接口說明 PAGEREF _Toc332724032 h 1 HYPERLINK l _Toc332724033 第一章 發(fā)送接口 PAGEREF _Toc332724033 h 2 HYPERLINK l _Toc332724034 1.1 請求地址 PAGEREF _Toc332724034 h 2 HYPERLINK l _Toc332724035 1.2參數說明 PAGEREF _Toc332724035 h 2 HYPERLINK l _Toc3327240

2、36 1.3返回值 PAGEREF _Toc332724036 h 2 HYPERLINK l _Toc332724037 第二章 余額及已發(fā)送量查詢接口 PAGEREF _Toc332724037 h 3 HYPERLINK l _Toc332724038 2.1 請求地址 PAGEREF _Toc332724038 h 3 HYPERLINK l _Toc332724039 2.2參數說明 PAGEREF _Toc332724039 h 3 HYPERLINK l _Toc332724040 2.3返回值 PAGEREF _Toc332724040 h 3 HYPERLINK l _Toc

3、332724041 第三章 非法關鍵詞查詢 PAGEREF _Toc332724041 h 4 HYPERLINK l _Toc332724042 3.1 請求地址 PAGEREF _Toc332724042 h 4 HYPERLINK l _Toc332724043 3.2參數說明 PAGEREF _Toc332724043 h 4 HYPERLINK l _Toc332724044 3.3返回值 PAGEREF _Toc332724044 h 4 HYPERLINK l _Toc332724045 第四章 狀態(tài)報告接口 PAGEREF _Toc332724045 h 5 HYPERLINK

4、 l _Toc332724046 4.1 請求地址 PAGEREF _Toc332724046 h 5 HYPERLINK l _Toc332724047 4.2參數說明 PAGEREF _Toc332724047 h 5 HYPERLINK l _Toc332724048 4.3返回值 PAGEREF _Toc332724048 h 5 HYPERLINK l _Toc332724049 4.4錯誤返回值狀態(tài)報告請求錯誤返回格式及對應值 PAGEREF _Toc332724049 h 6 HYPERLINK l _Toc332724050 第五章 上行接口 PAGEREF _Toc33272

5、4050 h 6 HYPERLINK l _Toc332724051 5.1 請求地址 PAGEREF _Toc332724051 h 6 HYPERLINK l _Toc332724052 5.2參數說明 PAGEREF _Toc332724052 h 6 HYPERLINK l _Toc332724053 5.3返回值 PAGEREF _Toc332724053 h 7 HYPERLINK l _Toc332724054 5.4錯誤返回值回復請求錯誤返回格式及對應值 PAGEREF _Toc332724054 h 7接口說明：客戶接口部分提供http url方式的接口，根據客戶需求可以提供

6、相應接口，接口編碼方式采用統一的UTF-8第一章 發(fā)送接口1.1 請求地址請求地址是客戶接口程序調用時請求的url地址，采用的是http post 接口，地址是http:/ 5:9001/sms.aspx 對應UTF-8http:/ 5:9001/smsGBK.aspx 對應GB2312入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶1.2參數說明http:/ 5:9001/sms.aspxhttp:/ 5:9001/smsGBK.aspx參數名稱含義說明userid企業(yè)id企業(yè)IDaccount發(fā)送用戶帳號用戶帳號，由系統管理員password發(fā)送帳號密碼用戶賬號對應的密碼mobi

7、le全部被叫號碼發(fā)信發(fā)送的目的號碼.多個號碼之間用半角逗號隔開 content發(fā)送內容短信的內容，內容需要UTF-8編碼sendTime定時發(fā)送時間為空表示立即發(fā)送，定時發(fā)送格式2010-10-24 09:08:10action發(fā)送任務命令設置為固定的:sendextno擴展子號請先詢問配置的通道是否支持擴展子號，如果不支持，請?zhí)羁?。子號只能為數字，且最?位數。例如：action=send&userid=12&account=賬號&password=密碼&mobilecontent=內容&sendTime=&extno=1.3返回值在接收到客戶端發(fā)送的http請求后

8、，返回以xml的方式返回處理結果。格式為：status 返回狀態(tài)值：成功返回Success 失敗返回：Faildmessage 返回信息：見下表 remainpoint 返回余額taskID 返回本次任務的序列IDsuccessCounts -成功短信數：當成功后返回提交成功短信數返回信息提示說明ok提交成功用戶名或密碼不能為空提交的用戶名或密碼為空發(fā)送內容包含sql注入字符包含sql注入字符用戶名或密碼錯誤表示用戶名或密碼錯誤短信號碼不能為空提交的被叫號碼為空短信內容不能為空發(fā)送內容為空包含非法字符：表示檢查到不允許發(fā)送的非法字符對不起，您當前要發(fā)送的量大于您當前余額當支付方式為預付費是，檢

9、查到賬戶余額不足其他錯誤其他數據庫操作方面的錯誤第二章 余額及已發(fā)送量查詢接口2.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 5:9001/sms.aspxhttp:/ 5:9001/smsGBK.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶2.2參數說明參數名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：overage例如：action=overage&userid=12&account=賬

10、號&password=密碼2.3返回值status返回狀態(tài)值：成功返回Success 失敗返回：Faildmessage返回信息提示：見下表payinfo返回支付方式 后付費，預付費overage返回余額sendTotal返回總點數 當支付方式為預付費是返回總充值點數返回信息提示說明返回空查詢成功將返回相應的支付方式、賬戶使用條數、總充值點數用戶名或密碼不能為空提交的用戶名或密碼為空用戶名或密碼錯誤表示用戶名或密碼錯誤第三章 非法關鍵詞查詢3.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 5:9001/sms.aspxhttp

11、:/ 5:9001/smsGBK.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶3.2參數說明參數名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：checkkeywordcontent檢測發(fā)送內容需要發(fā)送的內容例如：action=checkkeyword&userid=12&account=賬號&password=密碼&content=內容3.3返回值message返回信息提示：見下表返回信息提示說明用戶名或密碼不能為空提交的用戶名或密碼為空用戶名或密碼錯誤表示用

12、戶名或密碼錯誤包含非法字符檢查出來包含非法關鍵詞未包含非法字符未檢查出非法關鍵詞第四章 狀態(tài)報告接口4.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 5:9001/statusApi.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶4.2參數說明參數名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：query例如：action=query&userid=12&account=賬號&password=密

13、碼4.3返回值應的手機號碼1212同一批任務ID10狀態(tài)報告10：發(fā)送成功，20：發(fā)送失敗2011-12-02 22:12:11接收時間MK:0011狀態(tài)返回值135015886451212202011-12-02 22:12:11DELIVRD狀態(tài)返回值4.4錯誤返回值狀態(tài)報告請求錯誤返回格式及對應值 1錯誤碼用戶名或密碼不能為空錯誤描述1：用戶名或密碼不能為空2：用戶名或密碼錯誤3：該用戶不允許查看狀態(tài)報告4：參數不正確第五章 上行接口5.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 5:9001/callApi.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶5.2參數說明參數名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：query例如：action=query&userid=12&account=賬