功能示例 / Example
開發(fā)流程 / Process
-
注冊開發(fā)者賬號
-
免費測試語音發(fā)送
-
購買語音套餐
-
快速調用接口
-
完成開發(fā)
接口介紹 / Introduction
-
靈活接入
標準HTTP(S)協(xié)議,提供完善的技術開發(fā)文檔
-
高效穩(wěn)定
智能運維系統(tǒng)實時監(jiān)控,一主四備短信通道,保障超高到達率
-
技術服務
7*24小時售后服務,專業(yè)運維實時監(jiān)控
應用場景 / Scenes
-
用戶注冊/登錄
適用于網(wǎng)站/APP的語音驗證碼登錄、賬號注冊場景,保障企業(yè)賬號體系安全
-
安全支付
適用于線上支付環(huán)節(jié),有效確保用戶支付安全
-
賬號綁定
適用于有會員賬號體系的企業(yè),維護企業(yè)賬號體系安全
- 概要
- 語音發(fā)送
- 余額查詢
- 發(fā)送回執(zhí)推送
- 生成動態(tài)密碼方式
1、概要
1.1 文檔說明
本文檔主要提供給互億平臺的用戶對接接口的使用說明,開發(fā)者可以利用 ihuyi 提供的 HTTP 接口,調用 ihuyi 的語音驗證碼服務。
1.2 接口內(nèi)容
本文檔包含語音發(fā)送、余額查詢、發(fā)送回執(zhí)推送等。
1.3 提交方式
GET / POST
1.4 加密方式
1、采用HTTPS協(xié)議提交請求
2、通過MD5動態(tài)簽名方式加密
1.5 API ID / API KEY
登錄用戶中心,進入【語音驗證碼】模塊,在【產(chǎn)品總攬】頁面右上角,如下圖所示:
2、語音發(fā)送
2.1 接口描述
通過POST、 GET 方式進行短信提交,數(shù)據(jù)編碼采用utf-8格式,24小時全天發(fā)送。
2.2 請求地址
http://api.voice.ihuyi.com/webservice/voice.php?method=Submit
2.3 請求參數(shù)
參數(shù)名稱 | 參數(shù)值描述 | 必填 |
account | APIID(請登錄用戶中心【語音驗證碼】-【產(chǎn)品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【語音驗證碼】-【產(chǎn)品縱覽】查看) 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時,表示提交成功 |
smsid | string | 當提交成功后,此字段為流水號,否則為0 |
msg | string | 提交結果描述 |
2.4 響應示例
示例(成功)
2
提交成功 60495654
示例(失敗)
405
用戶名或密碼不正確 0
2.5 響應參數(shù)
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 語音內(nèi)容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數(shù)不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內(nèi)容含有敏感字符 |
4070 | 語音驗證碼內(nèi)容必須為4-6位數(shù)字 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯(lián)系。 |
2.6 請求示例
http://api.voice.ihuyi.com/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=1125
3、余額查詢
3.1 接口描述
通過接口可以方便的查詢你的賬戶語音驗證碼剩余條數(shù)。
3.2 請求地址
http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum
3.3 請求參數(shù)
參數(shù)名稱 | 參數(shù)值描述 | 是否必填 |
account | APIID(請登錄用戶中心【語音驗證碼】-【產(chǎn)品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【語音驗證碼】-【產(chǎn)品縱覽】查看) 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ù)量 |
3.4 響應示例
示例(成功)
2
查詢成功 856
示例(失敗)
405
用戶名或密碼不正確 0
3.5 響應參數(shù)
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
3.6 GET請求示例
http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY
4、發(fā)送回執(zhí)推送
4.1 接口描述
用戶先提供數(shù)據(jù)接收地址,然后綁定到互億無線系統(tǒng)后臺,平臺會以POST方式實時的將回執(zhí)信息推送到此地址。
4.2 推送參數(shù)
參數(shù)名稱 | 參數(shù)值描述 |
code | 狀態(tài)值(2成功 其他為失敗) |
msg | 回執(zhí)狀態(tài)說明 |
mobilephone | 手機號碼 |
task_id | 流水號(對應提交時返回的task_id) |
report_time | 回執(zhí)時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。
5、生成動態(tài)密碼方式
以PHP為例,提交語音驗證碼的生成方式:
$time = time(); $password = md5($account.$apikey.$mobile.$content.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx 內(nèi)容: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ā)送錯誤碼參照:
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 語音內(nèi)容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數(shù)不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內(nèi)容含有敏感字符 |
4070 | 語音驗證碼內(nèi)容必須為4-6位數(shù)字 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯(lián)系。 |
余額查詢錯誤碼參照:
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
代碼示例
常見問題
目錄 | 詳情鏈接 |
模板審核標準 | http://422ajvm.cn/faq/qianmingguifan.html |
簽名審核標準 | http://422ajvm.cn/faq/qianmingshenhebiaozhun.html |
支付問題 | http://422ajvm.cn/faq/pay.html |
賬號問題 | http://422ajvm.cn/faq/account.html |
產(chǎn)品問題 | http://422ajvm.cn/faq/voice.html |
客戶服務
內(nèi)容 | 聯(lián)系方式 |
400熱線 | 400-880-8898 |
聯(lián)系電話 | 021-5169 8929 |
郵箱 | service@ihuyi.com |
郵政編碼 | 201203 |
市場合作/渠道代理
內(nèi)容 | 聯(lián)系方式 |
聯(lián)系電話 | 15902129325 |
郵箱 | linsn@ihuyi.com |
技術支持
內(nèi)容 | 聯(lián)系方式 |
聯(lián)系電話 | 4008 808 898 |
郵箱 | support@ihuyi.com |
公司地址
內(nèi)容 | 聯(lián)系方式 |
上??偣?/td> | 上海市浦東新區(qū)納賢路800號A座401 |
南京分公司 | 南京市秦淮區(qū)瞻園路19號 |
成都分公司 | 中國(四川)自由貿(mào)易試驗區(qū)成都高新區(qū)天府街69號 |