Domain name for API request: vod.intl.tencentcloudapi.com.
This API is no longer maintained. Please use the ProcessMedia API of MPS and specify the video URL in the input parameter InputInfo.UrlInputInfo.Url.
A maximum of 100 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: ProcessMediaByUrl. |
| 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 | 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 the default application or a newly created application). |
| InputInfo | No | MediaInputInfo | The API is no longer maintained. For the Recommended Alternative API, refer to the API description. |
| OutputInfo | No | MediaOutputInfo | Output file COS path information. |
| AiContentReviewTask | No | AiContentReviewTaskInput | Parameters for the video content review task. |
| AiAnalysisTask | No | AiAnalysisTaskInput | Parameters for the video content analysis task. |
| AiRecognitionTask | No | AiRecognitionTaskInput | Parameters for the video content recognition task. |
| 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. |
| TasksNotifyMode | No | String | Task flow status change notification mode. Valid values: Finish, Change, and None. If not specified, the default is Finish. |
| SessionContext | No | String | Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters. |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past 3 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. |
| 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 content analysis task for a video with the URL
http://www.abc.com/abc.mp4
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByUrl
<Common request parameters>
{
"InputInfo": {
"Url": "http://www.abc.com/abc.mp4",
"Name": "great power diplomacy",
"Id": "872988202"
},
"OutputInfo": {
"Region": "ap-guangzhou",
"Bucket": "myoutputbucket-1256244234",
"Dir": "/output/test/"
},
"AiAnalysisTask": {
"Definition": 10
}
}{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-procedurev2-813dc41e6fdc22dcf24aa6e9c61cp92"
}
}This example shows you how to initiate a content review task for a video with the URL
http://www.abc.com/abc.mp4
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByUrl
<Common request parameters>
{
"InputInfo": {
"Url": "http://www.abc.com/abc.mp4",
"Name": "great power diplomacy",
"Id": "872988202"
},
"OutputInfo": {
"Region": "ap-guangzhou",
"Bucket": "myoutputbucket-1256244234",
"Dir": "/output/test/"
},
"AiContentReviewTask": {
"Definition": 10
}
}{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"TaskId": "125xxxxxx07-procedurev2-893dc41e6fdc22dcf24aa6e9c61cp94"
}
}This example shows you how to initiate a content recognition task for a video with the URL
http://www.abc.com/abc.mp4
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ProcessMediaByUrl
<Common request parameters>
{
"InputInfo": {
"Url": "http://www.abc.com/abc.mp4",
"Name": "Great Power Diplomacy",
"Id": "872988202"
},
"OutputInfo": {
"Region": "ap-guangzhou",
"Bucket": "myoutputbucket-1256244234",
"Dir": "/output/test/"
},
"AiRecognitionTask": {
"Definition": 10
}
}{
"Response": {
"RequestId": "5ca61e3a-6b8e-4b4e-9256-fdc701190064fk3",
"TaskId": "125xxxxxx07-procedurev2-813dc41e6fdc22dcf24aa6e9c61f3t0"
}
}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. |
| FailedOperation.TaskDuplicate | Operation failed: duplicate task. |
| InternalError | Internal error. |
| InternalError.GetFileInfoError | Internal error: media file info error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.AiAnalysisTaskDefinition | Parameter value error: AI analysis Definition. |
| InvalidParameterValue.AiContentReviewTaskDefinition | Parameter value error: AI content review Definition. |
| InvalidParameterValue.AiRecognitionTaskDefinition | Parameter value error: AI recognition Definition. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | Duplicate recognition code. Request deduplicated. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| InvalidParameterValue.SubAppId | Parameter value error: app ID. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback