Domain name for API request: vod.tencentcloudapi.com.
This API is used to start a moderation task on a file stored in VOD to detect non-compliant content in images, text, speech, and voice.
If event notifications are used, the event type is ReviewAudioVideoComplete.
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: ReviewAudioVideo. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
Region | No | String | Common Params. This parameter is not required. |
FileId | Yes | String | The media file ID, which is assigned after upload and uniquely identifies a file in VOD. You can view the ID of a file in the NewFileUpload callback or in the VOD console. |
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. |
ReviewContents.N | No | Array of String | The type of moderated content. Valid values:Media : The original audio/video.Cover : Thumbnails.If this parameter is not specified or an empty array is passed in, Media will be used. |
Definition | No | Integer | The moderation template ID. Valid values: Porn and Terror . |
TasksPriority | No | Integer | The priority of a task flow. The higher the value, the higher the priority. Value range: [-10, 10]. If this parameter is left empty, 0 will be used. |
SessionContext | No | String | The source context, which is used to pass through user request information. The ReviewAudioVideoComplete callback will return the value of this parameter. It can contain up to 1,000 characters. |
SessionId | No | String | The session ID, which is used to identify duplicate requests. If there was a request with the same session ID in the last three days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified. |
ExtInfo | No | String | A reserved parameter. |
Parameter Name | Type | Description |
---|---|---|
TaskId | String | The task 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. |
This example shows you how to start a moderation task on a file whose file ID is 5285485487985271487
.
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReviewAudioVideo
<Common request parameters>
{
"FileId": "5285485487985271487"
}
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TaskId": "125xxx65-ReviewAudioVideo-bffb15f07530b57bc1aabb01fac74bcb"
}
}
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. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
InvalidParameterValue.SessionId | The deduplication ID already exists. The request is removed due to duplication. |
InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
LimitExceeded | Quota limit is exceeded. |
ResourceNotFound | The resource does not exist. |
本页内容是否解决了您的问题?