tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVideoModerationTask

Last updated: 2024-11-26 10:56:32

    1. API Description

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

    This API is used to create a video moderation task via a URL or bucket.

    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: CreateVideoModerationTask.
    Version Yes String Common Params. The value used for this API: 2021-09-22.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
    BizType Yes String Business type, which is used to define a template policy.
    Type Yes String Task type. Values: VIDEO (video on demand), LIVE_VIDEO (live video).
    Tasks.N Yes Array of TaskInput Task information. You can create up to 10 tasks at a time.
    Seed No String Key of the callback signature. For more details, see the signature documentation.
    CallbackUrl No String Callback URL that will receive moderation information. After it is configured, the non-compliant audio segments detected in moderation will be sent through this API.
    Priority No Integer Priority, which determines the execution order of your moderation tasks. The default value is 0.

    3. Output Parameters

    Parameter Name Type Description
    Results Array of TaskResult Task creation result
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Creating video moderation task

    This example shows you how to create a video moderation task.

    Input Example

    https://vm.intl.tencentcloudapi.com/?Action=CreateVideoModerationTask
&BizType=1001
&Type=VIDEO
&Tasks.0.DataId=test_data_1
&Tasks.0.Input.Type=URL
&Tasks.0.Input.Url=https://v.com/test.mp4
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Results": [
            {
                "DataId": "0a782332-c9db-4cf5-a66e-20d60b4ea469",
                "TaskId": "c933aca1-90d2-4ab8-b045-f1b08069d76f",
                "Code": "OK",
                "Message": "Success"
            }
        ],
        "RequestId": "c933aca1-90d2-4ab8-b045-f1b08069d76f"
    }
}

    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
    DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded The quota limit has been reached.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    ResourceInUse The resource is occupied.
    ResourceInsufficient Insufficient resource.
    ResourceNotFound The resource doesn’t exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.Unauthorized Operation not authorized/Invalid package/Account overdue
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy