===== 语音验证码 =====

语音验证码是云之讯融合通讯开放平台提供的一种语音通知能力，可替代或辅助短信验证码使用，拥有更即时和实时反馈的机制以满足实时要求更高的身份认证类服务。使用此REST API实现语音验证码功能。

请通过HTTPS POST方式提交请求，云之讯融合通讯开放平台收到请求后，向对象电话终端发起呼叫，接通电话后将播放指定语音验证码序列

  * 如需更完善的监听服务状态，需要配置 ：[[..回调地址指南|回调地址指南>>]]
===== 语音验证码失败补发短信功能 =====
如果用户由于关机或者信号不好等其他原因无法接收到语音验证码，在平台开启补发短信功能的前提下，语音验证码会以短信的形式将该验证码下发到用户手机上，双重措施有效保障开发者验证码业务的正常运行。
  * 1、 开发者需要联系云之讯相关工作人员在后台开通语音验证码失败补发短信业务功能权限。当补发短信业务功能权限开通后，客户才有权限使用该项业务功能。
  * 2、 当申请开通后台权限后，在请求接口中按命名参数templateId填入正确的短信模板ID，即表示开发者的语音验证码业务可以正常使用失败补发短信的业务，短信模板ID请在云之讯开发者平台创建短信模板并且审核通过后获取。我们的平台系统检测到用户无法正常接收到语音验证码时，将开发者需要通知用户的验证码按照提供的模板组合短信下发到用户手机上。
  * 3、 由于语音验证码业务的特性，对于补发的短信模板，需保证该模板参数有且包含1个，否则会返回错误码105139，含义为补发短信模板不规范。例如正确的补发短信模板如下：
<code java>
您的验证码为{1}，请于10分钟内正确输入验证码。
</code>
==== 1.1 请求 ====

**请求地址**

<code java>
/{SoftVersion}/Accounts/{AccountSid}/Calls/voiceCode
</code>

**请求包头**

详情请查阅统一请求包头，并使用开发者账号进行验证。

**请求包体**

^属性 ^类型 ^约束   ^说明 |
|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  |


----
< JSON 请求示例>
<code json>
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"
	 }
 }
</code>
----
----
<  XML请求示例>
<code xml>
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=   
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<voiceCode> 
<appId>e462aba25bc6498fa5ada7eefe1401b7</appId>
<to>18612345678</to> 
<verifyCode>09071124</verifyCode> 
<userData>self-define follow your heart and rules</userData> 
<voiceId>1124</voiceId> 
<displayNum>075512345678</displayNum>
<playTimes>3</playTimes> 
</voiceCode>
</code>
----
==== 1.2 响应 ====

**响应包体**
^属性 ^类型 ^约束 ^说明 |
|respCode	|String	|必选 |请求状态码，取值000000（成功）|
|callId	|String	|必选 |一个由32个字符组成的唯一电话标识符|
|createDate	|String	|必选 |电话的创建时间|
----
< XML响应示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resp>
    <respCode>000000</respCode>
    <voiceCode> /*voiceCode为节点*/
        <callId>48dcc7d44fb274f316924bedd7696645</callId>
        <createDate>20140623184518</createDate>
    </voiceCode>
</resp>
</code>
----
----
< JSON响应示例>
<code java>
{
 "resp":{
         "respCode":"000000",
         "voiceCode":{
                      "callId":"31d7ca243c406a81611910db21b68876",
                      "createDate" : 20140623184729
                     }
	}
 }
</code>
----