Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to create a local recording download 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: CreateVideoDownloadTask. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ChannelId | Yes | String | Channel ID |
| BeginTime | Yes | Integer | Start time. |
| EndTime | Yes | Integer | End time. |
| Scale | No | Integer | Default: 1x. Supports 1x, 2x, 4x, and 8x playback speeds. |
| Expire | No | Integer | Expiration time of the transcoded mp4 file (7, 15, 30, 60, 90, 180, and 365 are supported) |
| FileType | No | Integer | Download file format. Currently only supports (1: mp4) |
| CompletionPolicy | No | Integer | Completion policy (0: The task fails and no MP4 is generated if the stream pull fails but the video recording is incomplete. 1: The task succeeds and an MP4 is generated if the stream pull fails but the video recording is incomplete.) |
| Parameter Name | Type | Description |
|---|---|---|
| Data | VideoDownloadTaskData | Returned results of the download task |
| 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: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoDownloadTask
<Common request parameters>
{
"ChannelId": "***********",
"BeginTime": 1729288800,
"EndTime": 1729292400,
"Scale": 1,
"Expire": 7,
"FileType": 1
}
{
"Response": {
"Data": {
"DownloadTaskId": "**********"
},
"RequestId": "cd92416f-bc75-4d17-91f3-93d7c94d1cf5"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
피드백