CreateLivePadTemplate

Download PDF

Last updated: 2025-10-30 21:48:19

CreateLivePadTemplate

Last updated: 2025-10-30 21:48:19

Download PDF

1. API Description

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

create a live pad 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: CreateLivePadTemplate.
Version	Yes	String	Common Params. The value used for this API: 2018-08-01.
Region	No	String	Common Params. This parameter is not required for this API.
TemplateName	Yes	String	Template name. Maximum length: 255 bytes. Only Chinese, English, numbers, _, and - are supported.
Url	Yes	String	Gasket content.
Description	No	String	Description information. Maximum length: 1024 bytes. Only Chinese, English, numbers, _, and - are supported.
WaitDuration	No	Integer	The waiting time for disconnection. Value range: 0-30000. Unit: ms.
MaxDuration	No	Integer	Maximum shim duration. Value range: 0 - positive infinity. Unit: ms.
Type	No	Integer	Shim content type: 1: image, 2: video. Default value: 1.

3. Output Parameters

Parameter Name	Type	Description
TemplateId	Integer	Template Id.
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 create a live pad template

Input Example

{
    "Url": "http://domain.com/app/name", 
    "WaitDuration": 1, 
    "Description": "pad", 
    "MaxDuration": 1, 
    "TemplateName": "name"
}

Output Example

{
    "Response": {
        "TemplateId": 1000,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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
FailedOperation.CallOtherSvrFailed	Failed to call the internal service.
InternalError	Internal error.
InternalError.ArgsNotMatch	For the transcoding template adding API.
InternalError.ConfInUsed	The template is in use.
InternalError.ConfNotFound	The template does not exist.
InternalError.ConfOutLimit	The number of templates exceeded the limit.
InternalError.InvalidInput	Parameter check failed.
InternalError.NotFound	The record does not exist.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Parameter missing.
ResourceNotFound.ForbidService	You are blocked.
ResourceNotFound.FreezeService	Service suspended.
ResourceNotFound.StopService	The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService	You disabled the service.
UnsupportedOperation.NotLVBCodeMode	Not a LVB code/new console mode

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud