填写文档满意度调查问卷,赢取缤纷好礼> HOT

长文本语音合成请求

最近更新时间:2022-08-12 10:38:09

我的收藏

1. 接口描述

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

本接口服务对10万字符以内的文本进行语音合成,异步返回音频结果。满足一次性合成较长文本的客户需求,如阅读播报、新闻媒体等场景。

  • 支持音频格式:mp3,wav,pcm
  • 支持音频采样率:16000 Hz, 8000 Hz
  • 支持中文普通话、英文、中英文混读、粤语合成
  • 支持语速、音量设置
  • 支持回调或轮询的方式获取结果,结果获取请参考 长文本语音合成结果查询。
  • 长文本语音合成任务完成后,合成音频结果在服务端可保存24小时
  • 长文本合成支持 SSML,语法详见 SSML 标记语言,使用时需满足如下使用规范:

  • 使用 SSML 标签,需置于 speak 闭合标签内部;
  • 合成文本可包含多组 speak 闭合标签,且无数量限制;
  • 每个 speak 闭合标签内部,字符数不超过 150 字(标签字符本身不计算在内);
  • 每个 speak 闭合标签内部,使用 break 标签数目最大为 10 个。如需要使用更多,可拆解到多个 speak 标签中;
  • 默认接口请求频率限制:20次/秒。

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

    2. 输入参数

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

    参数名称 必选 类型 描述
    Action String 公共参数,本接口取值:CreateTtsTask。
    Version String 公共参数,本接口取值:2019-08-23。
    Region String 公共参数,本接口不需要传递此参数。
    Text String 合成语音的源文本,按UTF-8编码统一计算,最多支持10万字符
    ModelType Integer 模型类型,1-默认模型。
    Volume Float 音量大小,范围:[0,10],分别对应11个等级的音量,默认为0,代表正常音量。没有静音选项。
    Speed Float 语速,范围:[-2,2],分别对应不同语速:
  • -2代表0.6倍
  • -1代表0.8倍
  • 0代表1.0倍(默认)
  • 1代表1.2倍
  • 2代表1.5倍
  • 如果需要更细化的语速,可以保留小数点后一位,例如0.5 1.1 1.8等。
    ProjectId Integer 项目id,用户自定义,默认为0。
    VoiceType Integer 标准音色
  • 10510000-智逍遥,旁对白阅读风格男声
  • 1001-智瑜,情感女声
  • 1002-智聆,通用女声
  • 1003-智美,客服女声
  • 1004-智云,通用男声
  • 1005-智莉,通用女声
  • 1007-智娜,客服女声
  • 1008-智琪,客服女声
  • 1009-智芸,知性女声
  • 1010-智华,通用男声
  • 1017-智蓉,情感女声
  • 1018-智靖,情感男声
  • 1050-WeJack,英文男声
  • 1051-WeRose,英文女声
  • 精品音色
    精品音色拟真度更高,价格不同于标准音色,查看购买指南
  • 100510000-智逍遥,旁对白阅读风格男声(精品)
  • 101001-智瑜,情感女声(精品)
  • 101002-智聆,通用女声(精品)
  • 101003-智美,客服女声(精品)
  • 101004-智云,通用男声(精品)
  • 101005-智莉,通用女声(精品)
  • 101006-智言,助手女声
  • 101007-智娜,客服女声(精品)
  • 101008-智琪,客服女声(精品)
  • 101009-智芸,知性女声(精品)
  • 101010-智华,通用男声(精品)
  • 101011-智燕,新闻女声
  • 101012-智丹,新闻女声
  • 101013-智辉,新闻男声
  • 101014-智宁,新闻男声
  • 101015-智萌,男童声
  • 101016-智甜,女童声
  • 101017-智蓉,情感女声(精品)
  • 101018-智靖,情感男声(精品)
  • 101019-智彤,粤语女声
  • 101050-WeJack,英文男声(精品)
  • 101051-WeRose,英文女声(精品)
  • PrimaryLanguage Integer 主语言类型:
  • 1-中文(默认)
  • 2-英文
  • SampleRate Integer 音频采样率:
  • 16000:16k(默认)
  • 8000:8k
  • Codec String 返回音频格式,可取值:mp3(默认),wav,pcm
    CallbackUrl String 回调 URL,用户自行搭建的用于接收识别结果的服务URL。如果用户使用轮询方式获取识别结果,则无需提交该参数。回调说明
    VoiceoverDialogueSplit Boolean 旁白与对白文本解析,分别合成相应风格(仅适用于旁对白音色),默认 false

    3. 输出参数

    参数名称 类型 描述
    Data CreateTtsTaskRespData 任务 id
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 API调用

    输入示例

    POST / HTTP/1.1
    Host: tts.tencentcloudapi.com
    Content-Type: application/json; charset=utf-8
    X-TC-Version: 2019-06-14
    X-TC-Region: ap-shanghai
    X-TC-Action: CreateTtsTask
    X-TC-Timestamp: 1599140162
    Authorization: TC3-HMAC-SHA256 Credential=AKIDYu6A16GdCxUlnbTSVItxvhxxx2gpbx2/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=0615f73a69c6b054affd69e4b1cbb68fbe84ae8024a9347df4aa5054933adac8
    <公共请求参数>
    
    {
        "Text": "欢迎使用腾讯云长文本语音合成",
        "ModelType": 1,
        "Volume": 0.0,
        "Speed": 0.0,
        "ProjectId": 0,
        "VoiceType": 101001,
        "PrimaryLanguage": 1,
        "SampleRate": 16000,
        "Codec": "mp3",
        "CallbackUrl": "xx"
    }

    输出示例

    {
        "Response": {
            "RequestId": "fabc2d63-a1b7-40a0-b4c3-640f78974919",
            "Data": {
                "TaskId": "1000000007"
            }
        }
    }

    示例2 成功示例

    输入示例

    POST / HTTP/1.1
    Host: tts.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateTtsTask
    <公共请求参数>
    
    {
        "Text": "字符串",
        "ProjectId": "1",
        "ModelType": "1",
        "Volume": "0",
        "Codec": "mp3",
        "VoiceType": "101001",
        "SampleRate": "16000",
        "PrimaryLanguage": "1",
        "Speed": "0"
    }

    输出示例

    {
        "Response": {
            "RequestId": "41a54cd2-3941-4a85-8b9a-f1e8b0000be5",
            "Data": {
                "TaskId": "gz-53c9e73a-d8ec-4792-bc9e-e982115623a5"
            }
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    AuthFailure.InvalidAuthorization 授权无效。
    InternalError.ErrorGetRoute 路由错误。
    InternalError.FailAccessDatabase 数据库存取失败。
    InternalError.InternalError 内部错误。
    InvalidParameter.InvalidText 请求文本含有非法字符。
    InvalidParameter.Status status 不合法。
    InvalidParameterValue.AppId AppId非法,请参考AppId参数说明。
    InvalidParameterValue.AppIdNotRegistered APPID未注册,请在语音合成主页 https://console.cloud.tencent.com/tts 开通使用。
    InvalidParameterValue.CallbackUrl CallbackUrl非法或不可访问。
    InvalidParameterValue.Codec Codec非法,请参考Codec参数说明。
    InvalidParameterValue.ErrorCardinalFormat ssml的say-as标签属性为cardinal、currency、address时,数字部分非有效常数,仅允许包含数字、“,”、“.”和空格。
    InvalidParameterValue.InvalidText 请求文本含有非法字符,或请求文本没有有效字符。
    InvalidParameterValue.MissParameters 缺少参数。
    InvalidParameterValue.ModelType ModelType非法。
    InvalidParameterValue.PrimaryLanguage PrimaryLanguage非法,请参考PrimaryLanguage参数说明。
    InvalidParameterValue.SampleRate SampleRate非法,请参考SampleRate参数说明。
    InvalidParameterValue.Speed Speed非法,请参考Speed参数说明。
    InvalidParameterValue.Text 文本缺失。
    InvalidParameterValue.TextEmpty Text为空。
    InvalidParameterValue.TextNotUtf8 文本不是 UTF8 格式。
    InvalidParameterValue.TextSsmlParseError Text参数SSML语法错误,请参考SSML文档说明。
    InvalidParameterValue.TextTooLong 合成文本字符过长。
    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的说明。
    目录