Domain name for API request: iss.intl.tencentcloudapi.com.
This API is used to obtain the download url of cloud recordings.
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: DescribeVideoDownloadUrl. |
| 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 | String | Download start time in UTC seconds. The longest period between the start and end times is 60 minutes and cannot span across days. Note: The actual downloaded file duration may be longer than this period. You can obtain the actual download start time and end time by specifying the IsRespActualTime parameter. This is because downloads are aligned by TS segments to ensure data integrity and include the entire specified period. |
| EndTime | Yes | String | Download end time in UTC seconds. The longest period between the start and end times is 60 minutes and cannot span across days. Note: The actual downloaded file duration may be longer than this period. You can obtain the actual download start time and end time by specifying the IsRespActualTime parameter. This is because downloads are aligned by TS segments to ensure data integrity and include the entire specified period. |
| FileType | Yes | String | File format. "mp4": MP4 format. "ts": TS file format. |
| IsRespActualTime | No | Boolean | data carries the actual download video recording start time and end time required or not |
| IsInternal | No | Boolean | Whether to return the private network download URL. Default false: the public network download URL is returned. If true, the private network download URL is returned. |
| Expires | No | Integer | Set the valid period of the URL. The minimum value is 1 second and the maximum value is 86400 seconds. If not set, the default is 600 seconds. |
| IsSupportG711 | No | Boolean | Whether the downloaded MP4 file supports G711 audio encoding. Note: If the audio encoding in cloud recording is AAC, then the downloaded MP4 supports AAC encoding by default. If the audio encoding in the cloud recording is G711 and IsSupportG711 is set to true, the downloaded MP4 supports G711 audio encoding. If the audio encoding in the cloud recording is G711 and IsSupportG711 is set to false, the downloaded MP4 does not support G711 audio encoding. This parameter is valid only when FileType is mp4. If left unset, it defaults to false. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | DescribeVideoDownloadUrlData | Returned data structure |
| 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: DescribeVideoDownloadUrl
<Common request parameters>
{
"ChannelId": "4dfb778c-xxxxxx",
"BeginTime": "1668996000",
"EndTime": "1668996600",
"FileType": "mp4",
"Expires": 600,
"IsSupportG711": true
}{
"Response": {
"Data": {
"Url": "https://userdomain/video.mp4?source=xxxxxx&expires=600&isSupportG711=1",
"ActualBeginTime": "1668996000",
"ActualEndTime": "1668996600"
},
"RequestId": "******************"
}
}Set the request parameter IsRespActualTime to true. If it is not specified or set to false, the actual time is not returned.
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVideoDownloadUrl
<Common request parameters>
{
"ChannelId": "4dfb778c-xxxxxxx",
"BeginTime": "1668996000",
"EndTime": "1668996600",
"FileType": "mp4",
"IsRespActualTime": true
}{
"Response": {
"Data": {
"Url": "https://userdomain/video.mp4?source=xxxxxx",
"ActualBeginTime": "1668996000",
"ActualEndTime": "1668996600"
},
"RequestId": "******************"
}
}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 |
| InvalidParameter.DownloadUrlError | Illegal download URL |
| InvalidParameter.DownloadUrlHasExpired | Download URL expired |
| InvalidParameterValue.InvalidBeginTime | Invalid start time |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.InvalidEndTime | Invalid end time |
| InvalidParameterValue.InvalidFileType | Invalid file format |
| InvalidParameterValue.NonSameDay | Time cannot span across days. |
| InvalidParameterValue.OutOfTimeRange | Time range exceeds the limit |
| OperationDenied.BandwidthLimitZero | Bandwidth limitation |
| OperationDenied.ConcurrentDownloadsOverLimit | Concurrent download limit exceeded |
| OperationDenied.ConnectsLimitZero | Number of connections limited |
| ResourceNotFound | Resource does not exist. |
| ResourceNotFound.VideoNotFound | Video recording not found. |
| ResourceUnavailable.VideoArchived | Video recording archived |
| UnsupportedOperation.UnopenedIntranetServicesInRegion | Intranet services are not enabled in this region. |
피드백