Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to initiate moderation tasks for on-demand audio-video media, intelligently detecting violative content in video footage, text in visuals, text in speech, and sound.
If event notification is used, its type is audio/video moderation completed (https://www.tencentcloud.com/document/product/266/81258?from_cn_redirect=1).
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 | No | String | Media file ID, the globally unique ID of the file in VOD, assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification (https://www.tencentcloud.com/document/product/266/7830?from_cn_redirect=1) or the VOD console (https://console.tencentcloud.com/vod/media). |
| MediaStoragePath | No | String | Media storage path. Only sub-apps in FileID + Path mode can initiate tasks through MediaStoragePath. Either FileId or MediaStoragePath must be provided. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications, whether in the default application or a newly created application. |
| ReviewContents.N | No | Array of String | Content to review. Optional values: If this parameter is not specified or is set to an empty array, Media will be reviewed by default. |
| Definition | No | Integer | Content Review Template ID. Default value: 10. Value range: |
| TasksPriority | No | Integer | Priority of the task flow. The higher the value, the higher the priority. The value range is from -10 to 10. If left blank, the default value is 0. |
| SessionContext | No | String | Source context, used to pass through user request information. The value of this field will be returned in the audio/video moderation completion callback. It can contain up to 1000 characters. |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past three days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed. |
| ExtInfo | No | String | Reserved field, used for special purposes. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | 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. |
Initiate an audio/video moderation task for the video with fileId 5285485487985271487.
POST / HTTP/1.1
Host: vod.intl.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 | Parameter value error. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | Duplicate recognition code. Request deduplicated. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| LimitExceeded | The quota limit is exceeded. |
| ResourceNotFound | The resource does not exist. |
피드백