tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation

    Text-to-Speech

    Last updated: 2023-05-06 17:38:07

      Feature Overview

      This API is used to submit a text-to-speech job.

      Request

      Sample request

      POST /jobs 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.

      Request headers

      This API only uses Common Request Headers.

      Request body

      This request requires the following request body:

      <Request>
    <Tag>Tts</Tag>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <TtsConfig>
            <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
            <InputType>Text</InputType>
        </TtsConfig>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>demo.mp3</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</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
      Tag Request Job type: Tts String Yes
      Operation Request Operation rule Container Yes
      CallBackFormat Request Job callback format, which can be JSON or XML (default value). It takes priority over that of the queue. String No
      CallBackType Request Job callback type, which can be Url (default value) or TDMQ. It takes priority over that of the queue. String No
      CallBack Request Job callback address, which takes priority over that of the queue. If it is set to no, no callbacks will be generated at the callback address of the queue. String No
      CallBackMqConfig Request TDMQ configuration for job callback as described in Structure, which is required if CallBackType is TDMQ. Container No


      Operation has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      TtsTpl Request.Operation Text-to-speech job parameter Container No
      TemplateId Request.Operation Template ID String No
      TtsConfig Request.Operation Text-to-speech job parameter Container Yes
      Output Request.Operation Result output configuration Container Yes
      UserData Request.Operation The user information passed through, which is printable ASCII codes of up to 1,024 in length. String No
      JobLevel Request.Operation Job priority. The greater the value, the higher the priority. Valid values: 0 (default), 1, 2. String No
      Note：

      TemplateId is used first. If TemplateId is unavailable, TtsTpl is used.

      TtsTpl has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Mode Request.Operation.TtsTpl Same as Request.Mode in the text-to-speech template creation API String No
      Codec Request.Operation.TtsTpl Same as Request.Codec in the text-to-speech template creation API String No
      VoiceType Request.Operation.TtsTpl Same as Request.VoiceType in the text-to-speech template creation API String No
      Volume Request.Operation.TtsTpl Same as Request.Volume in the text-to-speech template creation API String No
      Speed Request.Operation.TtsTpl Same as Request.Speed in the text-to-speech template creation API String No

      TtsConfig has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      InputType Request.Operation.TtsConfig Input type. Valid values: Url, Text. String Yes
      Input Request.Operation.TtsConfig 1. When InputType is Url, the value must be a valid COS address, and the file must be UTF-8 encoded and no more than 10 MB in size. If the splicing method specified in the template is sync processing, the file can contain up to 300 UTF-8 characters; if the method is async processing, the file can contain up to 10,000 UTF-8 characters.
      2. When InputType is Text, the input can be up to 300 UTF-8 characters.      		 String Yes

      Output has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type Required
      Region Request.Operation.Output Bucket region String Yes
      Bucket Request.Operation.Output Result storage bucket String Yes
      Object Request.Operation.Output Result filename String Yes

      Response

      Response headers

      This API only returns Common Response Headers.

      Response body

      The response body returns application/xml data. The following contains all the nodes:

      <Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Tts</Tag>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>tts_demo</TemplateName>
            <TtsConfig>
                <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
                <InputType>Text</InputType>
            </TtsConfig>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/tts.mp3</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

      The nodes are as described below:

      Node Name (Keyword) Parent Node Description Type
      Response None Result storage container Container

      Response has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      JobsDetail Response Job details Container


      JobsDetail has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      Code Response.JobsDetail Error code, which is returned only if State is Failed String
      Message Response.JobsDetail Error message, which is returned only if State is Failed String
      JobId Response.JobsDetail Job ID String
      Tag Response.JobsDetail Job type: Tts String
      State Response.JobsDetail Job status. Valid values: Submitted, Running, Success, Failed, Pause, Cancel. String
      CreationTime Response.JobsDetail Job creation time String
      StartTime Response.JobsDetail Job start time String
      EndTime Response.JobsDetail Job end time String
      QueueId Response.JobsDetail ID of the queue where the job is in String
      Operation Response.JobsDetail Task rule Container

      Operation has the following sub-nodes:

      Node Name (Keyword) Parent Node Description Type
      TemplateId Response.JobsDetail.Operation Job template ID String
      TemplateName Response.JobsDetail.Operation Job template name, which is returned when TemplateId exists String
      TtsTpl Response.JobsDetail.Operation Same as Request.Operation.TtsTpl in the request Container
      TtsConfig Response.JobsDetail.Operation Same as Request.Operation.TtsConfig in the request Container
      Output Response.JobsDetail.Operation Same as Request.Operation.Output in the request Container
      MediaInfo Response.JobsDetail.Operation Media information of the output file, which will not be returned when the job is not completed Container
      MediaResult Response.JobsDetail.Operation Basic information of the output file, which will not be returned when the job is not completed Container
      UserData Response.JobsDetail.Operation The user information passed through String
      JobLevel Response.JobsDetail.Operation Job priority String

      MediaInfo has the following sub-nodes:
      Same as the Response.MediaInfo node in the Getting Media File Information API.

      MediaResult has the following sub-nodes:
      For more information, see MediaResult.

      Error codes

      No special error message will be returned for this request. For the common error messages, see Error Codes.

      Examples

      Request 1: Using a text-to-speech template ID

      POST /jobs HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host:test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>Tts</Tag>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <TtsConfig>
            <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
            <InputType>Text</InputType>
        </TtsConfig>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>demo.mp3</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>

      Response

      HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Tts</Tag>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>tts_demo</TemplateName>
            <TtsConfig>
                <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
                <InputType>Text</InputType>
            </TtsConfig>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/tts.mp3</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

      Request 2: Using the text-to-speech parameter

      POST /jobs HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>Tts</Tag>
    <Operation>
        <TtsTpl>
            <Codec>mp3</Codec>
            <Mode>Sync</Mode>
            <Speed>100</Speed>
            <VoiceType>aixiaonan</VoiceType>
            <Volume>0</Volume>
        </TtsTpl>
        <TtsConfig>
            <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
            <InputType>Text</InputType>
        </TtsConfig>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>demo.mp3</Object>
        </Output>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON<CallBackFormat>
</Request>

      Response

      HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c6f</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Tts</Tag>
        <Operation>
            <TtsTpl>
                <Codec>mp3</Codec>
                <Mode>Sync</Mode>
                <Speed>100</Speed>
                <VoiceType>aixiaonan</VoiceType>
                <Volume>0</Volume>
            </TtsTpl>
            <TtsConfig>
                <Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
                <InputType>Text</InputType>
            </TtsConfig>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/tts.mp3</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</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