Domain name for API request: vod.tencentcloudapi.com.
This API is used to get the information of moderation templates.
The templates can only be used by the APIs ReviewAudioVideo and ReviewImage.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeReviewTemplates. |
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. |
Definitions.N | No | Array of Integer | The audit template uniquely identifies the filtering conditions, and the array length limit is: 100. |
Type | No | String | The template type. Valid values: |
Offset | No | Integer | The pagination offset. Default value: 0. |
Limit | No | Integer | The number of records to return. Default value: 10. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of records that meet the conditions. |
ReviewTemplateSet | Array of ReviewTemplate | The details of the moderation templates. |
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. |
This example shows you how to query moderation templates.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReviewTemplates
<Common request parameters>
{
"Definitions": [
10001
]
}
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"ReviewTemplateSet": [
{
"Comment": "Detect ads",
"Definition": 10001,
"UpdateTime": "2018-10-01T10:00:00Z",
"Name": "Detect Ads",
"Labels": [
"Ads"
],
"Type": "Custom",
"CreateTime": "2018-10-01T10:00:00Z"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?