tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Creating Text-to-Speech Template

    Last updated: 2024-06-12 15:47:04
    Download PDF

      Feature Description

      This API is used to create a text-to-speech template.
      

      Request

      Sample request

      POST /template HTTP/1.1
      Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
      Date: <GMT Date>
      Authorization: <Auth String>
      Content-Length: <length>
      Content-Type: application/xml
      
      <body>
      Note:
      Authorization: Auth String (for more information, see Request Signature).
      When this feature is used by a sub-account, relevant permissions must be granted. For more information, see Authorization Granularity Details.

      Request headers

      This API only uses common request headers. For more information, see Common Request Headers.

      Request body

      This request requires the following request body:
      <Request>
          <Tag>Tts</Tag>
          <Name>TemplateName</Name>
          <Mode>Sync</Mode>
          <Codec>pcm</Codec>
          <VoiceType>ruxue</VoiceType>
          <Volume>2</Volume>
          <Speed>200</Speed>
      </Request>
      
      The nodes are described as follows:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Request
      None
      Request container
      Container
      Yes
      
      Request
      has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Required
      Constraints
      Tag
      Request
      Template tag: Tts
      String
      Yes
      Tts
      Name
      Request
      Template name, which can contain letters, digits, underscores (_), hyphens (-), and asterisks (*).
      String
      Yes
      None
      Mode
      Request
      Processing mode, which is Asyc by default.
      String
      No
      Asyc (async synthesis); Sync (sync synthesis).
      When Asyc is selected, the codec can only be pcm.
      Codec
      Request
      Audio format, which is wav (sync)/pcm (async) by default.
      String
      No
      wav, mp3, pcm
      VoiceType
      Request
      Voice, which is ruxue by default.
      String
      No
      ruxue, aixiaonan, aixiaoxing
      Volume
      Request
      Volume, which is 0 by default.
      String
      No
      [-10,10]
      Speed
      Request
      Speech rate, which is 100 by default.
      String
      No
      [50,200]
      Voice description
      Name
      Voice Parameter Value
      Type
      Use Case
      Supported Languages
      Voice Quality
      Ruxue
      ruxue
      Standard female voice
      General
      Chinese, Chinese-English mix
      Standard
      Aixiaonan
      aixiaonan
      Sweet female voice
      General, social
      Chinese, Chinese-English mix
      Premium
      Aixiaoxing
      aixiaoxing
      Commentary male voice
      General, commentary
      Chinese, Chinese-English mix
      Premium
      Multi-sentiment voice description
      Name
      Voice Parameter Value
      Sentiment Category
      Aixiaoxing
      aixiaoxing
      Neutral, broadcasting, calm, excited

      Response

      Response headers

      This API only returns common response headers. For more information, see Common Response Headers.

      Response body

      The response body returns application/xml data. The following contains all the nodes:
      <Response>
          <Template>
              <Tag>Tts</Tag>
              <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <Name>TemplateName</Name>
              <BucketId>test-1234567890</BucketId>
              <Category>Custom</Category>
              <TtsTpl>
                  <Mode>Sync</Mode>
                  <Codec>pcm</Codec>
                  <VoiceType>ruxue</VoiceType>
                  <Volume>2</Volume>
                  <Speed>200</Speed>
              </TtsTpl>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </Template>
      </Response>
      The nodes are as described below:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      Response
      None
      Response container
      Container
      <span id="Response"></span>Response has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Type
      TemplateId
      Response.Template
      Template ID
      String
      Name
      Response.Template
      Template name
      String
      BucketId
      Response.Template
      Template bucket
      String
      Category
      Response.Template
      Template category: Custom or Official
      String
      Tag
      Response.Template
      Template type: Tts
      String
      UpdateTime
      Response.Template
      Update time
      String
      CreateTime
      Response.Template
      Creation time
      String
      TtsTpl
      Response.Template
      Template parameters
      Container
      TtsTpl has the following sub-nodes:
      Node Name (Keyword)
      Parent Node
      Description
      Mode
      Response.Template.TtsTpl
      Same as Request.Mode in the request body.
      Codec
      Response.Template.TtsTpl
      Same as Request.Codec in the request body.
      VoiceType
      Response.Template.TtsTpl
      Same as Request.VoiceType in the request body.
      Volume
      Response.Template.TtsTpl
      Same as Request.Volume in the request body.
      Speed
      Response.Template.TtsTpl
      Same as Request.Speed in the request body.

      Error codes

      There are no special error messages for this request. For common error messages, see Error Codes.

      Samples

      Request

      POST /template HTTP/1.1
      Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
      Host: test-1234567890.ci.ap-beijing.myqcloud.com
      Content-Length: 1666
      Content-Type: application/xml
      
      <Request>
          <Tag>Tts</Tag>
          <Name>TemplateName</Name>
          <Mode>Sync</Mode>
          <Codec>pcm</Codec>
          <VoiceType>ruxue</VoiceType>
          <Volume>2</Volume>
          <Speed>200</Speed>
      </Request>

      Response

      HTTP/1.1 200 OK
      Content-Type: application/xml
      Content-Length: 100
      Connection: keep-alive
      Date: Thu, 14 Jul 2022 12:37:29 GMT
      Server: tencent-ci
      x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
      
      <Response>
          <Template>
              <Tag>Tts</Tag>
              <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
              <Name>TemplateName</Name>
              <BucketId>test-1234567890</BucketId>
              <Category>Custom</Category>
              <TtsTpl>
                  <Mode>Sync</Mode>
                  <Codec>pcm</Codec>
                  <VoiceType>ruxue</VoiceType>
                  <Volume>2</Volume>
                  <Speed>200</Speed>
              </TtsTpl>
              <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
              <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
          </Template>
      </Response>
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy