互億無線短信驗證碼API中國·上海4008808898互億無線短信驗證碼API接口說明文件標識Ihuyi_SMSAPI-SEND版本編號V3.3發布者上海思銳信息技術有限公司發布日期2010-05-12最新更新2024-08-06

目錄192541.概要 4305601.1文檔說明 4103401.2提交方式 4299521.3加密方式 4121921.4APIID/APIKEY 482111.5短信模版 4104202.短信單條發送 541172.1接口描述 5267802.2請求地址 5152862.3請求參數 5210622.4響應示例 6115642.5響應參數 756702.6GET請求示例 8117493.短信批量發送 8285653.1接口描述 8196943.2請求地址 8220443.3請求參數 8321483.4響應參數 925813.5傳參說明 10143434.余額查詢 10243884.1接口描述 1051204.2請求地址 11320944.3請求參數 11219534.4響應示例 11198574.5響應參數 12265974.6GET請求示例 12178055.發送回執推送 12206965.1接口描述 129305.2推送參數 13268666.上行回復推送 1333036.1接口描述 13323946.2推送參數 13178047.提交模板 14162507.1接口描述 14155527.2請求地址 14153417.3請求參數 14288897.4響應參數 15134207.5模板審核狀態推送 1555328.刪除模板 16137018.1接口描述 16301618.2請求地址 16218938.3請求參數 1647558.4響應參數 17197349.生成動態密碼方式 173020010.常見問題 181069210.1如何處理亂碼 18716210.2如何實現UNIX時間戳 19453511.短信DEMO 201122312.短信插件 20259113.聯系方式 22

1.概要1.1文檔說明本文檔主要提供給互億平臺的用戶對接接口的使用說明，開發者可以利用ihuyi提供的HTTP接口，調用ihuyi的短信驗證碼/通知服務。1.2提交方式GET/POST1.3加密方式1、采用HTTPS協議提交請求2、通過MD5動態簽名方式加密1.4APIID/APIKEY登錄用戶中心，進入【驗證碼通知短信】模塊，在【產品總覽】頁面右側，如下圖所示：1.5短信模版短信模板是對您將要發送的短信進行相似性提取后的內容。舉個例子，A用戶在您平臺注冊會員，需要發送一條短信，內容如下：您好，您的驗證碼是：666666同時，B用戶也在您的平臺注冊會員，發送了如下短信：您好，您的驗證碼是：888888我們提取相似度以后，可以制作以下短信模板：您好，您的驗證碼是：【變量】其中，變量是可變的，可以是數字、字母、漢字。注意：未付費用戶僅可使用默認短信模板，付費用戶可以通過左側導航【驗證碼通知短信】-【短信發送】-【簽名/模版管理】新增短信模板，運營商審核通過之后即可正式使用。1.6短信簽名短信簽名是加在短信的開頭或結尾，在【】加上您的公司名稱或店鋪名稱的標識符，例如：【互億無線】。根據電信基礎運營商的規定，每條短信必須附加短信簽名，否則將無法正常發送。注意：未付費用戶僅可使用默認短信簽名【互億無線】，付費用戶可以通過點擊左側導航【驗證碼通知短信】-【短信發送】-【簽名/模版管理】修改簽名，運營商審核通過之后即可正式使用。2.短信單條發送2.1接口描述通過POST、GET方式進行短信提交，數據編碼采用utf-8格式，24小時全天發送。內容格式為：Content-Type:application/x-www-form-urlencoded2.2請求地址http://106./webservice/sms.php?method=Submit2.3請求參數參數名稱參數值描述必填accountAPIID（用戶中心【驗證碼通知短信】-【產品縱覽】查看）是password1、APIKEY（用戶中心【驗證碼通知短信】-【產品縱覽】查看）2、動態密碼（生成動態密碼方式請看該文檔末尾的說明）是mobile接收手機號碼，只能提交1個號碼是content短信內容（編碼格式為UTF-8，支持500個字的長短信，長短信按多條計費）例如：您的驗證碼是：1234。請不要把驗證碼泄露給其他人。是timeUnix時間戳（10位整型數字，當使用動態密碼方式時為必填）否format返回格式（可選值為：xml或json，系統默認為xml）否用戶通過http或https提交發送短信請求到服務器后，服務器會返回一串xml格式的字符串，SubmitResult結構說明如下：參數名稱類型描述codeint返回值為2時，表示提交成功smsidstring當提交成功后，此字段為流水號，否則為0msgstring提交結果描述2.4響應示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>2</code><msg>提交成功</msg><smsid>14745625541233112231</smsid></SubmitResult>示例（失敗）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>405</code><msg>用戶名或密碼不正確</msg><smsid>0</smsid></SubmitResult>2.5響應參數codemsg0提交失敗2提交成功400非法ip訪問401帳號不能為空402密碼不能為空403手機號碼不能為空4030手機號碼已被列入黑名單404短信內容不能為空405APIID或APIKEY不正確4050賬號被凍結40501動態密碼已過期40502動態密碼校驗失敗4051剩余條數不足4052訪問ip與備案ip不符406手機號碼格式不正確407短信內容含有敏感字符4070簽名格式不正確4071沒有提交備案模板4072提交的短信內容與審核通過的模板內容不匹配40722變量內容超過指定的長度【8】4073短信內容超出長度限制4074短信內容包含emoji符號4075簽名未通過審核4077短信變量內容含有敏感字符408發送超限【50】條，已加入黑名單，可登入平臺解除4082超出同一手機號一天之內【100】條短信限制4085同一手機號一天之內驗證碼短信發送超出【10】條2.6GET請求示例http://106./webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=您的驗證碼是：1234。請不要把驗證碼泄露給其他人。3.短信批量發送3.1接口描述通過POST方式進行短信提交，數據編碼采用utf-8格式，24小時全天發送。內容格式為：Content-Type:application/x-www-form-urlencoded3.2請求地址https://106./webservice/sms.php?method=SubmitBatch3.3請求參數參數名稱參數值描述必填accountAPIID(用戶中心【驗證碼通知短信】-【產品總覽】查看)是password1、APIKEY(用戶中心【驗證碼通知短信】-【產品總覽】查看)2、動態密碼(生成動態密碼方式請看該文檔末尾的說明)是mobile手機號碼（可參考下文示例）是templateid模板ID選填content短信內容選填timeUnix時間戳（10位整型數字，當使用動態密碼方式時為必填）否format返回格式（可選值為：xml或json，系統默認為xml）否sendTime定時發送時間否用戶通過http或https提交發送短信請求到服務器后，服務器會返回一串xml格式的字符串，SubmitBatchResult結構說明如下：參數名稱類型描述codeint返回值為2時，表示提交成功smsidstring流水號（對應提交時返回的smsid）msgstring回執狀態說明3.4響應參數codemsg0提交失敗2提交成功400非法ip訪問401帳號不能為空402密碼不能為空403手機號碼不能為空4031手機號碼必須大于1個4032手機號碼必須小于5000個404模板ID模和模板內容二選一4041模板ID不正確405APIID或APIKEY不正確4050賬號被凍結40501動態密碼已過期40502動態密碼校驗失敗40505沒有簽定合同4051剩余條數不足4052訪問ip與備案ip不符4053用戶不存在4054帳戶無效406手機號碼格式不正確407短信內容含有敏感字符4070簽名格式不正確4074短信內容包含emoji符號4075簽名未通過審核4077短信變量內容含有敏感字符408定時發送時間無效(大于當時間10分鐘，小于當前時間7天409計費錯誤3.5傳參說明1、不含變量手機號格式：號碼之間使用英文逗號隔開，如：136xxxx1111,136xxxx2222,136xxxx3333模板ID：對應您在平臺報備過的模板ID，如：624452模板內容：您有新的訂單，請注意查收。2、含變量手機號格式：變量之間用半|符號隔開，如：136xxxx1111|11111111|菜鳥,136xxxx2222|22222222|京東,136xxxx3333|3333333333|順豐模板ID：對應您在平臺報備過的模板ID，如：624452模板內容：您的訂單號是：【變量】。已由【變量】快遞發出，請注意查收。注意：單次提交最少2個號碼，最多5000個號碼模板ID和模板內容二選一，如果傳模板內容或者號碼數量超過500都會進入人工審核流程。4.余額查詢4.1接口描述通過接口可以方便的查詢你的賬戶驗證碼通知短信剩余條數。4.2請求地址http://106./webservice/sms.php?method=GetNum4.3請求參數參數名稱參數值描述必填accountAPIID（用戶中心【驗證碼通知短信】-【產品縱覽】查看）是password1、APIKEY（用戶中心【驗證碼通知短信】-【產品縱覽】查看）2、動態密碼（生成動態密碼方式請看該文檔末尾的說明）是timeUnix時間戳（10位整型數字，當使用動態密碼方式時為必填）否format返回格式（可選值為：xml或json，系統默認為xml）否用戶通過http或https提交帳戶余額查詢請求到服務器后，服務器會返回一串xml格式的字符串，GetNumResult結構說明如下：參數名稱類型描述codeint狀態返回值msgstring查詢結果描述numstring剩余數量4.4響應示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>2</code><msg>查詢成功</msg><num>856</num></GetNumResult>示例（失敗）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>405</code><msg>用戶名或密碼不正確</msg><num>0</num></GetNumResult>4.5響應參數codemsg2查詢成功400非法ip訪問401帳號不能為空402密碼不能為空405用戶名或密碼不正確4050賬號被凍結4.6GET請求示例http://106./webservice/sms.php?method=GetNum&account=APIID&password=APIKEY5.發送回執推送5.1接口描述用戶先提供數據接收地址，然后綁定到互億無線系統后臺，平臺會以POST方式實時的將回執信息推送到此地址，內容格式為：Content-Type:application/x-www-form-urlencoded。5.2推送參數參數名稱參數值描述code狀態值（2成功其他為失敗）msg回執狀態說明mobilephone手機號碼smsid流水號（對應提交時返回的smsid）report_time回執時間例：2017-08-0214:31:51注意:成功接收請輸出字符“success”（不包含引號）結束推送，否則以接收失敗處理。每個回執最多推送3次。每次間隔疊加60秒。6.上行回復推送6.1接口描述用戶先提供數據接收地址，然后綁定到互億無線系統后臺，平臺會以POST方式實時的將回復信息推送到此地址，內容格式為：Content-Type:application/x-www-form-urlencoded。6.2推送參數參數名稱參數值描述mobilephone手機號碼content上行內容smsid流水號（對應提交時返回的smsid）（僅作參考）reply_time上行時間例：2017-05-2417:46:50注意:成功接收請輸出字符“success”（不包含引號）結束推送，否則以接收失敗處理。每個回執最多推送3次。每次間隔疊加60秒。7.提交模板7.1接口描述通過POST、GET方式提交短信模版，數據編碼采用utf-8格式，內容格式為：Content-Type:application/x-www-form-urlencoded。7.2請求地址http://106./webservice/sms.php?method=AddTemplate&account=APIID&password=APIKEY&content=【互億無線】尊敬的會員，您好，夏季新品已上市，請關注。退訂回TD7.3請求參數參數名稱參數值描述methodAddTemplateaccount提交賬戶password提交賬戶密碼（可以明文密碼或使用32位MD5加密）content模板內容type1驗證碼2通知scene使用場景返回值AddTemplateResult結構說明：參數名稱類型描述codeint返回值為2時，表示添加成功msgstring提交狀態描述templateidint添加成功則返回模板ID7.4響應參數codemsg2添加成功400非法ip訪問401用戶名不能為空402密碼不能為空404模板內容不能為空405用戶名或密碼不正確4050賬號被凍結407模板內容含有敏感字符7.5模板審核狀態推送在遵守HTTP協議規范的前提下，通過POST方式將回執推送到用戶指定的URL地址，內容格式為：Content-Type:application/x-www-form-urlencoded。參數說明：參數名稱參數值描述code狀態值（2成功0駁回）msg審核狀態描述templateid模板ID注意：1.成功接收請輸出字符“success”（不包含引號）結束推送，否則以接收失敗處理。2.每個回執最多推送3次。每次間隔疊加60秒。3.code值說明2成功0駁回（原因請看msg字段）8.刪除模板8.1接口描述通過POST、GET方式提交短信模版，數據編碼采用utf-8格式，內容格式為：Content-Type:application/x-www-form-urlencoded。8.2請求地址http://106./webservice/sms.php?method=DelTemplate&account=APIID&password=APIKEY&templateid=1238.3請求參數參數名稱參數值描述methodDelTemplateaccount提交賬戶password提交賬戶密碼（可以明文密碼或使用32位MD5加密）templateid模板id返回值AddTemplateResult結構說明：參數名稱類型描述codeint返回值為2時，表示刪除成功msgstring提交狀態描述8.4響應參數codemsg2刪除成功400非法ip訪問401用戶名不能為空402密碼不能為空404模板ID不能為空或模板ID不存在405用戶名或密碼不正確4050賬號被凍結9.生成動態密碼方式以PHP為例，提交短信的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機號：138xxxxxxxx內容：您的驗證碼是：2546。請不要把驗證碼泄露給其他人。time：1451544941結果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx您的驗證碼是：2546。請不要把驗證碼泄露給其他人。1451544941');注意：因為短信內容會包含中文，所以字符編碼統一為UTF-8查詢剩余條數的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機號：138xxxxxxxxtime：1451544941結果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix時間戳參考地址：/Tools/unixtime.aspx10.常見問題10.1如何處理亂碼說明：將短信內容（content）進行UTF-8編碼后提交。PHP亂碼：$content=iconv("GBK","UTF-8",$content);JAVA亂碼：sb.append("&content="+URLEncoder.encode(content,"UTF-8"));C#亂碼：byte[]bTemp=System.Text.Encoding.GetEncoding("GBK").GetBytes(sbTemp.ToString());10.2如何實現UNIX時間戳語言代碼JAVAStringdate=newjava.text.SimpleDateFormat("dd/MM/yyyyHH:mm:ss").format(newjava.util.Date(Unixtimestamp*1000))Linuxdate-d@UnixtimestampCstrptime(datetime,"%Y-%m-%d%H:%M:%S",&tm_time);unixtime=mktime(&tm_time);C++std::time_tt=std::time(0);DELPHIusesDateUtils;DateTimeToUnix(Now)GOimport"time"cur:=time.Now()timestamp:=cur.UnixNano()/1000000Perl先my$time=Unixtimestamp然后my($sec,$min,$hour,$day,$month,$year)=(localtime($time))[0,1,2,3,4,5,6]PHPdate('r',Unixtimestamp)Node.jsvardate=newDate(time*1000);vartime=date.getTime()/1000;Python先importtime然后time.gmtime(Unixtimestamp)RubyTime.at(Unixtimestamp)SHELLdate+%s//UNIX的時間戳;VBScript/ASPDateAdd("s",Unixtimestamp,"01/01/197000:00:00")VB6DateDiff("s","1970-1-10:0:0",ToUnixTime)易語言時間_到時間戳（）11.短信DEMO語言DEMO地址PHP/demo/sms/php.htmlJAVA/demo/sms/java.htmlASP/demo/sms/asp.htmlASP.NET(C#)/demo/sms/aspx.htmlJSP/demo/sms/jsp.htmlC/demo/sms/c.htmlC++/demo/sms/cpp.htmlDELPHI/demo/sms/delphi.htmlGO/demo/sms/go.htmlNODE.JS/demo/sms/nodejs.htmlPYTHON/demo/sms/python.htmlRUBY/demo/sms/ruby.htmlSHELL/demo/sms/shell.htmlVB6/demo/sms/vb6.html易語言/demo/sms/eyuyan.html12.短信插件語言下載地址ECtouch