Release Notes
Announcements
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to query the details of the task execution status and results by task ID (tasks submitted within the last 7 days can be queried).
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: DescribeBatchTaskDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| TaskId | Yes | String | Video processing task ID. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskType | String | Task type. Currently, the valid values include: |
| Status | String | Task status. Valid values: |
| CreateTime | String | Task creation time in ISO datetime format. |
| BeginProcessTime | String | Task execution start time in ISO datetime format. |
| FinishTime | String | Task execution completion time in ISO datetime format. |
| TaskId | String | Media processing task ID. |
| BatchTaskResult | BatchSubTaskResult | Video processing task information. this field has a value only when TaskType is BatchTask. |
| TaskNotifyConfig | TaskNotifyConfig | Event notification information of the task. Note: This field may return null, indicating that no valid value can be obtained. |
| TasksPriority | Integer | Priority of the task flow, with a value range of [-10, 10]. |
| SessionId | String | An identifier for deduplication. If there has been a request with the same identifier within the past seven days, an error will be returned for the current request. The maximum length is 50 characters. Leaving it blank or using a null string indicates no deduplication is required. |
| SessionContext | String | Source context, which is used to pass through user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters. |
| ExtInfo | String | Additional information field, only used in specific scenarios. |
| 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. |
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchTaskDetail
<Common request parameters>
{
"TaskId": "24xxxx-BatchTask-6b24c23ee5xxxxxx"
}
{
"Response": {
"BatchTaskResult": {
"InputInfos": [
{
"CosInputInfo": {
"Bucket": "",
"Object": "",
"Region": ""
},
"S3InputInfo": null,
"Type": "URL",
"UrlInputInfo": {
"Url": "http://tetst-xxxx-12234xxx.cos.ap-xxxx.myqcloud.com/processmedia/52.mp4"
}
}
],
"Metadatas": [
{
"AudioDuration": 55.454,
"AudioStreamSet": [
{
"Bitrate": 252293,
"Channel": 1,
"Codec": "aac",
"SamplingRate": 44100
}
],
"Bitrate": 1734778,
"Container": "mp4",
"Duration": 55.455,
"Height": 1080,
"Rotate": 0,
"Size": 12025270,
"VideoDuration": 54.955,
"VideoStreamSet": [
{
"Bitrate": 1487136,
"Codec": "h264",
"Codecs": "",
"ColorPrimaries": "",
"ColorSpace": "",
"ColorTransfer": "",
"Fps": 32,
"FpsDenominator": 0,
"FpsNumerator": 0,
"HdrType": "sdr",
"Height": 1080,
"Width": 1920
}
],
"Width": 1920
}
],
"SmartSubtitlesTaskResult": {
"Input": {
"Definition": 0,
"RawParameter": {
"AsrHotWordsConfigure": null,
"ExtInfo": "",
"SubtitleFormat": "vtt",
"SubtitleType": 2,
"TranslateDstLanguage": "en",
"TranslateSwitch": "ON",
"VideoSrcLanguage": "zh"
}
},
"Outputs": [
{
"ErrCodeExt": "",
"Message": "SUCCESS",
"Progress": 100,
"Status": "SUCCESS",
"TransTextTask": {
"SegmentSet": [
{
"Confidence": 99,
"EndTimeOffset": 2.424,
"StartTimeOffset": 1.774,
"Text": "",
"Trans": "Walking.",
"Wordlist": []
},
{
"Confidence": 99,
"EndTimeOffset": 55.121,
"StartTimeOffset": 53.721,
"Text": "",
"Trans": "Just before you tell me.",
"Wordlist": []
}
],
"SubtitlePath": "http://tetst-xxxx-12234xxx.cos.ap-xxxx.myqcloud.com/output/3529.vtt"
}
}
]
}
},
"BeginProcessTime": "2025-05-17T07:15:11Z",
"CreateTime": "2025-05-17T07:15:11Z",
"ExtInfo": "",
"FinishTime": "2025-05-17T07:15:36Z",
"RequestId": "0af8e6df-622d-49b5-98e6-4d8e3f294e5f",
"SessionContext": "asdzxcs",
"SessionId": "qwer123",
"Status": "FINISH",
"TaskId": "24xxxxx-BatchTask-e6fefa34fc497xxxxxxx7det20",
"TaskNotifyConfig": {
"AwsSQS": null,
"CmqModel": "",
"CmqRegion": "",
"NotifyKey": "",
"NotifyMode": "Finish",
"NotifyType": "URL",
"NotifyUrl": "http://xxxx.com/v2/push/mps_test?token=73YcsZyP",
"QueueName": "",
"TopicName": ""
},
"TaskType": "BatchTask",
"TasksPriority": 0
}
}
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.InvalidMpsUser | Operation failed: unauthorized MPS user. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| ResourceNotFound | The resource does not exist. |
| 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