接口文档
语音验证码接口文档
5886 2018-11-29 17:36:03 中昱维信
本文档仅使用于中昱维信语音验证码接口。PDF文档请点击下载
1.接口概览
1.1 语音验证码介绍
中昱维信语音验证码接口，拥有专业的技术和稳定的平台以及优质的通道资源7*24 小时服务监控等优势。中昱维信语音验证码可以快速稳定高效的将验证码告知手机用户。这样就可以避免因为服务商或者是网络以及手机质量的问题导致验证码无法及时送达。采取语音式的验证码可以保障验证码准确及时的传递。
1。2 功能介绍
本文档主要提供给中昱维信平台的用户对接接口的使用说明，开发者可以利用中昱维信提供的HTTP 接口，调用中昱维信的语音验证码服务。很多的网站或者是平台为了保障用户的利益，因此会采取验证码的方式，但是很多人懒于接受短信验证码，而放弃继续关注网站或者是在平台的注册。而这样的情况下中昱维信自动的语音验证码服务更使得用户的体验度增加。这样就可以保障交易环节，注册环节更为简单，而不是一味的需要进行短信查询，语音验证码既减少了验证码遭到泄露，而且还能够避免因为验证码延迟耽误用户的时间。
2.开始接入
2.1 接入说明
语音验证码服务属于收费功能，用户可按照自己的使用量自助购买服务条数。发送语音验证时单次向接口提交的手机号码应为一个。接入之前请先进行企业认证，在平台获取接入必须的参数。
注册登录中昱维信短彩信平台，可查看语音验证码接入指南、状态码参考、demo示例以及常见问题。
中昱维信短彩信平台还可进行在线语音接口测试,位置在左侧栏目列表中的“常用工具”---“功能&接口测试”
.png)
注：短彩信平台注册登录在网站右上角,平台使用方法可查看：语音验证码接入指南
2.2 接入流程
用户接入中昱维信语音验证码一共需要 5 个步骤，具体步骤如下
开始使用
中昱维信语音验证码首先要在中昱维信官网注册账号,官网右上角登录/注册即可。
完成企业实名认证
完成了注册之后登录平台 打开系统设置->账户资料,上传相应的企业资质
充值语音验证码产品
平台支持线下和线上充值选择产品然后进行充值
获取账号
从平台获取注册账号的AppID和AppKey
请求地址
|
参数名称 |
含义 |
参数值 |
必填 |
|
appId |
平台自动生成的唯一账户标识 |
2RYN7CQHL1M***** |
是 |
|
appkey |
平台自动生成的唯一账户标识 |
WVNA4A0***** |
是 |
|
phone |
需要发送的手机号码 |
1508092**** |
是 |
|
variables |
变量,即要发送的的验证码 |
2312 |
是 |
提交语音验证码要求
手机号码为11位，变量（验证码）的长度一般为4-8位随机数,随机数由接入方生成提供；中昱维信平台/接口不提供验证码生成服务。
返回参数详解
|
returnStatus |
返回状态 |
|
message |
返回信息 |
|
remainpoint |
返回余额 |
|
taskId |
任务ID |
|
successCounts |
成功条数 |
|
（Sentid） |
（可忽略） |
正确返回参数实例
{
"returnStatus": "2000 ",
"message": "发送成功",
"remainpoint": "145",
"taskId": "3253693",
"successCounts":0",
"sentid": "null"
}
错误返回参数实例
{
"returnStatus": "4002 ",
"message": "手机格式不正确",
"remainpoint": "null",
"taskId": "null",
"successCounts": "0",
"sentid": "null"
}
统一返回参数
|
4005 |
参数错误 |
|
4000 |
账号或密码错误 |
|
4009 |
变量格式错误，应该是4到8位数字 |
|
4001 |
余额不足，请充值 |
|
4002 |
手机号格式不正确 |
|
4003 |
今日手机号发送次数已经达到上限 |
|
4010 |
相同手机号一分钟只能发送一次 |
|
2000 |
发送成功 |
|
4008 |
未知错误，请联系客服 |
|
4010 |
账户被锁定 |
|
4200 |
未进行企业认证，只能发送系统默认模板 |
3.审核说明
企业审核
依据《中华人民共和国网络安全法》相关要求,平台账号必须完成真实身份信息认证后,才可正常使用相关服务,感谢您的理解和支持!用户正式使用本平台所有服务之前,需要先提供企业营业执照（正本或副本）的复印件加盖公章（公章需彩色）,然后在【幸运赛车】-【账户资料】里面完成实名认证。
4。常见问题
语音验证码哪些情况是呼出不成功的？
对方无人接听，对方欠费停机，对方关机的情况下是呼出不成功的。
对方接听会不会重播?
开发者向中昱维信语音验证码接口提交请求之后，若验证码接收方无人接听，系统会自动重拨一次。
接口返回4009错误码?
变量（验证码）的长度一般为4-8位随机数，随机数由接入方生成提供；中昱维信平台/接口不提供验证码生成服务；请开发者注意变量长度。
5.联系我们
联系电话 : 400-68-10658
E-mail : service@veesing.com
代理加盟 : 18019467159
地址 : 上海市浦东新区金科路2966号1幢211室