tencent cloud

Submit a Task
Download PDF
Last updated: 2025-09-15 17:39:17
Submit a Task
Last updated: 2025-09-15 17:39:17
Download PDF

Feature Description

Submit a Text To Speech (TTS) task.

Authorization Description

When using a sub-account, add the ci:CreateMediaJobs permission to the authorization policy action. For all supported Cloud Infinite API operations, see CI action.
When a sub-account uses an asynchronous processing interface, it must be granted the cam:PassRole permission. The asynchronous processing interface performs COS read and write operations through CAM's "role." The PassRole permission is used for role passing. For details, please refer to Cloud Access Management > Write Operation > PassRole API.

Service Activation

To use this feature, you need to bind a bucket in advance and enable Cloud Infinite service.
To use this feature, enable Smart Audio Service in advance via the console or API.
Note:
Note: After binding Cloud Infinite (CI), if you manually perform unbind on the bucket, you will not be able to continue using this feature.

Use Limits

When using this API, please confirm the related use limits. For details, see Use Limits.

Fee Instructions

This API is a paid service, and the generated costs will be charged by Cloud Infinite. For billing details, see Smart Audio Fee.


Request

Request sample

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 details, see the Request Signature document.

Request header

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body

The implementation of this request operation requires the following request body:
<Request>
    <Tag>Tts</Tag>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <TtsConfig>
            <Input>Moonlight before my bed, could it be frost instead?</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 data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
Container Type Request specific data is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Create task Tag: Tts
String
Yes
Operation
Request
Operation rule
Container
Yes
CallBackFormat
Request
Job callback format, JSON or XML, default XML, priority is higher than queue callback format
String
No
CallBackType
Request
Job callback type, Url or TDMQ, default Url, priority is higher than queue callback type
String
No
CallBack
Request
Job callback address, priority is higher than queue callback address. When set to no, it means the queue callback address does not generate callbacks.
String
No
CallBackMqConfig
Request
Task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig
Container
No
Container Type
Operation
specific data is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
TemplateId
Request.Operation
TTS template ID. For details, see Creating TTS Templates
String
No
TtsTpl
Request.Operation
TTS parameters
Container
No
TtsConfig
Request.Operation
TTS task parameters
Container
Yes
Output
Request.Operation
Output configuration
Container
Yes
UserData
Request.Operation
Pass through user information, printable ASCII, length not exceeding 1024
String
No
JobLevel
Request.Operation
Task priority, level limit: 0, 1, 2. The larger the level, the higher the task priority. Default is 0.
String
No
Note:
Note: TTS parameters must be set through TemplateId or TtsTpl, with TemplateId having higher priority.
Container Type
TtsTpl
specific data is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Mode
Request.Operation.TtsTpl
Same as Request.Mode in the Create TTS Template API.
String
No
Codec
Request.Operation.TtsTpl
Same as Request.Codec in the Create TTS Template API.
String
No
VoiceType
Request.Operation.TtsTpl
Same as Request.VoiceType in the Create TTS Template API.
String
No
Volume
Request.Operation.TtsTpl
Same as Request.Volume in the Create TTS Template API.
String
No
Speed
Request.Operation.TtsTpl
Same as Request.Speed in the Create TTS Template API.
String
No
Emotion
Request.Operation.TtsTpl
Same as Request.Emotion in the Create TTS Template API.
String
No
Container Type
TtsConfig
specific data is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
InputType
Request.Operation.TtsConfig
Input type, Url/Text
String
Yes
Input
Request.Operation.TtsConfig
When InputType is Url, it must be a valid COS address. The file must be utf-8 encoded and no more than 10M in size. If the processing method is sync, the file content must not exceed 300 utf-8 characters. If the processing method is asynchronous, the file content must not exceed 10000 utf-8 characters.
When InputType is Text, the input must be utf-8 characters and no more than 300 characters.
String
Yes
Container Type
Output
specific data is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Region
Request.Operation.Output
Bucket Region
String
Yes
Bucket
Request.Operation.Output
Bucket for result storage
String
Yes
Object
Request.Operation.Output
Result Filename
String
Yes

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<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>
        <QueueType>Speeching</QueueType>
        <Tag>Tts</Tag>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>tts_demo</TemplateName>
            <TtsConfig>
                <Input>Moonlight before my bed, like frost on the ground</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 data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
JobsDetail
Response
Task Details
Container Array
Container node
JobsDetail
content:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
Error code, this parameter is valid only when State is Failed
String
Message
Response.JobsDetail
Error description, this parameter is valid only when State is Failed
String
JobId
Response.JobsDetail
ID of the newly created task
String
Tag
Response.JobsDetail
Tag of the newly created task: Tts
String
State
Response.JobsDetail
Task Status
Submitted: submitted, pending execution
Running: executing
Success: execution successful
Failed: execution failed
Pause: task is paused. When the queue is paused, to be executed tasks change to paused state.
Cancel: task cancelled
String
CreationTime
Response.JobsDetail
Task creation time
String
StartTime
Response.JobsDetail
Task Start Time
String
EndTime
Response.JobsDetail
Task Closed At
String
QueueId
Response.JobsDetail
Task belonging to Queue ID
String
QueueType
Response.JobsDetail
Task queue type
String
Operation
Response.JobsDetail
Task rule
Container
Container node Operation content:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.JobsDetail.Operation
Task template ID
String
TemplateName
Response.JobsDetail.Operation
Task template name, return when TemplateId exists
String
TtsTpl
Response.JobsDetail.Operation
Container
TtsConfig
Response.JobsDetail.Operation
Container
Output
Response.JobsDetail.Operation
Container
MediaInfo
Response.JobsDetail.Operation
The media information of the output file will not be returned if the task is ongoing. For details, see MediaInfo.
Container
MediaResult
Response.JobsDetail.Operation
The basic info of the output file will not be returned if the task is ongoing. For details, see MediaResult.
Container
UserData
Response.JobsDetail.Operation
Pass through user information
String
JobLevel
Response.JobsDetail.Operation
Task priority.
String

Error Code

This request returns common error responses and error codes. For more information, see Error Codes.

Practical Case

Request 1: Use a TTS Template ID

POST /jobs HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************
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>Moonlight before my bed, could it be frost instead?</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>
        <QueueType>Speeching</QueueType>
        <Tag>Tts</Tag>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>tts_demo</TemplateName>
            <TtsConfig>
                <Input>Moonlight before my bed, could it be frost instead?</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: Use TTS Parameters

POST /jobs HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************
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>ruxue</VoiceType>
            <Volume>0</Volume>
        </TtsTpl>
        <TtsConfig>
            <Input>Moonlight before my bed, could it be frost instead?</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>
        <QueueType>Speeching</QueueType>
        <Tag>Tts</Tag>
        <Operation>
            <TtsTpl>
                <Codec>mp3</Codec>
                <Mode>Sync</Mode>
                <Speed>100</Speed>
                <VoiceType>ruxue</VoiceType>
                <Volume>0</Volume>
            </TtsTpl>
            <TtsConfig>
                <Input>Moonlight before my bed, like frost on the ground</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>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback