1. API Description
Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to modify a custom moderation template.
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.
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.
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: ModifyReviewTemplate. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-07-17. |
| Region |
No |
String |
Common Params. This parameter is not required. |
| Definition |
Yes |
Integer |
|
| 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 |
|
| Comment |
No |
String |
|
| Labels.N |
No |
Array of String |
The violation labels to use. Valid values: Porn: Pornographic content Terror: Terrorist content Moan: Moaning |
3. Output Parameters
| Parameter Name |
Type |
Description |
| 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 Modifying a moderation template
This example shows you how to modify a template so that it detects only pornographic and terrorist content and no longer detects ads.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReviewTemplate
<Common request parameters>
{
"Definition": 20123,
"Comment": "Detects pornographic and terrorist content.",
"Labels": [
"Porn",
"Terror"
]
}
Output Example
{
"Response": {
"RequestId": "67ae8d8e-dce3-4151-9d4b-5594145287e2"
}
}
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 |
Incorrect parameter value. |
| InvalidParameterValue.Comment |
Invalid parameter: template description. |
| InvalidParameterValue.Labels |
Parameter error: Invalid label. |
| InvalidParameterValue.Name |
Incorrect parameter value: Name exceeds the length limit. |
| ResourceNotFound.TemplateNotExist |
The resource does not exist: the template does not exist. |
| UnauthorizedOperation |
Unauthorized operation. |