有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

1. 接口描述

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

腾讯云语音合成技术(TTS)可以将任意文本转化为语音,实现让机器和应用张口说话。
腾讯TTS技术可以应用到很多场景,比如,移动APP语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。
内测期间免费使用。
基础合成支持 SSML,语法详见 SSML 标记语言

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TextToVoice。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
Text String 合成语音的源文本,按UTF-8编码统一计算。
中文最大支持150个汉字(全角标点符号算一个汉字);英文最大支持500个字母(半角标点符号算一个字母)。
SessionId String 一次请求对应一个SessionId,会原样返回,建议传入类似于uuid的字符串防止重复。
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。
    ModelType Integer 模型类型,1-默认模型。
    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-智彤,粤语女声
  • 101020-智刚,新闻男声
  • 101021-智瑞,新闻男声
  • 101022-智虹,新闻女声
  • 101023-智萱,聊天女声
  • 101024-智皓,聊天男声
  • 101025-智薇,聊天女声
  • 101026-智希,通用女声
  • 101027-智梅,通用女声
  • 101028-智洁,通用女声
  • 101029-智凯,通用男声
  • 101030-智柯,通用男声
  • 101031-智奎,通用男声
  • 101032-智芳,通用女声
  • 101033-智蓓,客服女声
  • 101034-智莲,通用女声
  • 101035-智依,通用女声
  • 101040-智川,四川女声
  • 101050-WeJack,英文男声
  • 101051-WeRose,英文女声
  • 101052-智味,通用男声
  • 101053-智方,通用男声
  • 101054-智友,通用男声
  • 101055-智友,通用女声
  • 101056-智林,东北男声
  • PrimaryLanguage Integer 主语言类型:
  • 1-中文(默认)
  • 2-英文
  • SampleRate Integer 音频采样率:
  • 16000:16k(默认)
  • 8000:8k
  • Codec String 返回音频格式,可取值:wav(默认),mp3,pcm
    EnableSubtitle Boolean 是否开启时间戳功能,默认为false。

    3. 输出参数

    参数名称 类型 描述
    Audio String base64编码的wav/mp3音频数据
    SessionId String 一次请求对应一个SessionId
    Subtitles Array of Subtitle 时间戳信息,若未开启时间戳,则返回空数组。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 API调用

    输入示例

    POST / HTTP/1.1
    Host: tts.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: TextToVoice
    <公共请求参数>
    
    {
        "Text": "你好",
        "ModelType": "1",
        "Volume": "1",
        "SessionId": "session-1234",
        "Codec": "wav",
        "ProjectId": "0",
        "SampleRate": "16000",
        "PrimaryLanguage": "1",
        "Speed": "1",
        "EnableSubtitle": true
    }

    输出示例

    {
        "Response": {
            "Audio": "UklGRlR/AABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YSx9AAD+////AQD//wAAAAAAAAIAAQADAAMABgAEAAYABQAGAAUABwAIAAgACQAAE......AAgACAAEAAgADAAIAAwACAAQAAwACAAIAAgADAAMAAgACAAIAAwABAAAAAAAAAAAAAAD/////AAAAAAAA//8AAP///v/9//7//v///////v8AAP///////wAA/////wAA/////wAAAAAAAAAAAAAAAAAAAAAAAAAA",
            "RequestId": "9a7a1615-3e09-4db2-8032-5c6f497f7e6a",
            "SessionId": "session-1234",
            "Subtitles": [
                {
                    "Text": "你",
                    "BeginTime": 250,
                    "EndTime": 450,
                    "BeginIndex": 0,
                    "EndIndex": 1
                },
                {
                    "Text": "好",
                    "BeginTime": 450,
                    "EndTime": 700,
                    "BeginIndex": 1,
                    "EndIndex": 2
                }
            ]
        }
    }

    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.ExceedMaxLimit 负载限流。
    InternalError.InternalError 内部错误。
    InvalidParameter.InvalidText 请求文本含有非法字符。
    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.Type Type 类型非法。
    InvalidParameterValue.VoiceType VoiceType非法,请参考VoiceType参数说明。
    InvalidParameterValue.Volume Volume非法,请参考Volume参数说明。
    LimitExceeded.AccessLimit 请求超过限制频率。
    UnsupportedOperation 操作不支持。
    UnsupportedOperation.AccountArrears 欠费。
    UnsupportedOperation.AuthorizationExpired 鉴权已过期。
    UnsupportedOperation.AuthorizationFailed 鉴权失败。
    UnsupportedOperation.ForbiddenUse 服务禁止使用。
    UnsupportedOperation.NoFreeAccount 客户免费额度已用完。
    UnsupportedOperation.PkgExhausted 资源包余量已用尽。
    UnsupportedOperation.ServerAlreadyOpen 服务器已打开。
    UnsupportedOperation.ServerDestoryed 服务已销毁。
    UnsupportedOperation.ServerNotOpen 服务未开通使用。
    UnsupportedOperation.ServerStopped 服务已停止使用。
    UnsupportedOperation.TextTooLong 文本过长,请参考请求参数Text的说明。
    目录