- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
- Related Agreement
- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
- Related Agreement
1. API Description
Domain name for API request: mdl.intl.tencentcloudapi.com.
Query the highlight result information corresponding to the media live broadcast channel.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeMediaLiveHighlightResult. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-26. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Id | Yes | String | Media live broadcast channel ID. |
| StartTime | No | Integer | Query start time, unix timestamp, query data within the last 6 hours by default, and the maximum query range supports the last 7 days. |
| EndTime | No | Integer | Query end time, Unix timestamp, query data within the last 6 hours by default, and the maximum query range supports the last 7 days. |
| PageNum | No | Integer | Paging query page number. |
| PageSize | No | Integer | Paging query the size of each page. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Info | Array of HighlightResInfoResp | Highlight results information. |
| Id | String | Collection id. |
| ChannelId | String | Media live broadcast channel id. |
| PageNum | Integer | Number of pages. |
| PageSize | Integer | Paging Size. |
| TotalNum | Integer | The total number of eligible entries in the background. |
| 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. |
4. Example
Example1 Sample request
查询媒体直播频道信息。
Input Example
POST / HTTP/1.1
Host: mdl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMediaLiveHighlightResult
<Common request parameters>
{
"Id": "abc",
"StartTime": 1,
"EndTime": 1,
"PageNum": 1,
"PageSize": 1
}
Output Example
{
"Response": {
"Info": [
{
"TaskId": "abc",
"SegmentUrl": "abc",
"CovImgUrl": "abc",
"CreateTime": 1,
"StartTime": 0,
"EndTime": 0,
"Duration": 0
}
],
"Id": "abc",
"ChannelId": "abc",
"PageNum": 1,
"PageSize": 1,
"TotalNum": 1,
"RequestId": "abc"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.Id | Invalid Id. |
| InvalidParameter.NotFound | Not found. |
Yes
No
Was this page helpful?