功能示例 / Example

语音接口

开发流程 / Process

  • 注册开发者账号

  • 免费测试语音发送

  • 购买语音套餐

  • 快速调用接口

  • 完成开发

接口介绍 / Introduction

  • 灵活接入

    标准HTTP(S)协议,提供完善的技术开发文档

  • 稳定发送

    智能运维系统实时监控,一主四备短信通道,保障超高到达率

  • 专业服务

    专业技术团队答疑解难,24小时运维监控

应用场景 / Scenes

  • 登录注册

    适用于网站/APP的语音验证码登录、账号注册场景,保障企业账号体系安全

  • 安全支付

    适用于网站/APP执行付款操作,为财产安全保驾护航

  • 密码找回

    适用于网站/APP的身份校验场景,简单高效地维护企业账号体系安全

  • 概要
  • 语音发送
  • 余额查询
  • 发送回执推送
  • 生成动态密码方式

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 方式进行短信提交,数据编码采用utf-8格式,24小时全天发送。

2.2 请求地址

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

2.3 请求参数

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

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

参数名称 类型 描述
code int 返回值为2时,表示提交成功
smsid string 当提交成功后,此字段为流水号,否则为0
msg string 提交结果描述

2.4 响应示例

示例(成功)


 2 提交成功 60495654 

示例(失败)


 405 用户名或密码不正确 0 

2.5 响应参数

code msg
0 提交失败
2 提交成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
403 手机号码不能为空
4030 手机号码已被列入黑名单
404 语音内容不能为空
405 用户名或密码不正确
4050 账号被冻结
4051 剩余条数不足
4052 访问ip与备案ip不符
406 手机格式不正确
407 短信内容含有敏感字符
4070 语音验证码内容必须为4-6位数字
408 您的帐户疑被恶意利用,已被自动冻结,如有疑问请与客服联系。

2.6 请求示例

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

3、余额查询

3.1 接口描述

通过接口可以方便的查询你的账户语音验证码剩余条数。

3.2 请求地址

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

3.3 请求参数

参数名称 参数值描述 是否必填
account APIID(请登录用户中心【语音验证码】-【产品纵览】查看)
password 1、APIKEY(请登录用户中心【语音验证码】-【产品纵览】查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
format 返回格式(可选值为:xml或json,系统默认为xml)

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

参数名称 类型 描述
code int 状态返回值
msg string 查询结果描述
num string 剩余数量

3.4 响应示例

示例(成功)


 2 查询成功 856 

示例(失败)


 405 用户名或密码不正确 0 

3.5 响应参数

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、发送回执推送

4.1 接口描述

用户先提供数据接收地址,然后绑定到互亿无线系统后台,平台会以POST方式实时的将回执信息推送到此地址。

4.2 推送参数

参数名称 参数值描述
code 状态值(2成功 其他为失败)
msg 回执状态说明
mobilephone 手机号码
task_id 流水号(对应提交时返回的task_id)
report_time 回执时间

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

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

语音发送错误码参照:

code msg
0 提交失败
2 提交成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
403 手机号码不能为空
4030 手机号码已被列入黑名单
404 语音内容不能为空
405 用户名或密码不正确
4050 账号被冻结
4051 剩余条数不足
4052 访问ip与备案ip不符
406 手机格式不正确
407 短信内容含有敏感字符
4070 语音验证码内容必须为4-6位数字
408 您的帐户疑被恶意利用,已被自动冻结,如有疑问请与客服联系。

余额查询错误码参照:

code msg
2 查询成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
405 用户名或密码不正确
4050 账号被冻结

代码示例

语言 详情链接
PHP https://www.ihuyi.com/demo/voice/php.html
JAVA https://www.ihuyi.com/demo/voice/java.html
ASP https://www.ihuyi.com/demo/voice/asp.html
ASP.NET(C#) https://www.ihuyi.com/demo/voice/aspx.html
JSP https://www.ihuyi.com/demo/voice/jsp.html
C https://www.ihuyi.com/demo/voice/c.html
C++ https://www.ihuyi.com/demo/voice/cpp.html
GO https://www.ihuyi.com/demo/voice/go.html
PYTHON https://www.ihuyi.com/demo/voice/python.html
SHELL https://www.ihuyi.com/demo/voice/shell.html
VB6 https://www.ihuyi.com/demo/voice/vb6.html

常见问题

目录 详情链接
模板审核标准 https://www.ihuyi.com/faq/qianmingguifan.html
签名审核标准 https://www.ihuyi.com/faq/qianmingshenhebiaozhun.html
支付问题 https://www.ihuyi.com/faq/pay.html
账号问题 https://www.ihuyi.com/faq/account.html
产品问题 https://www.ihuyi.com/faq/voice.html

客户服务

内容 联系方式
400热线 400-880-8898
联系电话 021-5169 8929
邮箱 service@ihuyi.com
邮政编码 201203

市场合作/渠道代理

内容 联系方式
联系电话 15902129325
邮箱 linsn@ihuyi.com

技术支持

内容 联系方式
联系电话 4008 808 898
邮箱 support@ihuyi.com

公司地址

内容 联系方式
上海总公司 上海市浦东新区纳贤路800号A座401
南京分公司 南京市秦淮区瞻园路19号
成都分公司 中国(四川)自由贸易试验区成都高新区天府街69号

热门接口

在线咨询
电话咨询

服务热线:

4008 808 898

服务热线(工作时间):

4008 808 898

业务咨询(非工作时间):

售后咨询(非工作时间):

验证码已发送到您的手机,请查收!

输入验证码后,点击“开通体验账户”按钮可立即开通体验账户。

收不到短信验证码?
互亿无线不提供接码服务,接码用户请勿点击开通按钮。
×