tencent cloud



Last updated: 2024-03-27 16:09:23

    1. API Description

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

    Creates media quality inspection template.

    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: CreateQualityInspectTemplate.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Name No String Media quality inspect template name.Length limit: 64 characters.
    Comment No String Template description. Length limit: 256 characters.
    ScreenshotInterval No Float Frame interval, unit in seconds, minimum value is 1. When not filled, the default frame interval is 1 second.
    JitterConfigure No JitterConfigureInfo Control parameters for detecting video jitter and ghosting.
    BlurConfigure No BlurConfigureInfo Control parameters for detecting video blur.
    AbnormalLightingConfigure No AbnormalLightingConfigureInfo Control parameters for detecting low brightness and overexposure of video.
    CrashScreenConfigure No CrashScreenConfigureInfo Control parameters for detecting video crash.
    BlackWhiteEdgeConfigure No BlackWhiteEdgeConfigureInfo Control parameters for detecting video black edges, white edges, black screen, and white screen.
    NoiseConfigure No NoiseConfigureInfo Control parameters for detecting video noise.
    MosaicConfigure No MosaicConfigureInfo Control parameters for detecting video mosaic.
    QRCodeConfigure No QRCodeConfigureInfo Control parameters for QR code detection in video.
    VoiceConfigure No VoiceConfigureInfo Control parameters for audio (mutes, bass, blast sound).
    QualityEvaluationConfigure No QualityEvaluationConfigureInfo Control parameters for video quality evaluation.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Media quality inspect template 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 Creates media quality inspection template.

    Creates media quality inspection template.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateQualityInspectTemplate
    <Public Request Parameter>
        "SubAppId": 123,
        "Name": "test",
        "Comment": "abc",
        "JitterConfigure": {
            "Switch": "ON"

    Output Example

        "Response": {
            "Definition": 20001,
            "RequestId": "3c140219-cfe9-470e-b241-907873d6fb03"

    5. Developer Resources


    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 Operation failed.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded.TooMuchTemplate Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support