語音驗(yàn)證碼接口文檔

互億無線語音驗(yàn)證碼APIv2.3中國·上海4008808898互億無線語音驗(yàn)證碼APIv2.3接口說明文件標(biāo)識(shí)Ihuyi_VoiceAPI版本編號(hào)V2.3發(fā)布者上海思銳信息技術(shù)有限公司發(fā)布日期2012-07-18最新更新2021-12-13

目錄255711.概要 382311.1文檔說明 3235711.2接口內(nèi)容 3318981.3提交方式 3273451.4加密方式 327401.5APIID/APIKEY 375902.語音驗(yàn)證碼發(fā)送 4139342.1接口描述 4150852.2請求地址 4137832.3請求參數(shù) 433502.4響應(yīng)示例 4194122.5響應(yīng)參數(shù) 5114832.6GET請求示例 6127923.發(fā)送回執(zhí)推送 6271933.1接口描述 6271633.2推送參數(shù) 7128534.余額查詢 8321464.1接口描述 8326874.2請求地址 879864.3請求參數(shù) 860884.4響應(yīng)示例 837314.5響應(yīng)參數(shù) 958174.6GET請求示例 10200035.生成動(dòng)態(tài)密碼方式 10143376.常見問題 1128226.1如何實(shí)現(xiàn)UNIX時(shí)間戳 11238867.語音驗(yàn)證碼DEMO 12196788.聯(lián)系方式 131.概要1.1文檔說明本文檔主要提供給互億平臺(tái)的用戶對接接口的使用說明，開發(fā)者可以利用ihuyi提供的HTTP接口，調(diào)用ihuyi的語音驗(yàn)證碼服務(wù)。1.2接口內(nèi)容本文檔包含語音驗(yàn)證碼發(fā)送、余額查詢等。1.3提交方式GET/POST1.4加密方式1、采用HTTPS協(xié)議提交請求2、通過MD5動(dòng)態(tài)簽名方式加密1.5APIID/APIKEY登錄用戶中心，進(jìn)入【語音驗(yàn)證碼】模塊，在【產(chǎn)品總攬】頁面右上角，如下圖所示：

2.語音驗(yàn)證碼發(fā)送2.1接口描述通過POST、GET方式進(jìn)行語音提交，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded，24小時(shí)全天發(fā)送。2.2請求地址/webservice/voice.php?method=Submit2.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【語音驗(yàn)證碼】-【產(chǎn)品縱覽】查看）是password1、APIKEY（請登錄用戶中心【語音驗(yàn)證碼】-【產(chǎn)品縱覽】查看）2、動(dòng)態(tài)密碼（生成動(dòng)態(tài)密碼方式請看該文檔末尾的說明）是mobile接收手機(jī)號(hào)碼，只能提交一個(gè)號(hào)碼是content驗(yàn)證碼（4-6位數(shù)字）是timeUnix時(shí)間戳（10位整型數(shù)字，當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交發(fā)送短信請求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，SubmitResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint返回值為2時(shí)，表示提交成功voiceidstring當(dāng)提交成功后，此字段為流水號(hào)，否則為0msgstring提交結(jié)果描述2.4響應(yīng)示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>2</code><msg>提交成功</msg><voiceid>60495654</voiceid></SubmitResult>示例（失?。?lt;?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns=""><code>405</code><msg>用戶名或密碼不正確</msg><voiceid>0</voiceid></SubmitResult>2.5響應(yīng)參數(shù)codemsg0提交失敗2提交成功400非法ip訪問401帳號(hào)不能為空402密碼不能為空403手機(jī)號(hào)碼不能為空4030手機(jī)號(hào)碼已被列入黑名單404語音驗(yàn)證碼內(nèi)容不能為空405用戶名或密碼不正確4050賬號(hào)被凍結(jié)4051剩余條數(shù)不足4052訪問ip與備案ip不符406手機(jī)格式不正確407短信內(nèi)容含有敏感字符4070語音驗(yàn)證碼內(nèi)容必須為4-6位數(shù)字408您的帳戶疑被惡意利用，已被自動(dòng)凍結(jié)，如有疑問請與客服聯(lián)系2.6GET請求示例/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號(hào)碼&content=11253.發(fā)送回執(zhí)推送3.1接口描述用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺(tái)，平臺(tái)會(huì)以POST方式實(shí)時(shí)的將回執(zhí)信息推送到此地址，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。3.2推送參數(shù)參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功0失敗）msg回執(zhí)狀態(tài)說明mobilephone手機(jī)號(hào)碼talktime接聽時(shí)間（秒）voiceid流水號(hào)（對應(yīng)提交時(shí)返回的voiceid）report_time回執(zhí)時(shí)間例：2018-05-2417:46:50注意:成功接收請輸出字符“success”（不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。code參數(shù)說明codemsg2成功0未知錯(cuò)誤-1關(guān)機(jī)-2停機(jī)-3暫時(shí)無法接通-4正在通話-5空號(hào)-6無人接聽-8呼入限制-9網(wǎng)絡(luò)忙-10呼出限制-11線路忙-12用戶拒接4.余額查詢4.1接口描述通過接口可以方便的查詢你的賬戶語音驗(yàn)證碼剩余條數(shù)。4.2請求地址/webservice/voice.php?method=GetNum4.3請求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（請登錄用戶中心【語音驗(yàn)證碼】-【產(chǎn)品縱覽】查看）是password1、APIKEY（請登錄用戶中心【語音驗(yàn)證碼】-【產(chǎn)品縱覽】查看）2、動(dòng)態(tài)密碼（生成動(dòng)態(tài)密碼方式請看該文檔末尾的說明）是timeUnix時(shí)間戳（10位整型數(shù)字，當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交帳戶余額查詢請求到服務(wù)器后，服務(wù)器會(huì)返回一串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><voiceid>856</voiceid></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帳號(hào)不能為空402密碼不能為空405用戶名或密碼不正確4050賬號(hào)被凍結(jié)4.6GET請求示例/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY5.生成動(dòng)態(tài)密碼方式以PHP為例，提交語音驗(yàn)證碼的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號(hào)：138xxxxxxxx內(nèi)容：1125time：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');查詢剩余條數(shù)的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號(hào)：138xxxxxxxxtime：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix時(shí)間戳參考地址：/Tools/unixtime.aspx6.常見問題6.1如何實(shí)現(xiàn)UNIX時(shí)間戳語言代碼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的時(shí)間戳;VBScript/ASPDateAdd("s",Unixtimestamp,"01/01/197000:00:00")VB6DateDiff("s","1970-1-10:0:0",ToUnixTime)易語言時(shí)間_到時(shí)間戳（）7.語音驗(yàn)證碼DEMO語言DEMO地址PHP/demo/voice/php.htmlJAVA/demo/voice/java.htmlASP/demo/voice/asp.htmlASP.NET(C#)/demo/voice/aspx.h