邦之信HTTP萬能短信驗證碼接口及說明

1、客戶接口說明客戶接口說明1第一章 發(fā)送接口21.1 請求地址21.2參數(shù)說明21.3返回值2第二章 余額及已發(fā)送量查詢接口32.1 請求地址32.2參數(shù)說明32.3返回值3第三章 非法關鍵詞查詢43.1 請求地址43.2參數(shù)說明43.3返回值4第四章 狀態(tài)報告接口54.1 請求地址54.2參數(shù)說明54.3返回值54.4錯誤返回值狀態(tài)報告請求錯誤返回格式及對應值6第五章 上行接口65.1 請求地址65.2參數(shù)說明65.3返回值75.4錯誤返回值回復請求錯誤返回格式及對應值7接口說明：客戶接口部分提供http url方式的接口，根據(jù)客戶需求可以提供相應接口，接口編碼方式采用統(tǒng)一的UTF-8第一章

2、發(fā)送接口1.1 請求地址請求地址是客戶接口程序調用時請求的url地址，采用的是http post 接口，地址是http:/ 26:8888:port/sms.aspx 對應UTF-8http:/ 26:8888:port/smsGBK.aspx 對應GB2312入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶26:8888/sms.aspx?action=send&userid=1707&account=mingyu&password=123456789&mobile=%s&

3、amp;content=%s&sendTime=&extno=1.2參數(shù)說明http:/ 26:8888:port/sms.aspxhttp:/ 26:8888:port/smsGBK.aspx參數(shù)名稱含義說明userid企業(yè)id企業(yè)IDaccount發(fā)送用戶帳號用戶帳號，由系統(tǒng)管理員password發(fā)送帳號密碼用戶賬號對應的密碼mobile全部被叫號碼發(fā)信發(fā)送的目的號碼.多個號碼之間用半角逗號隔開 content發(fā)送內容短信的內容，內容需要UTF-8編碼sendTime定時發(fā)送時間為空表示立即發(fā)送，定時發(fā)送格式2010-10-24

4、09:08:10action發(fā)送任務命令設置為固定的:sendextno擴展子號請先詢問配置的通道是否支持擴展子號，如果不支持，請?zhí)羁?。子號只能為?shù)字，且最多5位數(shù)。例如：action=send&userid=12&account=賬號&password=密碼&mobile13527576163&content=內容&sendTime=&extno=1.3返回值在接收到客戶端發(fā)送的http請求后，返回以xml的方式返回處理結果。格式為：<?xml version="1.0" encodi

5、ng="utf-8" ?><returnsms><returnstatus>status</returnstatus> - 返回狀態(tài)值：成功返回Success 失敗返回：Faild<message>message</message> - 返回信息：見下表<remainpoint> remainpoint</remainpoint> - 返回余額<taskID>taskID</taskID> - 返回本次任務的序列ID<successCounts>su

6、ccessCounts</successCounts> -成功短信數(shù)：當成功后返回提交成功短信數(shù)</returnsms>返回信息提示說明Ok提交成功用戶名或密碼不能為空提交的用戶名或密碼為空發(fā)送內容包含sql注入字符包含sql注入字符用戶名或密碼錯誤表示用戶名或密碼錯誤短信號碼不能為空提交的被叫號碼為空短信內容不能為空發(fā)送內容為空包含非法字符：表示檢查到不允許發(fā)送的非法字符對不起，您當前要發(fā)送的量大于您當前余額當支付方式為預付費是，檢查到賬戶余額不足其他錯誤其他數(shù)據(jù)庫操作方面的錯誤第二章 余額及已發(fā)送量查詢接口2.1 請求地址請求地址是客戶接口程序調用的時候請求的url

7、地址，采用的是http post接口，地址是http:/ 26:8888:port/sms.aspxhttp:/ 26:8888:port/smsGBK.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶2.2參數(shù)說明參數(shù)名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：overage例如：action=overage&userid=12&account=賬號&password=密碼2.3返回值<

8、?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus>-返回狀態(tài)值：成功返回Success 失敗返回：Faild<message>message</message>-返回信息提示：見下表<payinfo>payinfo</payinfo>-返回支付方式 后付費，預付費<overage>overage</overage>-返回余額&

9、lt;sendTotal>sendTotal</sendTotal>-返回總點數(shù) 當支付方式為預付費是返回總充值點數(shù)</returnsms>返回信息提示說明返回空查詢成功將返回相應的支付方式、賬戶使用條數(shù)、總充值點數(shù)用戶名或密碼不能為空提交的用戶名或密碼為空用戶名或密碼錯誤表示用戶名或密碼錯誤第三章 非法關鍵詞查詢3.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 26:8888:port/sms.aspxhttp:/ 26:8888:port/smsGB

10、K.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶3.2參數(shù)說明參數(shù)名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：checkkeywordcontent檢測發(fā)送內容需要發(fā)送的內容例如：action=checkkeyword&userid=12&account=賬號&password=密碼&content=內容3.3返回值<?xml version="1.0" encoding="utf-8&qu

11、ot; ?><returnsms><message>message</message>-返回信息提示：見下表</returnsms>返回信息提示說明用戶名或密碼不能為空提交的用戶名或密碼為空用戶名或密碼錯誤表示用戶名或密碼錯誤包含非法字符檢查出來包含非法關鍵詞未包含非法字符未檢查出非法關鍵詞第四章 狀態(tài)報告接口4.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 26:8888:port/statusApi.aspx入口地址一般不會發(fā)生變化，當發(fā)生變化的時

12、候，會通知接口用戶4.2參數(shù)說明參數(shù)名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：query例如：action=query&userid=12&account=賬號&password=密碼4.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><statusbox><mobile>lt;/m

13、obile>-對應的手機號碼<taskid>1212</taskid>-同一批任務ID<status>10</status>-狀態(tài)報告-10：發(fā)送成功，20：發(fā)送失敗<receivetime>2011-12-02 22:12:11</receivetime>-接收時間<errorcode>DELIVRD</errorcode>-上級網關返回值，不同網關返回值不同，僅作為參考</statusbox><statusbox><mobile>

14、lt;/mobile><taskid>1212</taskid><status>20</status><receivetime>2011-12-02 22:12:11</receivetime><errorcode>2</errorcode></statusbox></returnsms>4.4錯誤返回值狀態(tài)報告請求錯誤返回格式及對應值<?xml version="1.0" encoding="utf-8" ?> &l

15、t;returnsms><errorstatus><error>1</error>-錯誤碼<remark>用戶名或密碼不能為空</remark>-錯誤描述</errorstatus></returnsms>1：用戶名或密碼不能為空2：用戶名或密碼錯誤3：該用戶不允許查看狀態(tài)報告4：參數(shù)不正確第五章 上行接口5.1 請求地址請求地址是客戶接口程序調用的時候請求的url地址，采用的是http post接口，地址是http:/ 26:8888:port/callApi.aspx入口地址一般

16、不會發(fā)生變化，當發(fā)生變化的時候，會通知接口用戶5.2參數(shù)說明參數(shù)名稱含義說明userid企業(yè)id企業(yè)IDaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應的密碼action任務名稱設置為固定的：query例如：action=query&userid=12&account=賬號&password=密碼5.3返回值<?xml version="1.0" encoding="utf-8" ?> <returnsms><callbox><mobile>15023

17、239810</mobile>-對應的手機號碼<taskid>1212</taskid>-同一批任務ID<content>你好，我不需要</content>-上行內容<receivetime>2011-12-02 22:12:11</receivetime>-接收時間</callbox><callbox><mobile>lt;/mobile><taskid>1212</taskid><content>你好，本次活動路線是怎么的</content><receivetime>2011-12-02 22:12:11</receivetime></callbox></returnsms>5.4錯誤返回