Domain name for API request: vod.tencentcloudapi.com.
We have stopped updating this API. Our new moderation templates can moderate audio/video as well as images. For details, see DescribeReviewTemplates.
This API is used to get the information of custom and preset audio/video moderation templates based on template IDs.
A maximum of 10 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: DescribeContentReviewTemplates. |
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 | Unique IDs for filters of an intelligent content recognition template. Array length limit: 100. |
Offset | No | Integer | Pagination offset. Default value: 0. |
Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. |
ContentReviewTemplateSet | Array of ContentReviewTemplateItem | List of intelligent content recognition template details. |
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. |
Get the content moderation template with template ID 30
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContentReviewTemplates
<Public Request Parameter>
{
"Definitions": [
"30"
]
}
{
"Response": {
"TotalCount": 2,
"ContentReviewTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Comment": "Content moderation template",
"ReviewWallSwitch": "ON",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"bloody"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"FaceReviewInfo": {
"Switch": "ON",
"LabelSet": [
"abc"
],
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"ScreenshotInterval": 1,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
},
{
"Definition": 31,
"Name": "Template2",
"Comment": "Content moderation template",
"ReviewWallSwitch": "ON",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"FaceReviewInfo": {
"Switch": "ON",
"LabelSet": [
"def"
],
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"ScreenshotInterval": 1,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}
Starting from serial number 0, get 10 content review templates, including the system default content review template.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContentReviewTemplates
<Public Request Parameter>
{
"Limit": "10",
"Offset": "0"
}
{
"Response": {
"TotalCount": 2,
"ContentReviewTemplateSet": [
{
"Definition": 30,
"Name": "Template 1",
"Comment": "Content moderation template",
"ReviewWallSwitch": "ON",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"bloody"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"FaceReviewInfo": {
"Switch": "ON",
"LabelSet": [
"abc"
],
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"ScreenshotInterval": 1,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
},
{
"Definition": 31,
"Name": "Template2",
"Comment": "Content moderation template",
"ReviewWallSwitch": "ON",
"PornConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"porn"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"TerrorismConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"OcrReviewInfo": {
"Switch": "OFF",
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"PoliticalConfigure": {
"ImgReviewInfo": {
"Switch": "ON",
"LabelSet": [
"politician"
],
"BlockConfidence": 80,
"ReviewConfidence": 30
},
"AsrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"BlockConfidence": 100,
"ReviewConfidence": 75
}
},
"ProhibitedConfigure": null,
"UserDefineConfigure": {
"AsrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"OcrReviewInfo": {
"Switch": "ON",
"LabelSet": [],
"BlockConfidence": 100,
"ReviewConfidence": 75
},
"FaceReviewInfo": {
"Switch": "ON",
"LabelSet": [
"def"
],
"BlockConfidence": 0,
"ReviewConfidence": 0
}
},
"ScreenshotInterval": 1,
"CreateTime": "2019-01-01T12:00:00Z",
"UpdateTime": "2019-01-01T16:00:00Z"
}
],
"RequestId": "19ae8d8e-dce3-4151-9d4b-5594384987a9"
}
}
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. |
FailedOperation.InvalidVodUser | The VOD service is not activated. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue.Definitions | Invalid parameter: Definitions. |
InvalidParameterValue.Limit | Invalid parameter: Limit. |
ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?