HTTP接口文檔

1、HTT麟口文檔接口域名：一、工作方式 錯誤!未定義書簽1.1密碼驗(yàn)證方式 錯誤!未定義書簽二、字符編碼 錯誤!未定義書簽三、響應(yīng)格式 錯誤!未定義書簽四、短信發(fā)送（單條，多條發(fā)送） 錯誤!未定義書簽五、接收X態(tài)報告錯誤!未定義書簽5.1 主動獲取狀態(tài) 錯誤!未定義書簽六、接收上行短信（回復(fù)） 錯誤!未定義書簽5.2 主動接收上行短彳t （回復(fù)） 錯誤!未定義書簽5.3 推送接收上行短彳t （回復(fù)） 錯誤!未定義書簽七、取剩余短信條數(shù)錯誤!未定義書簽八、取已發(fā)送總條數(shù)錯誤!未定義書簽九、接口安全（綁定 IP） 錯誤!未定義書簽十、取發(fā)送記錄錯誤!未定義書簽一、工作方式雙方通過HTTP式交互數(shù)據(jù)，

2、第三方可以簡單的" name=value ”方式發(fā)送提交內(nèi)容或 響應(yīng)請求內(nèi)容。即通過HTTFPGET/POST式交換。另外雙方需要保證數(shù)據(jù)傳輸?shù)耐暾院桶踩裕看伟l(fā)送請求都有響應(yīng)（響應(yīng)返回格式為純文本），安全驗(yàn)證目前采用用戶名、密碼和 IP綁定的方式。1.1 密碼驗(yàn)證方式接口密碼使用“登錄密碼”與“用戶名”拼接字符串后能過md珈密進(jìn)行驗(yàn)證如登錄密碼是：123123如用戶名是：test接口密碼（pwd） =md5（登錄密碼+用戶名）pwd=md5（123123test）pwd由9887c5ebb23ebb294acab183ecf0769二、字符編碼服務(wù)器接收數(shù)據(jù)可以是 GB娥UTF

3、-8編碼字符，默認(rèn)接收數(shù)據(jù)是 GB編碼，如提交的是UTF-8編碼字符，需要添加參數(shù)encode=utf8 。請求響應(yīng)返回內(nèi)容是 GB編碼。三、響應(yīng)格式所為響應(yīng)即每次向服務(wù)器提交請求后返回值響應(yīng)值格式為純文本四、短信發(fā)送（單條，多條發(fā)送）GET/POST作格式：/?uid=用戶賬號 &pwd=MD532 位密碼 &mobile=號碼 &mobileids=消息編號 &content=內(nèi)容接口參數(shù)說明：參數(shù)名參數(shù)字段參數(shù)說明uid用戶賬號登錄名pwd用戶密碼32位MD5J口密 md5(密碼 +uid)如登錄密碼是：123123 , uid是：test;pwd=md5

4、(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769mid子擴(kuò)展號可選項(xiàng)，根據(jù)用戶賬號是否支持?jǐn)U展encode字符編碼可選項(xiàng)，默認(rèn)接收數(shù)據(jù)是GB編碼，如提交的是UTF-8編碼字符，需要添力口參數(shù) encode=utf8mobile接收號碼同時發(fā)送給多個號碼時，號碼之間用英文半角逗號分隔（，）；小靈通需加區(qū)號如:,074GET 方式每次最多可以提交 50條號碼POST方式每次最多可以提交 2000條號碼建議用POSTT式提交mobileids消息編號可選項(xiàng)該參數(shù)用于發(fā)送短信收取狀態(tài)報告用，格式為消息編號+逗號；與接收號碼一一對應(yīng)，可以重復(fù)出現(xiàn)多次。消息

5、編號：全部由數(shù)字組成接收狀態(tài)報告的時候用到， 該消息編號的格式 為目標(biāo)號碼+當(dāng)前時間戳整數(shù)，精確到毫秒，確保唯一性。供收取狀態(tài)報 告用如：9461937;content短信內(nèi)容發(fā)送內(nèi)容需要進(jìn)行UR序符標(biāo)準(zhǔn)化轉(zhuǎn)碼。URL字符編碼說明：返回字符串，此字符串中除了 -_.之外的所有非字母 數(shù)字字符都將被替換成百分號 （）后跟兩位十六進(jìn)制數(shù)，空格則編碼 為加號（+ ） ASP server.URLEncode（"短信內(nèi)容"）PHP urlencode（"短信內(nèi)容"）JAVA "短信內(nèi)容"）例：接收號:,1390000test,發(fā)送內(nèi)容：發(fā)送測

6、試/?uid= test &pwd= b9887c5ebb23ebb294acab183ecf0769&mobile=,1390000test,&mobileids=888,1390000test,666&content=%B7%A2%CB%CD%B2%E2%CA%D4發(fā)成功時響應(yīng)狀態(tài)碼值：sms&stat=100&message= 發(fā)送成功stat 狀態(tài)碼message 狀態(tài)說明返回發(fā)送的狀態(tài)碼狀態(tài)碼 說明100發(fā)送成功101驗(yàn)證失敗102短信不足103操作失敗104非法字符105內(nèi)容過多106號碼過多107頻率過快108號碼內(nèi)容空109賬號凍

7、結(jié)110禁止頻繁單條發(fā)送112號碼錯誤113定時時間格式不對114賬號被鎖，10分鐘后登錄116禁止接口發(fā)送117綁定IP不正確120系統(tǒng)升級五、接收狀態(tài)報告5.1主動獲取狀態(tài)GET/POST作格式：/?uid=用戶賬號&pwd=MD532 位密碼接口參數(shù)說明參數(shù)名參數(shù)字段參數(shù)說明uid用戶賬號pwd用戶密碼32位MD口密md5（登錄密碼+用戶賬號）例：/?uid= test &pwd= b9887c5ebb23ebb294acab183ecf0769 響應(yīng)返回值：,100,556789,2011-03-1111:22:11,100,556311,2011-03-1111:28

8、:22說明：手機(jī)號，狀態(tài)，發(fā)送唯一編號，狀態(tài)返回時間+換行每條狀態(tài)記錄以換行分隔，一行一條狀態(tài)記錄六、接收上行短信（回復(fù)）6.1 主動接收上行短信（回復(fù)）操作的格式：/?uid=用戶賬號&pwd=MD532 位密碼注：提取的回復(fù)短信不能在重復(fù)提取接口參數(shù)說明參數(shù)參數(shù)字段名說明uid用戶賬號pwd用戶密碼小寫32位MD咖密例：/?uid= test &pwd=b9887c5ebb23ebb294acab183ecf0769響應(yīng)結(jié)果為純文本，每次可接收多條回復(fù)信息：狀態(tài)碼&回復(fù)號碼|回復(fù)內(nèi)容|回復(fù)時間|回復(fù)網(wǎng)關(guān)號&回復(fù)號碼|回復(fù)內(nèi)容|回復(fù)時間| 回復(fù)網(wǎng)關(guān)號.例響應(yīng)結(jié)

9、果值：100&| 短信測試回復(fù) |2008-05-27 12:10:11|27282&|短信測試回復(fù) 2|2009-05-27 13:11:11|1068返回發(fā)送的狀態(tài)碼無回復(fù)內(nèi)容時返回空注：對回復(fù)的內(nèi)容中有|會自動轉(zhuǎn)成全角| |字符串6.2 推送接收上行短信（回復(fù)）使用說明：由服務(wù)器平臺發(fā)送上行回復(fù)短信到您的接口程序上，使用 Http協(xié)議GETf口 PO ST式發(fā)送，您需要提交一個http接口地址來接收如下格式參數(shù)值操作的格式: 接口參數(shù)說明：參數(shù)參數(shù)字段名說明cmd操作命令返回值：resuid用戶賬號返回值：發(fā)送短信用戶名time回復(fù)時間返回彳直:YYYY-MM-DD HH

10、:II:SSmobile接收號碼返回值：接收的號碼content消息內(nèi)容返回彳1: GB停符串七、取剩余短信條數(shù)操作格式：/?uid=用戶賬號&pwd=MD5 位32密碼接口參數(shù)說明參數(shù)參數(shù)字段名說明uid用戶賬號pwd用戶密碼32位MD咖密例：/?uid= test &pwd=fa246d0262c3925617b0c72bb20eeb1d響應(yīng)結(jié)果為純文本：sms&stat=狀態(tài)碼&remain=剩余可發(fā)短信例響應(yīng)結(jié)果值：sms&stat=100&remain=100八、取已發(fā)送總條數(shù)操作格式：/?uid=用戶賬號 &pwd=MD5 位

11、32 密碼 &cmd=send接口參數(shù)說明參數(shù)參數(shù)字段名說明uid用戶賬號pwd用戶密碼32位MD咖密cmdsend取已發(fā)送條數(shù)例：/?uid= test &pwd=fa246d0262c3925617b0c72bb20eeb1d&cmd=send響應(yīng)結(jié)果為純文本：sms&stat= 狀態(tài)碼 &remain=已發(fā)短信例響應(yīng)結(jié)果值：sms&stat=100&remain=100九、接口安全(綁定IP)為了接口更加的安全，請登錄WEy臺在“系統(tǒng)設(shè)置”中綁定你服務(wù)器的IP地址，可綁定10個固定IP,綁定IP后只有通過你的服務(wù)器來發(fā)送短信，防止他人使用十、取發(fā)送記錄操作的格式：/?uid=用戶賬號 &pwd=MD532 位密碼 &page=1接口參數(shù)說明：每次最多取50條記錄，可以根據(jù)頁數(shù)依次取完參數(shù)參數(shù)字段名說明uid用戶賬號pwd用戶密碼小寫32位MD咖密page頁數(shù)可選項(xiàng)，取第多少頁記錄date日期可選項(xiàng)，取指定日期記錄(2012-12-12 )key查詢號碼可選項(xiàng)，取指定手機(jī)號記錄encode字符編碼可選項(xiàng)，默認(rèn)接收數(shù)據(jù)是GB編碼，如提交的是UTF-8編碼字