tencent cloud

APIs

BatchProcessMedia

Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-06 17:49:18

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to initiate batch processing tasks for URL video links, with features including:
Smart subtitle (full speech, speech hotword, and speech translation)

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: BatchProcessMedia.
Version Yes String Common Params. The value used for this API: 2019-06-12.
Region No String Common Params. This parameter is not required for this API.
InputInfo.N Yes Array of MediaInputInfo

Input information of the media processing file.

OutputStorage No TaskOutputStorage

Target storage for media processing output files. If left empty, it inherits the storage location in InputInfo.
Note: When InputInfo.Type is URL, this parameter is required. Currently, only COS output is supported.

OutputDir No String

Target directory for output files generated by media processing. Must start and end with a slash (/), such as /movie/201907/.
If left empty, the directory is the same as the directory of the file in InputInfo.

SmartSubtitlesTask No SmartSubtitlesTaskInput

Smart subtitle.

TaskNotifyConfig No TaskNotifyConfig

Event notification information of the task. If this is not specified, no event notification is obtained.

TasksPriority No Integer

Priority of the task flow. The higher the value, the higher the priority. The value range is from -10 to 10. If this is not specified, the default value is 0.

SessionContext No String

Source context. This is used to pass user request information. The task status change callback returns the value of this field. The maximum length is 1000 characters.

ResourceId No String

Resource ID. The resource needs to be enabled. The default value is the account's primary resource ID.

SkipMateData No Integer

Whether to skip metadata acquisition. Valid values:
0: Do not skip,
1: Skip,
Default value: 0.

TaskMode No String

Execution mode. Valid values:

  • Parallel: Concurrent execution,
  • Serial: Serial execution.
  • Note: The default mode is concurrent execution.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String

    Task ID.

    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Initiating a Task

    Input Example

    POST / HTTP/1.1
    Host: mps.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: BatchProcessMedia
    <Common request parameters>
    
    {
        "InputInfo": [
            {
                "Type": "URL",
                "UrlInputInfo": {
                    "Url": "https://tetst-xxx-12xxxxx.cos.ap-xxxxx.myqcloud.com/processmedia/52.mp4"
                }
            }
        ],
        "OutputStorage": {
            "Type": "COS",
            "CosOutputStorage": {
                "Bucket": "tetst-xxxx-125xxxxx",
                "Region": "ap-xxxxx"
            }
        },
        "OutputDir": "/output/",
        "SmartSubtitlesTask": {
            "RawParameter": {
                "SubtitleType": 2,
                "VideoSrcLanguage": "zh",
                "SubtitleFormat": "vtt",
                "TranslateSwitch": "ON",
                "TranslateDstLanguage": "en"
            }
        },
        "TaskNotifyConfig": {
            "NotifyType": "URL",
            "NotifyUrl": "http://xxxx.com/v2/push/mps_test?token=73YcsZyP"
        },
        "SessionContext": "asdzxcs"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "b30891cd-cdc7-47db-94d3-4dbb85641dad",
            "TaskId": "24000030-BatchTask-e6fefa34fc497449c1a043b9a594c7det20"
        }
    }
    

    5. Developer Resources

    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
    FailedOperation.GenerateResource Resource generation failed.
    FailedOperation.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.
    InvalidParameter Parameter error.
    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.

    Ajuda e Suporte

    Esta página foi útil?

    comentários