调用SingleCallByTts发送语音验证码或带变量的语音通知

调用接口给单个被叫号码发送语音验证码、文本转语音类型的语音通知、语音通知文件中带变量参数的语音通知。

接口说明

如果需要批量发送语音任务，请使用 CreateCallTask 接口创建语音任务。
语音套餐包或语音计费相关，请参见国内语音服务定价。

QPS 限制

单用户调用频率：1000 次/秒。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CalledShowNumber	string	否	发送语音通知或语音验证码的外呼号码（被叫显号）。如果您使用的外呼号码是公共模式，该参数不填。公共模式详情请参见公共模式。如果您使用的外呼号码是专属模式，请传入您的真实号码或虚拟号码。您可以登录语音服务控制台，在真实号管理页面查看已购买的真实号，在虚拟号管理页面查看已创建并绑定真实号的虚拟号。	0571****5678
CalledNumber	string	是	接收语音通知或语音验证码的被叫号码。号码格式：手机号码。示例：159**0000。固话号码。示例：05715678。说明调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。针对同一个资质信息+号码用途**，主叫号码拨打每一个被叫号码的频次进行限制：1 次/分钟、5 次/小时、20 次/24 小时。流控规则计时从第一次正常外呼开始，超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。	1590****000
TtsCode	string	是	文本转语音模板或语音验证码模板的模板 ID。您登录语音服务控制台，在以下页面获取模板 ID，语音模板必须已通过审核。在语音消息>语音验证码获取模板 ID。在语音消息>语音通知页面获取模板 ID。说明语音模板归属账号和调用该接口的账号需保持一致。	TTS_28726****
TtsParam	string	否	语音模板中的变量参数，JSON 格式。变量规范详情，请参见模板规范。	{"AckNum":"123456"}
PlayTimes	integer	否	语音文件或语音验证的播放次数。取值范围：1~3，默认取值 3。	3
Volume	integer	否	语音通话的音量。取值范围：0~100，默认取值 100。	100
Speed	integer	否	语音通话的语速。取值范围为：-500~500。	5
OutId	string	否	发起请求时预留给调用方的自定义 ID，最终会通过回执消息将此 ID 带回给调用方。字符串类型，长度限制为 1~15 个字符。	225869*****

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见 API 错误码。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
CallId	string	此次通话的唯一回执 ID。可以使用 CallId，调用 QueryCallDetailByCallId 接口查询呼叫详情。	116012354148^10281378****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史