中文帮助文档>Rest API

语音验证码

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

请求地址:
/{SoftVersion}/accounts/{accountSid}/call/voiceCode
验证级别:
主账号验证级别,请求地址中的 {accountSid}代表主账号id(ACCOUNT SID)。
地址样例:
https://api.qingmayun.com/20141029/accounts/823deef8e529477185a52179325b4a62/call/voiceCode?sig=84b81c1d13911dd6cd35e63b4db988e8&timestamp=20141116113918
支持格式:
JSON,XML
HTTPS请求方式:
POST

请求包体

属性 类型 约束 说明
appId String 必选 应用Id。
verifyCode String 必选 验证码内容,为数字0~9,长度4-8位。
called String 必选 被叫电话号码。支持手机、固话,被叫为固话时需要增加区号,如:075552823298。
callDisplayNumber String 可选

被叫侧显示的号码。显示官方号码(官方手机号码或固话,1、创建应用时需开启“显官方号”并配置官方号码进行审核;2、资质认证必须为企业开发者)。具体可查阅显示规则

playTimes String 可选 语音播放次数。
userData String 可选 自定义参数
fileId String 可选 提示音ID

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码,取值00000(成功),具体可参考状态码
callId String 必选 呼叫的唯一标识。
createDate String 必选 电话的创建时间。

XML请求实例

POST /20141029/accounts/823deef8e529477185a52179325b4a62/call/voiceCode?sig=84b81c1d13911dd6cd35e63b4db988e8
&timestamp=20141116113918
Host:api.qingmayun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<voiceCode>
  <appId>624e76e6486648cd8be0dee3b5cc9957</appId>
  <verifyCode>612075</verifyCode>
  <called>132xxxxxxxx</called>
  <callDisplayNumber>132xxxxxxxx</callDisplayNumber>
  <playTimes>1</playTimes>
</voiceCode>

JSON请求实例

POST /20141029/accounts/823deef8e529477185a52179325b4a62/call/voiceCode?sig=84b81c1d13911dd6cd35e63b4db988e8
&timestamp=20141116113918
Host:api.qingmayun.com
Accept:application/json
Content-Type:application/json;charset=utf-8

{
    "voiceCode": {
        "appId": "624e76e6486648cd8be0dee3b5cc9957", 
        "verifyCode": "61207522", 
        "called": "132xxxxxxxx", 
        "callDisplayNumber": "01012345678",
        "playTimes": "1"
    }
}

XML响应实例

<?xml version="1.0" encoding="utf-8"?>
<result>
  <respCode>00000</respCode> 
  <callId>d6677b4fc4de4cafa349aa682292b824</callId>
  <createDate>2014-12-08 17:28:20</createDate>
</result>

JSON响应实例

{
    "result": {
        "respCode": "00000", 
        "callId": "16bd0ed5541a432885709a4c6ac1dd08", 
        "createDate": "2014-12-08 17:52:01"
    }
}