tencent cloud

CreateQualityControlTemplate
Last updated: 2025-12-02 14:26:50
CreateQualityControlTemplate
Last updated: 2025-12-02 14:26:50

1. API Description

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

This API is used to create a media quality inspection template. Up to 50 templates can be created.

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: CreateQualityControlTemplate.
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.
Name Yes String Media quality inspection template name, with a length limit of 64 characters.
QualityControlItemSet.N Yes Array of QualityControlItemConfig Media quality inspection control parameters.
Comment No String Media quality inspection template description, with a length limit of 256 characters.
RecordFormat No String Recording file format. Valid values:
  • PNG: PNG image.
  • Strategy No QualityControlStrategy Spot check policy for media quality inspection.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique identifier of a media quality inspection template.
    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 a Media Quality Inspection Template

    Input Example

    POST / HTTP/1.1
    Host: mps.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateQualityControlTemplate
    <Common request parameters>
    
    {
        "Name": "example2",
        "Comment": "",
        "QualityControlItemSet": [
            {
                "Type": "LowEvaluation",
                "Switch": "ON",
                "Threshold": "80",
                "Duration": 0,
                "IntervalTime": 1000
            },
            {
                "Type": "Mosaic",
                "Switch": "ON",
                "Threshold": "80",
                "Duration": 0,
                "IntervalTime": 1000
            }
        ],
        "Strategy": {
            "StrategyType": "TimeSpotCheck",
            "TimeSpotCheck": {
                "CheckDuration": 50,
                "CheckInterval": 10,
                "SkipDuration": 10,
                "CirclesNumber": 10
            }
        }
    }

    Output Example

    {
        "Response": {
            "Definition": 200090,
            "RequestId": "7bb44c6c-92d0-4dad-99cf-88f569c6d3ad"
        }
    }

    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
    InternalError Internal error.
    InternalError.GenDefinition Internal error: failed to generate template ID.
    InvalidParameter Parameter error.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.EmptyDetectItem The enabled detection items of the template are empty.
    InvalidParameterValue.UnknownCategory Unknown detection category.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback