语音合成长文本语音合成结果查询-长文本语音合成相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： tts.tencentcloudapi.com 。

在调用长文本语音合成请求接口后，有回调和轮询两种方式获取识别结果。

当采用回调方式时，合成完毕后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见长文本语音合成结果查询。

当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTtsTaskStatus。
Version	是	String	公共参数，本接口取值：2019-08-23。
Region	否	String	公共参数，本接口不需要传递此参数。
TaskId	是	String	任务id 示例值：ed461a019355c5cd1ce31ab4dfb8cb12

3. 输出参数

参数名称	类型	描述
Data	DescribeTtsTaskStatusRespData	任务状态返回
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 API调用

输入示例

POST / HTTP/1.1
Host: tts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTtsTaskStatus
<公共请求参数>

{
    "TaskId": "gz-855e1e59-35c2-4e43-b15a-3409c515d62e"
}

输出示例

{
    "Response": {
        "RequestId": "28e1a307-0381-4e56-863d-42542993bf87",
        "Data": {
            "TaskId": "gz-855e1e59-35c2-4e43-b15a-3409c515d62e",
            "Status": 0,
            "StatusStr": "waiting in queue",
            "ResultUrl": "",
            "Subtitles": [],
            "ErrorMsg": ""
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.InvalidAuthorization	授权无效。
FailedOperation	操作失败。
FailedOperation.NoSuchTask	任务不存在。
InternalError.ErrorGetRoute	路由错误。
InternalError.FailAccessDatabase	数据库存取失败。
InternalError.FailAccessRedis	Redis存储失败。
InternalError.InternalError	内部错误。
InvalidParameter.InvalidText	请求文本含有非法字符。
InvalidParameter.Status	status 不合法。
InvalidParameterValue.AppId	AppId非法，请参考AppId参数说明。
InvalidParameterValue.AppIdNotRegistered	APPID未注册，请在语音合成主页 https://console.cloud.tencent.com/tts 开通使用。
InvalidParameterValue.Codec	Codec非法，请参考Codec参数说明。
InvalidParameterValue.ErrorCardinalFormat	ssml的say-as标签属性为cardinal、currency、address时，数字部分非有效参数，仅允许包含数字、“,”、“.”和空格。
InvalidParameterValue.InvalidText	请求文本含有非法字符，或请求文本没有有效字符。
InvalidParameterValue.MissParameters	缺少参数。
InvalidParameterValue.PrimaryLanguage	PrimaryLanguage非法，请参考PrimaryLanguage参数说明。
InvalidParameterValue.SampleRate	SampleRate非法，请参考SampleRate参数说明。
InvalidParameterValue.SessionId	SessionId非法，请参考Volume参数说明。
InvalidParameterValue.Speed	Speed非法，请参考Speed参数说明。
InvalidParameterValue.Text	文本缺失。
InvalidParameterValue.TextEmpty	Text为空。
InvalidParameterValue.TextNotUtf8	文本不是 UTF8 格式。
InvalidParameterValue.TextSsmlParseError	Text参数SSML语法错误，请参考SSML文档说明。
InvalidParameterValue.Type	Type 类型非法。
InvalidParameterValue.VoiceType	VoiceType非法，请参考VoiceType参数说明。
InvalidParameterValue.Volume	Volume非法，请参考Volume参数说明。
LimitExceeded.AccessLimit	请求超过限制频率。
UnsupportedOperation	操作不支持。
UnsupportedOperation.AccountArrears	欠费。
UnsupportedOperation.AuthorizationExpired	鉴权已过期。
UnsupportedOperation.AuthorizationFailed	鉴权失败。
UnsupportedOperation.ForbiddenUse	服务禁止使用。
UnsupportedOperation.NoBanlance	没有余额。
UnsupportedOperation.NoFreeAccount	免费资源包已用尽，请购买资源包或开通后付费。
UnsupportedOperation.ServerAlreadyOpen	服务器已打开。
UnsupportedOperation.ServerDestoryed	服务已销毁。
UnsupportedOperation.ServerNotOpen	服务未开通使用。
UnsupportedOperation.ServerStopped	服务已停止使用。
UnsupportedOperation.TextTooLong	文本过长，请参考请求参数Text的说明。

长文本语音合成结果查询

本页目录：