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

使用说明

带参数变量的语音通知也使用SingleCallByTts接口,SingleCallByTts接口可以发送语音验证码和带数变量的语音通知。

QPS限制

  • 单用户调用频率:1000次/秒。
  • API频率:4000次/秒。
说明 如果多个用户的总调用超过API频率也会触发流控。

调试

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

请求参数

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

系统规定参数。取值:SingleCallByTts

CalledShowNumber String 0571****5678

被叫显号。

  • 若您使用的文本转语音模板为公共模式外呼,则该参数值不填。更多信息,请参见公共模式
  • 若您使用的文本转语音模板为专属号码外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录语音服务控制台,选择申请服务>号码管理查看已购买的号码。
CalledNumber String 1590****000

接收语音通知的手机号码。

  • 号码格式:中国内地语音:
    • 手机号码。示例:159****000。
    • 固话号码。示例:0571****5678。
  • 国际语音或港澳台语音:国际区号+号码。示例:85200****00。
说明
  • 一次请求仅支持一个被叫号,使用流程,请参见语音验证码使用流程
  • 语音验证码流控频率规则:同一个被叫,1次/分钟、5次/小时、20次/天。
TtsCode String TTS_100****

已通过审核的语音验证码模板ID。

您可以登录语音服务控制台,选择国内语音单呼>语音验证码查看模板ID。

说明 TTS模板归属账号和调用接口的账号需保持一致。
TtsParam String {"AckNum":"123456"}

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

PlayTimes Integer 3

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

Volume Integer 100

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

Speed Integer 5

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

OutId String 225869*****

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

字符串类型,长度为1~15个字节。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

状态码的描述。

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

请求ID。

CallId String 116012354148^10281378****

此次通话的唯一回执ID。

Calld可以通过QueryCallDetailByCallId接口查询呼叫详情。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com/?Action=SingleCallByTts
&CalledNumber=1590****000
&CalledShowNumber=0571****5678
&TtsCode=TTS_100****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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