語(yǔ)音驗(yàn)證碼 - API文檔

1、概要

1.1 文檔說(shuō)明

本文檔主要提供給互億平臺(tái)的用戶(hù)對(duì)接接口的使用說(shuō)明，開(kāi)發(fā)者可以利用 ihuyi 提供的 HTTP 接口，調(diào)用 ihuyi 的語(yǔ)音驗(yàn)證碼服務(wù)。

1.2 接口內(nèi)容

本文檔包含語(yǔ)音發(fā)送、余額查詢(xún)、發(fā)送回執(zhí)推送等。

1.3 提交方式

GET / POST

1.4 加密方式

1、采用HTTPS協(xié)議提交請(qǐng)求
2、通過(guò)MD5動(dòng)態(tài)簽名方式加密

1.5 API ID / API KEY

登錄用戶(hù)中心，進(jìn)入【語(yǔ)音驗(yàn)證碼】模塊，在【產(chǎn)品總攬】頁(yè)面右上角，如下圖所示：

2、語(yǔ)音發(fā)送

2.1 接口描述

通過(guò)POST、 GET 方式進(jìn)行語(yǔ)音發(fā)送提交，內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded，數(shù)據(jù)編碼采用utf-8格式。

2.2 請(qǐng)求地址

http://api.voice.ihuyi.com/webservice/voice.php?method=Submit

2.3 請(qǐng)求參數(shù)

用戶(hù)通過(guò)http 或 https提交發(fā)送短信請(qǐng)求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，SubmitResult結(jié)構(gòu)說(shuō)明如下：

2.4 響應(yīng)示例

示例（成功）

  2 提交成功 60495654 

示例（失?。?/p>

  405 account或password不正確 0 

2.5 響應(yīng)參數(shù)

2.6 請(qǐng)求示例

http://api.voice.ihuyi.com/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號(hào)碼&content=1125

3、余額查詢(xún)

3.1 接口描述

通過(guò)POST、 GET 方式查詢(xún)你的賬戶(hù)語(yǔ)音驗(yàn)證碼剩余條數(shù)，內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded，數(shù)據(jù)編碼采用utf-8格式。

3.2 請(qǐng)求地址

http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum

3.3 請(qǐng)求參數(shù)

用戶(hù)通過(guò)http 或 https提交帳戶(hù)余額查詢(xún)請(qǐng)求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，GetNumResult結(jié)構(gòu)說(shuō)明如下：

3.4 響應(yīng)示例

示例（成功）

  2 查詢(xún)成功 856 

示例（失敗）

  405 account或password不正確 0 

3.5 響應(yīng)參數(shù)

3.6 GET請(qǐng)求示例

http://api.voice.ihuyi.com/webservice/voice.php?method=GetNum&account=APIID&password=APIKEY 

4、發(fā)送回執(zhí)推送

4.1 接口描述

用戶(hù)先提供數(shù)據(jù)接收地址，然后綁定到互億無(wú)線系統(tǒng)后臺(tái)，平臺(tái)會(huì)以POST方式實(shí)時(shí)的將回執(zhí)信息推送到此地址，內(nèi)容格式為：Content-Type: application/x-www-form-urlencoded。

4.2 推送參數(shù)

注意: 成功接收請(qǐng)輸出字符 "success" （不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。

code 參數(shù)說(shuō)明

5、生成動(dòng)態(tài)密碼方式

以PHP為例，提交語(yǔ)音驗(yàn)證碼的生成方式：

$time = time();
$password = md5($account.$apikey.$mobile.$content.$time);

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機(jī)號(hào)：138xxxxxxxx
內(nèi)容：1125
time：1451544941
結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');

查詢(xún)剩余條數(shù)的生成方式：

$time = time();
$password = md5($account.$apikey.$time);

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機(jī)號(hào)：138xxxxxxxx
time：1451544941
結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');

Unix時(shí)間戳參考地址：http://tool.chinaz.com/Tools/unixtime.aspx