轻码云 开发者文档

语音验证码

通过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
HTTPS请求方式:
POST
参数体包装名:
voiceCode

请求参数:

属性 类型 约束 说明
called String 必选 被叫号码
verifyCode Int 必选 验证码内容(1-8位数字)
playTimes Int 可选 播放次数(1-3次,默认1次)
language Int 可选 播放语言:0.中文,1.英文,2.中英文
allowedCallTime Int 可选 最大通话时长(s)
billUrl String 可选 话单推送地址(http或https协议)
userData String 可选 透传数据(话单推送时返回)

成功响应参数:

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

失败响应参数:

属性 类型 说明
respCode String 失败响应码: 不为00000都是失败 具体查看状态码
message String 失败原因

请求体实例:

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": {
        "verifyCode": "61207522",
        "called": "132xxxxxxxx",
        "playTimes": 1,
        "language":0,
        "allowedCallTime":60,
        "billUrl":"http://xxxxxxxxxxxxx",
        "userData":"userId=10"
    }
}

成功响应实例:

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

{
    "result": {
        "callId": "46070e41-dabf-49e5-9698-9899dcb62383",
        "createDate": "2018-03-16 10:49:52",
        "respCode": "00000"
    }
}

失败响应实例:

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

{
    "result": {
        "message": "开发者余额状态不正确",
        "respCode": "00066"
    }
}