Domain name for API request: tiw.tencentcloudapi.com.
This API is used to query the status and result of a recording video generation task.
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: DescribeVideoGenerationTask. |
Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
SdkAppId | Yes | Integer | SdkAppId of the whiteboard application. |
TaskId | Yes | String | ID of the recording video generation task. |
Parameter Name | Type | Description |
---|---|---|
GroupId | String | Group ID corresponding to the task. |
RoomId | Integer | Room ID corresponding to the task. |
TaskId | String | Task ID. |
Progress | Integer | Disused. |
Status | String | Status of the recording video generation task. Valid values: - QUEUED: Queuing. - PROCESSING: Video generation in progress. - FINISHED: Video generation finished. (To determine whether the task succeeded or failed, check the error code and message.) |
TotalTime | Integer | Total video playback duration. Unit: milliseconds. |
VideoInfos | VideoInfo | Disused. Use the VideoInfoList parameter. |
VideoInfoList | Array of VideoInfo | List of videos generated by the recording video generation tasks. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://tiw.tencentcloudapi.com/?Action=DescribeVideoGenerationTask
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<Common request parameters>
{
"Response": {
"GroupId": "900822",
"Progress": 100,
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"RoomId": 900822,
"Status": "FINISHED",
"TaskId": "00e1jv8ve0jcqk7da9lb",
"TotalTime": 156750,
"VideoInfoList": [
{
"UserId": "",
"VideoDuration": 156750,
"VideoFormat": "mp4",
"VideoId": "5285890792776509100",
"VideoPlayTime": 0,
"VideoSize": 318384,
"VideoType": 2,
"Width": 1024,
"Height": 768,
"VideoUrl": "http://1257240443.vod2.myqcloud.com/cc35b442vodcq1257240443/video.mp4"
}
],
"VideoInfos": {
"VideoType": 0,
"VideoUrl": "Disused. Use the VideoInfoList parameter.",
"UserId": "xx",
"VideoId": "xx",
"VideoSize": 0,
"VideoDuration": 0,
"Width": 0,
"Height": 0,
"VideoPlayTime": 0,
"VideoFormat": "xx"
}
}
}
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 |
---|---|
AuthFailure | |
FailedOperation.Record | Failed to record. For more information, see the error description. |
InvalidParameter.BodyParameterTypeUnmatched | The parameter type does not match. |
InvalidParameter.TaskNotFound | The task to query does not exist. |
ResourceUnavailable.NotRegistered | TIW is not enabled. |
ResourceUnavailable.ServiceExpired | The account is in arrears or the TIW service has expired. |
UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
本页内容是否解决了您的问题?