Help & DocumentationAPIsVideo on DemandVideo Processing APIsProcessMediaByProcedure

ProcessMediaByProcedure

Last updated: 2020-03-27 18:45:23

1. API Description

Domain name for API request: vod.tencentcloudapi.com.

This API is used to initiate a processing task for a VOD video with a task flow template.
There are two ways to create a task flow template:

  1. Create and modify a task flow template in the console;
  2. Create a task flow template through the task flow template API.

A maximum of 100 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ProcessMediaByProcedure.
Version Yes String Common parameter. The value used for this API: 2018-07-17.
Region No String Common parameter. This parameter is not required for this API.
FileId Yes String Media file ID.
ProcedureName Yes String Task flow template name.
TasksPriority No Integer Task flow priority. The higher the value, the higher the priority. Value range: -10–10. If this parameter is left empty, 0 will be used.
TasksNotifyMode No String Notification mode for task flow status change. Valid values: Finish, Change, None. If this parameter is left empty, Finish will be used.
SessionContext No String The source context which is used to pass through the user request information. The task flow status change callback will return the value of this field. It can contain up to 1,000 characters.
SessionId No String ID used for deduplication. If there was a request with the same ID on the last day, the current request will return an error. The ID can contain up to 50 characters. If this parameter is left empty or a blank string is entered, no deduplication will be performed.
ExtInfo No String Reserved field for special purposes.
SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

3. Output Parameters

Parameter Name Type Description
TaskId String Task ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Initiating a task with task flow template name

This example shows you how to initiate a task with the task flow template named TranscodeAndSnapshot for fileId 5285485487985271487.

Input Example

https://vod.tencentcloudapi.com/?Action=ProcessMediaByProcedure
&FileId=5285485487985271487
&ProcedureName=TranscodeAndSnapshot
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
    "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.FileId The FileId does not exist.
InvalidParameterValue.ProcedureName The task flow template name is invalid.
InvalidParameterValue.SessionContextTooLong SessionContext is too long.
InvalidParameterValue.SessionId The deduplication ID already exists. The request is removed due to duplication.
InvalidParameterValue.SessionIdTooLong SessionId is too long.
InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
InvalidParameterValue.UniqueIdentifier The deduplication ID already exists on the same day. The request is removed due to duplication.
UnauthorizedOperation Unauthorized operation.