调用SingleCallByTts向指定号码发起语音验证码。

调用该接口前,请您注意:
  • 已实名认证为企业用户,并审核通过了企业资质。
  • 已在语音服务控制台上购买了号码。
  • 已在文本转语音模板页面上传了文本转语音模板,并通过了审核。
  • 请确保在使用该接口前,已充分了解语音服务产品的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SingleCallByTts

系统规定参数。取值:SingleCallByTts

CalledNumber String 13700000000

被叫号码。仅支持中国内地号码。

CalledShowNumber String 0571xxxx

主叫号码,必须是已购买的号码。

您可以在语音服务控制台上查看已购买的号码。

TtsCode String TTS_10001

已审核通过的语音验证码模板ID,您可以在文本转语音模板页面查看模板ID。

TtsParam String {"AckNum":"123456"}

模板中的变量参数,格式为JSON。

PlayTimes Integer 3

一通电话内语音通知内容的播放次数,取值范围为1~3。

Volume Integer 100

语音通知的播放音量。取值范围为0~100,默认为100。

Speed Integer 5

语速控制。取值范围为-500~500。

OutId String abcdefgh

发起请求时预留给调用方的自定义ID, 最终会通过在回执消息中将此ID带回给调用方。

长度为1~15个字节。

返回数据

名称 类型 示例值 描述
CallId String 116012354148^1028137841xx

此次通话的唯一回执ID,可以用此ID通过接口QueryCallDetailByCallId查询呼叫详情。

Code String OK

请求状态码。

Message String OK

状态码的描述。

RequestId String D9CB3933-9FE3-4870-BA8E-2BEE91B69D23

请求ID。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com/?CalledNumber=13700000000
&CalledShowNumber=0571xxxx
&TtsCode=TTS_10001
&<公共请求参数>

正常返回示例

XML 格式

<SingleCallByTtsResponse>
	  <Message>OK</Message>
	  <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>
	  <Code>OK</Code>
	  <CallId>116012354148^1028137841xx</CallId>
</SingleCallByTtsResponse>

JSON 格式

{
	"Message": "OK",
	"RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
	"Code": "OK",
	"CallId": "116012354148^1028137841xx"
}

错误码

访问错误中心查看更多错误码。