语音验证码 - API文档

1、概要

1.1 文档说明

本文档主要提供给互亿平台的用户对接接口的使用说明，开发者可以利用 ihuyi 提供的 HTTP 接口，调用 ihuyi 的语音验证码服务。

1.2 接口内容

本文档包含语音发送、余额查询、发送回执推送等。

1.3 提交方式

GET / POST

1.4 加密方式

1、采用HTTPS协议提交请求
2、通过MD5动态签名方式加密

1.5 API ID / API KEY

登录用户中心，进入【语音验证码】模块，在【产品总揽】页面右上角，如下图所示：

2、语音发送

2.1 接口描述

通过POST、 GET 方式进行语音发送提交，内容格式为：Content-Type: application/x-www-form-urlencoded，数据编码采用utf-8格式。

2.2 请求地址

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

2.3 请求参数

用户通过http 或 https提交发送短信请求到服务器后，服务器会返回一串xml格式的字符串，SubmitResult结构说明如下：

2.4 响应示例

示例（成功）

  2 提交成功 60495654 

示例（失败）

  405 account或password不正确 0 

2.5 响应参数

2.6 请求示例

http://api.voice.ihuyi.com/webservice/voice.php?method=Submit&account=APIID&password=APIKEY&mobile=手机号码&content=1125

3、余额查询

3.1 接口描述

通过POST、 GET 方式查询你的账户语音验证码剩余条数，内容格式为：Content-Type: application/x-www-form-urlencoded，数据编码采用utf-8格式。

3.2 请求地址

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

3.3 请求参数

用户通过http 或 https提交帐户余额查询请求到服务器后，服务器会返回一串xml格式的字符串，GetNumResult结构说明如下：

3.4 响应示例

示例（成功）

  2 查询成功 856 

示例（失败）

  405 account或password不正确 0 

3.5 响应参数

3.6 GET请求示例

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

4、发送回执推送

4.1 接口描述

用户先提供数据接收地址，然后绑定到互亿无线系统后台，平台会以POST方式实时的将回执信息推送到此地址，内容格式为：Content-Type: application/x-www-form-urlencoded。

4.2 推送参数

注意: 成功接收请输出字符 "success" （不包含引号）结束推送，否则以接收失败处理。每个回执最多推送3次。每次间隔叠加60秒。

code 参数说明

5、生成动态密码方式

以PHP为例，提交语音验证码的生成方式：

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手机号：138xxxxxxxx
内容：1125
time：1451544941
结果：$password=md5("test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941");

查询剩余条数的生成方式：

$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