立即注册

免费试用

免费试用
导航
您现在位置:开发者中心 - 语音验证码

语音验证码

概述

向指定手机号码发送指定内容的语音验证码。

发送验证码接口(REST API)

/{SoftVersion}/Accounts/{accountSid}/Applications/{applicationSid}/ctc/Conversations[/{conversationSid}]

请求

请求URL

/Accounts/{AccountSid}/VoiceCaptchas

请求包头

HTTP标准包头字段

Accept: application/json

Content-Type: application/json;charset=utf-8

Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

请求消息示例

POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/VoiceCaptchas HTTP/1.1

Host: xxx.xxx.xxx.xxx:xxxx

Content-Length: 100

Accept: application/json

Content-Type: application/json;charset=utf-8

Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

{"appid": "11111111111111111111111111111111","from":"01080001001","to":"13800100001","code":"123235"}

易读版

{

"appid": "11111111111111111111111111111111",

"from":"01080001001",

"to":"13800100001",

"code":"123235"

}

鉴权说明

鉴权采用Basic Authorization。在请求包头携带Authorization信息。计算方法:

"Basic " + Base64({AccountSid}+":"+{AccountToken})

请求参数说明

请求参数

属性 约束 说明
appid必选
code必选验证码,数字和英文字母,不区分大小写,长度4-8位。
to必选接收号码
from可选显号
lang可选语言类型。取值en(英文)、zh(中文),默认值zh。
userdata可选用户定义数据,可在状态通知中获取此参数。

响应参数

名称 示例值描述
conversationSidCA2016010000000219呼叫唯一标识(发起呼叫后返回)
statusCode00000发送结果错误码
statusMsgsuccess发送结果状态描述

响应

响应消息示例

正常

HTTP/1.1 200 OK

Content-Length: 100

{ "statuscode":"0","statusmsg":"提交成功","requestid":"2016010000000205"}

异常

HTTP/1.1 200 OK

Content-Length: 100

{"statuscode":"-2","statusmsg":"缺少必要参数","requestid":""}

响应参数说明

名称 示例值 描述
requestid2016010000000219请求唯一标识
statuscode0发送结果错误码
statusmsg提交成功发送结果状态描述
callidCA2016010000000219呼叫唯一标识(发起呼叫后返回)可选

通知结果回调接口

POST推送,JSON格式,参数值均为字符串。

参数名称 描述
requestid请求唯一标识
callid呼叫唯一标识
appid所属应用的id
to被叫号码
starttime开始呼叫的时间(必须)
ringtime开始振铃的时间
answertime被叫应答时间
endtime结束时间(必须)
duration通话时长(单位:秒)
result通知结果 0:成功,1:失败
reason失败原因:"1"未应答,"2"外呼失败
userdata用户私有数据。外呼通知接口参数

专业、便捷、稳定的企业通信能力开放平台,点击注册立即免费试用!

免费注册
©2020 北京祥云智通科技有限公司. All rights reserved. 京ICP备17071816号-1