互亿无线企业应用平台文档中心

语音验证码API接口文档下载:  点击下载

1. GET提交语音验证码接口示例

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

注:请将1125替换成4-6位数字,APIKEY可以登录用户中心查看

2. POST提交语音验证码接口

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

接口说明
参数名称 参数值描述 是否必填
account 账户名(例如:cf_demo123)
password 1、APIKEY(32位字符串,可以登录用户中心查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
mobile 接收手机号码,只能提交1个号码
content 验证码(4-6位数字)
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
format 返回格式(可选值为:xml或json,系统默认为xml)

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

SubmitResult结构说明:
参数名称 类型 描述
code int 返回值为2时,表示提交成功
smsid string 当提交成功后,此字段为流水号,否则为0
msg string 提交结果描述
示例(成功)
<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="api.voice.ihuyi.com">
<code>2</code>
<msg>提交成功</msg>
<smsid>60495654</smsid>
</SubmitResult>
示例(失败)
<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="api.voice.ihuyi.com">
<code>405</code>
<msg>用户名或密码不正确</msg>
<smsid>0</smsid>
</SubmitResult>
Code(返回代码)值说明
code msg
0 提交失败
2 提交成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
403 手机号码不能为空
4030 手机号码已被列入黑名单
404 语音验证码内容不能为空
405 用户名或密码不正确
4050 账号被冻结
4051 剩余条数不足
4052 访问ip与备案ip不符
406 手机格式不正确
407 语音验证码内容必须为4-6位数字
408 您的帐户疑被恶意利用,已被自动冻结,如有疑问请与客服联系。

注意:因运营商规则变化,如有返回值在上述表格中找不到,请咨询您的专属客服

3. GET帐户余额查询示例:

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

4. POST帐户余额查询

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

接口说明
参数名称 参数值描述 是否必填
account 账户名(例如:cf_demo123)
password 1、APIKEY(32位字符串,可以登录用户中心查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
format 返回格式(可选值为:xml或json,系统默认为xml)

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

GetNumResult 结构说明:
参数名称 类型 描述
code int 状态返回值
msg string 查询结果描述
num string 剩余数量
示例(成功)
<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="api.voice.ihuyi.com">
<code>2</code>
<msg>查询成功</msg>
<smsid>856</smsid>
</GetNumResult>
示例(失败)
<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="api.voice.ihuyi.com">
<code>405</code>
<msg>用户名或密码不正确</msg>
<smsid>0</smsid>
</GetNumResult>
Code(返回代码)值说明
code msg
2 查询成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
405 用户名或密码不正确
4050 账号被冻结

附件:生成签名方式

这里以PHP为例:
提交短信的生成方式:

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

例如:

帐号:cf_test
APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d
手机号:138xxxxxxxx
内容:1125
time:1451544941
结果:$password=md5('cf_test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx11251451544941');

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

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

例如:

帐号:cf_test
APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d
手机号:138xxxxxxxx
time:1451544941
结果:$password=md5('cf_test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');

Unix时间戳参考地址:http://tool.chinaz.com/Tools/unixtime.aspx