You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

创建文本转语音(TTS)模板

最近更新时间：2024.02.29 20:31:58

首次发布时间：2023.02.28 20:31:38

我的收藏
1. 接口说明

  • 请求方式：POST

  • 接口地址：http://cloud-vms.volcengineapi.com?Action=OpenCreateTts&Version=2022-01-01



2. 请求参数
参数数据类型是否必填示例值描述
X-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎。

ServiceName

String

是

vms

服务名称。语音服务的服务名称是vms。

RegionString是cn-north-1区域名称，固定值cn-north-1。

Content-Type

String

是

application/json

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/json。

Query

参数数据类型是否必填示例值描述
ActionString是OpenCreateTts接口名称。该接口固定值为OpenCreateTts。
VersionString是2022-01-01接口版本。语音服务接口默认版本为2022-01-01。

Body

参数数据类型是否必填示例值描述
NameString是test语音资源名称

TtsTemplateContent

是

是

你好，张三

tts模板内容

TypeInteger是1语音资源类型（0语音通知文件 1文本转语音模板 2语音交互文件）
TtsOptionString否{"Lang":"ch","Speed":10,"Pitch":10,"Volume":10,"Loop":0,"LoopInterval":0,"VoiceType":"BV001"}语音参数。Lang：语言、Speed：语速、Volume：音量、Loop：循环次数、LoopInterval：循环间隔

3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数数据类型示例值描述
ResourceKeyStringe6eaa926a2ed41df8f52d63c046b7d78语音资源唯一标识符

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。

4. 示例

请求示例

curl --location --request POST 'http://cloud-vms.volcengineapi.com?Action=OpenCreateTts&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/json' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-raw '{
    "Name": "ttsTest",
    "TtsTemplateContent": "你好",
    "Type":1
}'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "202212291644259943AFD6683B03798C80",
        "Action": "OpenCreateTts",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResourceKey": "7c33059753c84a8daad300000",
        "Name": "ttsTest"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122916451633B78DA6B987A57926C9",
        "Action": "OpenCreateTts",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "RequestParametersError",
            "Message": "请求参数错误"
        }
    }
}