tencent cloud

APIs

CreateQualityInspectTemplate

Download
Focus Mode
Font Size
Last updated: 2026-09-18 15:59:29

1. API Description

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

This API is used to create an audio-visual 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

Video-on-demand (VOD) application ID. For customers who activate on-demand services from December 25, 2023, if they access resources in on-demand applications (whether the default application or a newly created application), this field must be filled in as the application ID.

Name No String

Audio and video quality inspection template name.

Comment No String

Audio and video quality inspection template description.

Configs.N No Array of QualityInspectConfig

Audio and video quality detection configuration parameters.

Strategy No QualityInspectStrategy

Spot check policy parameters for audio and video quality inspection.

ScreenshotInterval No Float

(Not recommended. Use Configs instead.) Frame interception interval in seconds. Minimum value: 1. If not specified, the default frame interval is 1 second.

JitterConfigure No JitterConfigureInfo

(Not recommended. Use Configs instead.) Control parameters for video frame jitter and ghosting detection.

BlurConfigure No BlurConfigureInfo

(Not recommended. Use Configs as an alternative.) Control parameters for video frame blur detection.

AbnormalLightingConfigure No AbnormalLightingConfigureInfo

(Not recommended. Use Configs as an alternative.) Control parameters for low-light and overexposure detection in video frames.

CrashScreenConfigure No CrashScreenConfigureInfo

(Not recommended. Use Configs as an alternative.) Control parameters for distortion detection in video footage.

BlackWhiteEdgeConfigure No BlackWhiteEdgeConfigureInfo

(Not recommended. Use Configs as an alternative.) Control parameters for detecting video picture black edges, white edges, black screen, and white screen.

NoiseConfigure No NoiseConfigureInfo

(Not recommended. Use Configs instead.) Control parameters for video frame noise detection.

MosaicConfigure No MosaicConfigureInfo

(Not recommended. Use Configs instead.) Control parameters for video frame mosaic detection.

QRCodeConfigure No QRCodeConfigureInfo

(Not recommended. Use Configs as an alternative.) Control parameters for video frame QR code detection.

VoiceConfigure No VoiceConfigureInfo

(Not recommended, use Configs as an alternative) Control parameters for audio (mute, bass, pop) detection.

QualityEvaluationConfigure No QualityEvaluationConfigureInfo

(Not recommended. Use Configs instead.) Control parameters for video frame quality evaluation.

3. Output Parameters

Parameter Name Type Description
Definition Integer

Audio and video quality inspection 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 Creating an Audio-Visual Quality Inspection Template

Create an audio-visual quality inspection template.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateQualityInspectTemplate
<Common request parameters>

{
    "SubAppId": 123,
    "Name": "MyTemplate",
    "Comment": "my template for jitter",
    "JitterConfigure": {
        "Switch": "ON"
    }
}

Output Example

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

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 Operation failed.
InternalError Internal error.
InvalidParameterValue Parameter value error.
LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback