Overview
Menu

DescribeLiveRecordTemplates

Last updated: 2025-02-19 14:56:01Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to get a live recording template.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeLiveRecordTemplates.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
Definitions.NNoArray of IntegerSpecifies the recording template unique identifier filter condition, with an array length limit of 100.
OffsetNoIntegerPaging offset. Default value: 0.
LimitNoIntegerNumber of returned entries. Default value: 10. Maximum value: 100.
TypeNoStringIndicates the template type filter condition. If left empty, all templates are returned. Valid values:
* Preset: System preset template;
* Custom
NameNoStringSpecifies the recording template identifier filter condition, with a length limit of 64 characters.

3. Output Parameters

Parameter NameTypeDescription
TotalCountIntegerTotal number of records that meet filter conditions.
LiveRecordTemplateSetArray of LiveRecordTemplateRecording template details list.
RequestIdStringThe 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 Getting a Live Streaming Recording Template

This example shows you how to get a live streaming recording template

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveRecordTemplates
<Common request parameters>

{
    "Definitions": [
        20001
    ]
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "LiveRecordTemplateSet": [
            {
                "Definition": 20001,
                "HLSConfigure": {
                    "ItemDuration": 10,
                    "Interval": 3600
                },
                "Name": "Template 1",
                "Comment": "",
                "Type": "Preset",
                "CreateTime": "2023-05-04T10:00:00Z",
                "UpdateTime": "2023-05-04T10:00:00Z"
            }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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 CodeDescription
InternalErrorInternal error.
InternalError.AccessDBErrorData error.
InvalidParameterValueIncorrect parameter value.
InvalidParameterValue.LimitParameter error: Limit.