CreateLiveRecordTemplate

Last updated: 2025-12-02 14:27:06Download PDF

1. API Description

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

This API is used to create 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 Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: CreateLiveRecordTemplate.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
HLSConfigure	No	HLSConfigureInfo	HLS configuration parameter. Either this parameter or MP4Configure should be specified.
MP4Configure	No	MP4ConfigureInfo	MP4 configuration parameter. Either this parameter or HLSConfigure should be specified.
Name	No	String	Recording template name. Length limit: 64 characters.
Comment	No	String	Template description, with a length limit of 256 characters.
RecordType	No	String	Recording type. Valid values: - video: audio and video recording; - audio: audio recording; - auto: automatic detection; If it is left blank, "video" will be used as the default value.

3. Output Parameters

Parameter Name	Type	Description
Definition	Integer	Unique identifier of the recording template.
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 Creating a Live Recording Template

This example shows you how to create a live recording template.

Input Example

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

{
    "HLSConfigure": {
        "ItemDuration": 10,
        "Interval": 3600
    },
    "Name": "Template 1",
    "Comment": "Template description"
}

Output Example

{
    "Response": {
        "Definition": 20001,
        "RequestId": "12ae8cxc-dce3-4151-9cyt-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

Tencent Cloud CLI 3.0

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
InternalError.AccessDBError	Data error.
InternalError.GenDefinition	Internal error: failed to generate template ID.
InvalidParameterValue	Incorrect parameter value.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.