本文檔主要提供給互億平臺的用戶對接接口的使用說明,開發(fā)者可以利用 ihuyi 提供的 HTTP 接口,調用 ihuyi 的語音驗證碼服務。
本文檔包含語音發(fā)送、余額查詢、發(fā)送回執(zhí)推送等。
GET / POST
1、采用HTTPS協(xié)議提交請求
2、通過MD5動態(tài)簽名方式加密
登錄用戶中心,進入【語音驗證碼】模塊,在【產品總攬】頁面右上角,如下圖所示:
通過POST、 GET 方式進行語音發(fā)送提交,內容格式為:Content-Type: application/x-www-form-urlencoded,數(shù)據編碼采用utf-8格式。
http://api.voice.ihuyi.com/webservice/voice.php?method=Submit
參數(shù)名稱 | 參數(shù)值描述 | 必填 |
account | APIID(請登錄用戶中心【語音驗證碼】-【產品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【語音驗證碼】-【產品縱覽】查看) 2、動態(tài)密碼(生成動態(tài)密碼方式請看該文檔末尾的說明) |
是 |
mobile | 接收手機號碼,只能提交1個號碼 | 是 |
content | 驗證碼(4-6位數(shù)字) | 是 |
time | Unix時間戳(10位整型數(shù)字,當使用動態(tài)密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統(tǒng)默認為xml) | 否 |
用戶通過http 或 https提交發(fā)送短信請求到服務器后,服務器會返回一串xml格式的字符串,SubmitResult結構說明如下:
參數(shù)名稱 | 類型 | 描述 |
code | int | 返回值為2時,表示提交成功 |
voiceid | string | 當提交成功后,此字段為流水號,否則為0 |
msg | string | 提交結果描述 |
示例(成功)
2
提交成功 60495654
示例(失?。?/p>
405
account或password不正確 0
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 語音內容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
40505 | 沒有簽定合同 |
4051 | 剩余條數(shù)不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內容含有敏感字符 |
4070 | 語音驗證碼內容必須為4-6位數(shù)字 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯(lián)系。 |
http://api.voice.ihuyi.com/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=1125
通過POST、 GET 方式查詢你的賬戶語音驗證碼剩余條數(shù),內容格式為:Content-Type: application/x-www-form-urlencoded,數(shù)據編碼采用utf-8格式。
http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum
參數(shù)名稱 | 參數(shù)值描述 | 是否必填 |
account | APIID(請登錄用戶中心【語音驗證碼】-【產品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【語音驗證碼】-【產品縱覽】查看) 2、動態(tài)密碼(生成動態(tài)密碼方式請看該文檔末尾的說明) |
是 |
time | Unix時間戳(10位整型數(shù)字,當使用動態(tài)密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統(tǒng)默認為xml) | 否 |
用戶通過http 或 https提交帳戶余額查詢請求到服務器后,服務器會返回一串xml格式的字符串,GetNumResult結構說明如下:
參數(shù)名稱 | 類型 | 描述 |
code | int | 狀態(tài)返回值 |
msg | string | 查詢結果描述 |
num | string | 剩余數(shù)量 |
示例(成功)
2
查詢成功 856
示例(失敗)
405
account或password不正確 0
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY
用戶先提供數(shù)據接收地址,然后綁定到互億無線系統(tǒng)后臺,平臺會以POST方式實時的將回執(zhí)信息推送到此地址,內容格式為:Content-Type: application/x-www-form-urlencoded。
參數(shù)名稱 | 參數(shù)值描述 |
code | 狀態(tài)值(2成功 0失?。?/td> |
msg | 回執(zhí)狀態(tài)說明 |
mobilephone | 手機號碼 |
talktime | 接聽時間(秒) |
voiceid | 流水號(對應提交時返回的voiceid) |
report_time | 回執(zhí)時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。
code 參數(shù)說明
code | msg |
2 | 成功 |
0 | 未知錯誤 |
-1 | 關機 |
-2 | 停機 |
-3 | 暫時無法接通 |
-4 | 正在通話 |
-5 | 空號 |
-6 | 無人接聽 |
-8 | 呼入限制 |
-9 | 網絡忙 |
-10 | 呼出限制 |
-11 | 線路忙 |
-12 | 用戶拒接 |
以PHP為例,提交語音驗證碼的生成方式:
$time = time(); $password = md5($account.$apikey.$mobile.$content.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx 內容:1125 time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');
查詢剩余條數(shù)的生成方式:
$time = time(); $password = md5($account.$apikey.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');
Unix時間戳參考地址:http://tool.chinaz.com/Tools/unixtime.aspx
驗證碼已發(fā)送到您的手機,請查收!
輸入驗證碼后,點擊“開通體驗賬戶”按鈕可立即開通體驗賬戶。