tencent cloud

Submitting Tasks
Download PDF
Last updated: 2025-11-19 16:00:41
Submitting Tasks
Last updated: 2025-11-19 16:00:41
Download PDF

Feature Description

Submit a splicing job.

Authorization Description

When used with a sub-account, the ci:CreateMediaJobs permission is required. For details, see Cloud Infinite action.
When a sub-account uses an asynchronous processing interface, the cam:passrole permission is required. The asynchronous processing interface performs read and write operations on COS resources through CAM's "role". The PassRole permission is used for role passing. For details, refer to Access Management - Write Operation - PassRole API.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling Media Processing Service in advance via console or API. For details, see Enable Media Processing Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.

Fee Description

This API is a paid service. Incurred fees will be collected by Cloud Infinite. For detailed billing instructions, see Media Processing Fees.


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>Concat</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.${ext}</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
The specific data description of the Container type Request is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Create task Tag: Concat
String
Yes
Input
Request
File information to be operated
Container
Yes
Operation
Request
Operation rule
Container
Yes
CallBackFormat
Request
job callback format, JSON or XML, default XML, priority is higher than the callback format of the queue
String
No
CallBackType
Request
job callback type, Url or TDMQ, default Url, priority is higher than the callback type of the queue
String
No
CallBack
Request
job callback address, priority is higher than the callback address of the queue. When set to no, it means the queue's callback address does not generate a callback.
String
No
CallBackMqConfig
Request
Task callback TDMQ configuration, required when CallBackType is TDMQ. For details, see CallBackMqConfig.
Container
No
The specific data description of the Container type Input is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Object
Request.Input
file path
String
Yes
The specific data description of the Container type
Operation
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
TemplateId
Request.Operation
Splicing template ID
String
No
ConcatTemplate
Request.Operation
Combine parameters
Container
No
WatermarkTemplateId
Request.Operation
watermark template ID, you can pass multiple watermark template IDs, up to 3
String array
No
Watermark
Request.Operation
watermark template parameters, same as Request.Watermark in the create watermark template API, up to 3 can be passed
Container array
No
Output
Request.Operation
Output configuration for results
Container
Yes
JobLevel
Request.Operation
Task priority, level limit: 0, 1, 2. Higher levels indicate higher task priority, default is 0.
String
No
Note:
Concatenating parameters must be set, which can be configured through TemplateId or ConcatTemplate. TemplateId has higher priority.
The specific data description of the Container type ConcatTemplate is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
ConcatFragment
Request.Operation.ConcatTemplate
Concatenate nodes, support multiple files, concatenate according to file order
Container array
None.
No
Audio
Request.Operation.ConcatTemplate
audio parameters, same as Request.ConcatTemplate.Audio in the splicing template creation API
Container
None.
No
Video
Request.Operation.ConcatTemplate
video parameters, same as Request.ConcatTemplate.Video in the splicing template creation API
Container
None.
No
Container
Request.Operation.ConcatTemplate
encapsulation format, same as Request.ConcatTemplate.Container in the splicing template creation API
Container
None.
Yes
AudioMix
Request.Operation.ConcatTemplate
Audio mix parameter. For details, see AudioMix
Container
None.
No
AudioMixArray
Request.Operation.Transcode
Mixing parameter array, up to 2 can be transmitted simultaneously
Container array
None.
No
Index
Request.Operation.ConcatTemplate
Input node is located at ConcatFragment sequence index, cannot be greater than ConcatFragment length
String
0
No
SceneChangeInfo
Request.Operation.ConcatTemplate
Transition parameter
Container
None.
No
Note:
AudioMix and AudioMixArray are valid only when Audio.Remove is false.
AudioMixArray is an array. Each sub-item has the same content as AudioMix. AudioMix has higher priority. When setting AudioMix, AudioMixArray becomes invalid.
The specific data description of the Container type ConcatFragment is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Url
Request.Operation.ConcatTemplate.ConcatFragment
Object address of the same bucket Not required to URL encode
String
None.
Yes
FragmentIndex
Request.Operation.ConcatTemplate.ConcatFragment
Index position of the spliced object, an integer greater than or equal to 0
String
0
No
StartTime
Request.Operation.ConcatTemplate.ConcatFragment
Start Time
video duration
Unit: seconds
When Request.Operation.ConcatTemplate.DirectConcat is true, it does not take effect.
String
Video start
No
EndTime
Request.Operation.ConcatTemplate.ConcatFragment
End Time
video duration
in seconds
When Request.Operation.ConcatTemplate.DirectConcat is true, it does not take effect.
String
Video end
No
The specific data description of the Container type Output is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Region
Request.Operation.Output
Region of the bucket
String
Yes
Bucket
Request.Operation.Output
Bucket for storing results
String
Yes
Object
Request.Operation.Output
Filename of the output result
String
Yes
Wildcard characters supported by Request.Operation.Output.Object are as follows:
Wildcard
Meaning
${ext}
encapsulation format
${jobid}
task Id

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>
        <Tag>Concat</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>concat_demo</TemplateName>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.${ext}</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 detailed information
Container array
The content of Container node
JobsDetail
:
Node Name (Keyword)
Parent Node
Description
Type
Code
Response.JobsDetail
Error code, which is meaningful only when State is Failed.
String
Message
Response.JobsDetail
Error description, which is meaningful only when State is Failed.
String
JobId
Response.JobsDetail
Newly created task ID
String
Tag
Response.JobsDetail
Newly created task Tag: Concat
String
State
Response.JobsDetail
Task Status
Submitted: to be executed
Running: in execution
Success: execution successful
Failed: execution failed
Pause: task pause, when the pause queue is triggered, pending tasks will become paused state
Cancel: task cancelled
String
CreationTime
Response.JobsDetail
Task Creation Time
String
StartTime
Response.JobsDetail
Task Start Time
String
EndTime
Response.JobsDetail
Task End Time
String
QueueId
Response.JobsDetail
Task's Queue ID
String
Input
Response.JobsDetail
Input resource address of the task
Container
Operation
Response.JobsDetail
Rules of the task
Container
Contents of the Container node Input:
Node Name (Keyword)
Parent Node
Description
Type
Region
Response.JobsDetail.Input
Region of the bucket
String
Bucket
Response.JobsDetail.Input
Bucket for storing results
String
Object
Response.JobsDetail.Input
Filename of the output result
String
Contents of the Container node Operation:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.JobsDetail.Operation
Job template ID
String
TemplateName
Response.JobsDetail.Operation
Task template name, return when TemplateId exists
String
ConcatTemplate
Response.JobsDetail.Operation
Concatenate template in in-progress Request
Container
Output
Response.JobsDetail.Operation
Output of the in-progress Request's Operation
Container
MediaInfo
Response.JobsDetail.Operation
Media information of the output file, not returned if the task is incomplete. For details, see MediaInfo
Container
MediaResult
Response.JobsDetail.Operation
Basic information of the output file, not returned if the task is incomplete. For details, see MediaResult
Container
UserData
Response.JobsDetail.Operation
Pass through user information
String
JobLevel
Response.JobsDetail.Operation
Task Priority
String

Error Codes

For common error messages, please refer to the Error Codes document.

Examples

Request 1: Use Splicing Template ID

Request

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-123456789.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>Concat</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.${ext}</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: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<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>Concat</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
            <TemplateName>concat_demo</TemplateName>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.${ext}</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

Request 2: Use Concatenated Parameters

Request

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-123456789.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>Concat</Tag>
    <Input>
        <Object>input/demo.mp4</Object>
    </Input>
    <Operation>
        <ConcatTemplate>
            <ConcatFragment>
                <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/start.mp4</Url>
            </ConcatFragment>
            <ConcatFragment>
                <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/end.mp4</Url>
            </ConcatFragment>
            <Audio>
                <Codec>mp3</Codec>
            </Audio>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Height>720</Height>
                <Fps>30</Fps>
            </Video>
            <Container>
                <Format>mp4</Format>
            </Container>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
        </ConcatTemplate>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.${ext}</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: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c5d</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Concat</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <ConcatTemplate>
                <ConcatFragment>
                    <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/start.mp4</Url>
                </ConcatFragment>
                <ConcatFragment>
                    <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/end.mp4</Url>
                </ConcatFragment>
                <Audio>
                    <Codec>mp3</Codec>
                </Audio>
                <Video>
                    <Codec>H.264</Codec>
                    <Bitrate>1000</Bitrate>
                    <Width>1280</Width>
                    <Height>720</Height>
                    <Fps>30</Fps>
                </Video>
                <Container>
                    <Format>mp4</Format>
                </Container>
                <AudioMixArray>
                    <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
                    <MixMode>Once</MixMode>
                    <Replace>true</Replace>
                    <EffectConfig>
                        <EnableStartFadein>true</EnableStartFadein>
                        <StartFadeinTime>3</StartFadeinTime>
                        <EnableEndFadeout>false</EnableEndFadeout>
                        <EndFadeoutTime>0</EndFadeoutTime>
                        <EnableBgmFade>true</EnableBgmFade>
                        <BgmFadeTime>1.7</BgmFadeTime>
                    </EffectConfig>
                </AudioMixArray>
                <AudioMixArray>
                    <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
                    <MixMode>Once</MixMode>
                    <Replace>true</Replace>
                    <EffectConfig>
                        <EnableStartFadein>true</EnableStartFadein>
                        <StartFadeinTime>3</StartFadeinTime>
                        <EnableEndFadeout>false</EnableEndFadeout>
                        <EndFadeoutTime>0</EndFadeoutTime>
                        <EnableBgmFade>true</EnableBgmFade>
                        <BgmFadeTime>1.7</BgmFadeTime>
                    </EffectConfig>
                </AudioMixArray>
                <Index>1</Index>
            </ConcatTemplate>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.${ext}</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
    </JobsDetail>
</Response>

Request 3: File Concatenation for Multiple Files

Request

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-123456789.ci.ap-chongqing.myqcloud.com
Content-Length: 166
Content-Type: application/xml

<Request>
    <Tag>Concat</Tag>
    <Operation>
        <ConcatTemplate>
            <ConcatFragment>
                <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/start.mp4</Url>
                <FragmentIndex>0</FragmentIndex>
                <StartTime>0</StartTime>
                <EndTime>6</EndTime>
            </ConcatFragment>
            <ConcatFragment>
                <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/middle.mp4</Url>
                <FragmentIndex>1</FragmentIndex>
            </ConcatFragment>
            <ConcatFragment>
                <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/end.mp4</Url>
                <FragmentIndex>2</FragmentIndex>
                <StartTime>5</StartTime>
                <EndTime>10</EndTime>
            </ConcatFragment>
            <Container>
                <Format>mp4</Format>
            </Container>
        </ConcatTemplate>
        <Output>
            <Region>ap-chongqing</Region>
            <Bucket>test-123456789</Bucket>
            <Object>output/out.${ext}</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: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <Message/>
        <JobId>j8d121820f5e411ec926ef19d53ba9c5d</JobId>
        <State>Submitted</State>
        <CreationTime>2022-06-27T15:23:10+0800</CreationTime>
        <StartTime>-</StartTime>
        <EndTime>-</EndTime>
        <QueueId>p2242ab62c7c94486915508540933a2c6</QueueId>
        <Tag>Concat</Tag>
        <Input>
            <BucketId>test-123456789</BucketId>
            <Object>input/demo.mp4</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <Operation>
            <ConcatTemplate>
                <ConcatFragment>
                    <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/start.mp4</Url>
                    <StartTime>0</StartTime>
                    <EndTime>6</EndTime>
                </ConcatFragment>
                <ConcatFragment>
                    <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/middle.mp4</Url>
                </ConcatFragment>
                <ConcatFragment>
                    <Url>http://test-123456789.cos.ap-chongqing.myqcloud.com/end.mp4</Url>
                    <StartTime>5</StartTime>
                    <EndTime>10</EndTime>
                </ConcatFragment>
                <Container>
                    <Format>mp4</Format>
                </Container>
            </ConcatTemplate>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/out.${ext}</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