Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to initiate a digital watermark extraction task for a video. The extraction result can be queried through DescribeTaskDetail.
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: ExtractBlindWatermark. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Type | Yes | String | Digital watermark type. Valid values: |
| InputInfo | Yes | ExtractBlindWatermarkInputInfo | File input information for the Media Processing Service (MPS) task. |
| SubAppId | Yes | Integer | VOD application ID for watermarking. Note that the SubAppId must be in line with the one used during watermarking to extract the watermark, whether importing FILEID or URL. |
| ExtractBlindWatermarkConfig | No | ExtractBlindWatermarkTaskConfig | Configuration of the digital watermark extraction task. |
| SessionContext | No | String | Identify source context, used for passing through user request information. The value of this field will be returned in the ExtractBlindWatermarkComplete callback and task flow status change callback, with a maximum length of 1000 characters. |
| SessionId | No | String | An identification code for task deduplication. If there has been a request with the same identification code within the past 3 days, an error will be returned for the current request. The maximum length is 50 characters. Leaving it blank or with an empty string indicates no deduplication. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value ranges from -10 to 10. If left blank, it represents 0. |
| 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. |
This example shows you how to initiate a digital watermark extraction task for a video.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExtractBlindWatermark
<Common request parameters>
{
"Type": "blind-basic",
"InputInfo": {
"Type": "URL",
"Url": "http://test.cos.com/video.mp4"
},
"ExtractBlindWatermarkConfig": {
"SegmentDuration": 5000
}
}
{
"Response": {
"RequestId": "2134541-fdc5-4b08-bf2d-97f7d6678b44",
"TaskId": "24000105-ExtractBlindWatermark-xxxxxx"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.SrcFile | Source file error. |
文档反馈