调用接口SingleCallByTts发起语音通知,播放的音频为文本转语音模板转换后的音频文件。

接口SingleCallByTts用于向指定号码发起语音通知,若播放的音频为文本模板(TTS),每次调用时从文本模板转化为音频文件。文本转语音模板中还可以设置变量,调用时替换变量即可。

调用该接口前,请确认:

说明 请确保在使用该接口前,已充分了解语音服务产品的收费方式和价格

调试

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

请求参数

名称 类型 是否必选 示例值 描述
CalledNumber String 13700000000

被叫号码。仅支持中国大陆号码。

CalledShowNumber String 4001112222

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

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

TtsCode String TTS_10001

文本转语音(TTS)模板ID。可以在文本转语音模板页面查看模板ID。

说明 必须是已审核通过的文本转语音模板。
AccessKeyId String LTAIP00vvvvvvvvv

主账号AccessKey的ID。

Action String SingleCallByTts

系统规定参数。取值:SingleCallByTts

OutId String abcdefgh

预留给调用方使用的ID, 最终会通过在回执消息中将此ID带回给调用方。

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

PlayTimes Integer 3

语音通知的播放次数,取值范围为1~3。

Speed Integer 5
说明 该参数为废弃参数,暂不支持使用。
TtsParam String {“AckNum”:”123456”}

文本转语音(TTS)模板变量转换关系,格式为JSON。

Volume Integer 100

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

返回数据

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

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

Code String OK

请求状态码。

Message String OK

状态码的描述。

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

请求ID。

示例

请求示例


http(s)://[Endpoint]/?CalledNumber=13700000000
&CalledShowNumber=4001112222
&TtsCode=TTS_10001
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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