國際驗證碼接口文檔

互億無線國際/港澳臺短信APIv2.1中國·上海4008808898互億無線國際/港澳臺短信APIv2.1接口說明文件標(biāo)識Ihuyi_InternationalAPI版本編號V2.1發(fā)布者上海思銳信息技術(shù)有限公司發(fā)布日期2012-08-15最新更新2021-12-13

目錄217661.概要 4242381.1文檔說明 4222861.2接口內(nèi)容 489161.3提交方式 45101.4加密方式 4147171.5APIID/APIKEY 4324471.6國際/港澳臺短信模版 4275632.國際/港澳臺短信發(fā)送 6120322.1接口描述 6179582.2請求地址 679252.3請求參數(shù) 6134902.4響應(yīng)示例 7251332.5響應(yīng)參數(shù) 7245982.6GET請求示例 871643.發(fā)送回執(zhí)推送 9116093.1接口描述 9144073.2推送參數(shù) 9286334.余額查詢 9163204.1接口描述 9115614.2請求地址 9191404.3請求參數(shù) 1022694.4響應(yīng)示例 10288044.5響應(yīng)參數(shù) 11244884.6GET請求示例 11153935.生成動態(tài)密碼方式 1252416.常見問題 13163436.1如何處理亂碼 13264936.2如何實現(xiàn)UNIX時間戳 13241857.國際/港澳臺短信DEMO 14118218.聯(lián)系方式 15

1.概要1.1文檔說明本文檔主要提供給互億平臺的用戶對接接口的使用說明，開發(fā)者可以利用ihuyi提供的HTTP接口，調(diào)用ihuyi的國際驗證碼服務(wù)。1.2接口內(nèi)容本文檔包含國際/港澳臺短信發(fā)送、余額查詢、發(fā)送回執(zhí)推送等。1.3提交方式GET/POST1.4加密方式1、采用HTTPS協(xié)議提交請求2、通過MD5動態(tài)簽名方式加密1.5APIID/APIKEY登錄用戶中心，進(jìn)入【國際短信】模塊，在【產(chǎn)品總攬】頁面右上角，如下圖所示：1.6國際/港澳臺短信模版國際短信模板是對您將要發(fā)送的國際短信短信進(jìn)行相似性提取后的內(nèi)容。舉個例子，A用戶在您平臺注冊會員，需要發(fā)送一條國際驗證短信，內(nèi)容如下：您好，您的驗證碼是：666666同時，B用戶也在您的平臺注冊會員，發(fā)送了如下國際驗證短信：您好，您的驗證碼是：888888我們提取相似度以后，可以制作以下國際驗證短信模板：您好，您的驗證碼是：【變量】其中，變量是可變的，可以是數(shù)字、字母、漢字。

2.國際/港澳臺短信發(fā)送2.1接口描述通過POST、GET方式進(jìn)行短信提交，數(shù)據(jù)編碼采用utf-8格式，24小時全天發(fā)送。內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded注意:國際接口發(fā)送國內(nèi)手機(jī)號只能作為測試使用，短信內(nèi)容后面會自動加上固定簽名。2.2請求地址/webservice/isms.php?method=Submit2.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【國際短信】-【產(chǎn)品縱覽】查看）是password1、APIKEY（請登錄用戶中心【國際短信】-【產(chǎn)品縱覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）是mobile接收手機(jī)號碼，只能提交一個號碼。（格式為：國家號+空格+手機(jī)號）是content短信內(nèi)容是timeUnix時間戳（10位整型數(shù)字，當(dāng)使用動態(tài)密碼方式時為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交發(fā)送短信請求到服務(wù)器后，服務(wù)器會返回一串xml格式的字符串，SubmitResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint返回值為2時，表示提交成功ismsidstring當(dāng)提交成功后，此字段為流水號，否則為0msgstring提交結(jié)果描述2.4響應(yīng)示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>2</code><msg>提交成功</msg><ismsid>60495654</ismsid></SubmitResult>示例（失敗）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>405</code><msg>用戶名或密碼不正確</msg><ismsid>0</ismsid></SubmitResult>2.5響應(yīng)參數(shù)codemsg0提交失敗2提交成功400非法ip訪問401帳號不能為空402密碼不能為空403手機(jī)號碼不能為空4030手機(jī)號碼已被列入黑名單404短信內(nèi)容不能為空405用戶名或密碼不正確4050賬號被凍結(jié)4051剩余條數(shù)不足4052訪問ip與備案ip不符406手機(jī)格式或國家號不正確，正確格式為：國家號+空格+手機(jī)號407短信內(nèi)容含有敏感字符4071沒有提交備案模板4072提交的短信內(nèi)容必須與報備過的模板格式相匹配40722變量內(nèi)容超過指的的長度4073短信內(nèi)容超出長度限制408您的帳戶疑被惡意利用，已被自動凍結(jié)，如有疑問請與客服聯(lián)系2.6GET請求示例/webservice/isms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號碼&content=Yourverificationcodeis11253.發(fā)送回執(zhí)推送3.1接口描述用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺，平臺會以POST方式實時的將回執(zhí)信息推送到此地址，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。3.2推送參數(shù)參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功其他為失敗）msg回執(zhí)狀態(tài)說明mobilephone手機(jī)號碼ismsid流水號（對應(yīng)提交時返回的ismsid）report_time回執(zhí)時間例：2018-05-2417:46:50注意:成功接收請輸出字符“success”（不包含引號）結(jié)束推送，否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。4.余額查詢4.1接口描述通過接口可以方便的查詢你的賬戶國際短信剩余條數(shù)。4.2請求地址/webservice/isms.php?method=GetNum4.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【國際短信】-【產(chǎn)品縱覽】查看）是password1、APIKEY（請登錄用戶中心【國際短信】-【產(chǎn)品縱覽】查看）2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）是timeUnix時間戳（10位整型數(shù)字，當(dāng)使用動態(tài)密碼方式時為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交帳戶余額查詢請求到服務(wù)器后，服務(wù)器會返回一串xml格式的字符串，GetNumResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint狀態(tài)返回值msgstring查詢結(jié)果描述numstring剩余數(shù)量4.4響應(yīng)示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>2</code><msg>查詢成功</msg><ismsid>5002</ismsid></GetNumResult>示例（失?。?lt;?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns=""><code>405</code><msg>用戶名或密碼不正確</msg><num>0</num></GetNumResult>4.5響應(yīng)參數(shù)codemsg2查詢成功400非法ip訪問401帳號不能為空402密碼不能為空405用戶名或密碼不正確4050賬號被凍結(jié)4.6GET請求示例/webservice/isms.php?method=GetNum&account=APIID&password=APIKEY5.生成動態(tài)密碼方式以PHP為例，提交驗證碼短信的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號：138xxxxxxxx內(nèi)容：Yourverificationcodeis1125time：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxxYourverificationcodeis11251451544941');注意：因為短信內(nèi)容會包含unicode字符，所以字符編碼統(tǒng)一為UTF-8。查詢剩余條數(shù)的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號：138xxxxxxxxtime：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix時間戳參考地址：/Tools/unixtime.aspx6.常見問題6.1如何處理亂碼說明：將短信內(nèi)容（content）進(jìn)行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());6.2如何實現(xiàn)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)易語言時間_到時間戳（）7.國際/港澳臺短信DEMO語言DEMO地址PHP/demo/sms_international/php.htmlJAVA/demo/sms_international/java.htmlASP/demo/sms_international/asp.htmlASP.NET(C#)/demo/sms_international/aspx.htmlJSP/demo/sms_international/jsp.htmlC/d