======语音验证对接流程图======
{{:语音验证:语音验证码流程图.png?nolink|}}
======开发者账号======
注册或者登录开发者账号流程说明请参考[[..login_singup|登录注册>>]]
======创建应用及申请上线======
创建应用及申请上线流程说明请参考[[..creatnewapp|创建应用及申请上线>>]]
=======资质认证======
申请上线应用之前需完成资质认证,具体认证流程请参考[[..account_authentication|账号认证>>]]
======上传语音验证码铃音文件(可选)======
===1.添加语音===
点击【开发者控制台 >语音验证产品管理】选择"添加语音"按钮,进行添加语音操作。
{{:语音验证:添加语音.png|}}
===2.上传音频文件===
选择正确的语音文件点击上传
{{:语音验证:添加语音文件.png|}}
注:语音验证码铃声,每个应用下可上传多个语音。
语音的格式必须是wav或mp3(不支持直接改后缀名),文件大小不能超过1M。
======接口对接======
===1.语音验证码对接—API===
**URL格式** \\
https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/{function}/{operation}?sig={SigParameter}
**URL参数属性说明** \\
^属性 ^ ^说明 ^
|SoftVersion | | 云之讯REST API版本号,当前版本号为:2014-06-30 |
|Account | |此参数为默认固定值 |
|accountSid | |注册云之讯官网,在控制台中即可获取此参数 |
|function | |业务功能 |
|operation | |业务操作,业务功能的各类具体操作分支 |
|SigParameter | |请求URL必须带有此参数 |
**HTTP标准包头字段(必填)** \\
^属性 ^ ^说明 ^
|Accept | | 客户端响应接收数据格式:application/xml、application/json |
|Content-Type | | 类型:application/xml;charset=utf-8、application/json;charset=utf-8 |
|Authorization | |验证信息 |
|Content-Length | |包体长度 |
**关键点**
SigParameter是REST API 验证参数
URL后必须带有sig参数,sig= MD5(账户Id + 账户授权令牌 + 时间戳),共32位(注:转成大写)
使用MD5加密(账户Id + 账户授权令牌 + 时间戳),共32位
时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”。时间戳有效时间为50分钟。
Authorization是包头验证信息
使用Base64编码(账户Id + 冒号 + 时间戳)
冒号为英文冒号
时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”,需与SigParameter中时间戳相同
===2.语音验证码对接—body===
接口文档连接请参见附录\\
displayNum :
企业认证用户才支持显号功能。未开启显号功能则呼叫会随机显号,设置此参数无效。
语音验证码铃音id (先在官网控制台上传语音文件,语音文件需进行人工审核,审核通过后用户可以直接调用接口传入语音ID+验证码进行外呼,无须再次审核,及时性比较高。)
**请求包体**
^属性 ^类型 ^约束 ^说明 |
|appId |String | 必选 |应用Id|
|verifyCode |String | 必选 |验证码内容,为数字0~9,字母a~z,长度4-8位。说明:字母不区分大小写,特殊字符均为英文状态下输入(¥符号除外)。|
|to |String | 必选 |接收号码 |
|displayNum |String | 可选 |验证码显号 |
|voiceId |String | 可选 |官网铃音文件ID |
|userData |String | 可选 |用户自定义透传字段 ,可通过话单回调返回|
|playTimes |int | 可选 |语音验证码播报次数 |
|templateId |String | 可选 |失败补发短信模板ID |
----
POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Calls/voiceCode?sig=4D3C2549D3A487841CB3D84EA7421FCD
Host:api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODQ3MzQ=
{
"voiceCode":{
"appId":"e462aba25bc6498fa5ada7eefe1401b7",
"to":"18612345678",
"verifyCode":"09071124",
"userData":"self-define follow your heart and rules",
"voiceId":"1124",
"displayNum":"075512345678",
"playTimes":"3"
}
}
----
----
{"resp":{
"respCode":"000000",
"voiceCode":{
"callId":"31d7ca243c406a81611910db21b68876",
"createDate":"20140623184729"}
}
}
----
----
POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Calls/voiceCode.xml?sig=841D35E63BB81C1D13918B4DD6CD988E
Host:api.ucpaas.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8 Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODQ1MjM=
e462aba25bc6498fa5ada7eefe1401b7
18612345678
09071124
self-define follow your heart and rules
1124
075512345678
3
----
----
000000
48dcc7d44fb274f316924bedd7696645 20140623184518
----
======附录—常见问题======
1.[[..rest_error |接口错误码说明>>]]
http://localhost/doku.php?id=rest_error
2.调用接口返回100699 系统内部错误
a.查看接口参数sig是否拼写正确 sig= md5(账户Id + 账户授权令牌 + 时间戳)共32位, md5加密后转大写
b.查看接口参数Authorization是否拼写正确 Authorization=base64(账户Id +冒号+ 时间戳) 时间戳是当前系统时间(24小时制) yyyyMMddHHmmss
3.调用接口返回100005 访问ip不合法
创建应用时,基础配置中的服务器白名单清空下,如果配置了服务器白名单调用接口必须在白名单上调用,否则就会报此错。
4.企业用户如何显示400号码
应用管理应用列表找到对应的应用管理号码管理 添加需要显示的400号码, 400号码审核需要提供资料:3证信息(营业执照、组织机构代码证、税务登记证)+400开户合同+400授权书(云之讯提供,须加盖公司公章)发送到fangyundan@ucpaas.com