StartLivePadStream

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

StartLivePadStream

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

1. API Description

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

Call this API to switch the live broadcast to standby footage.

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: StartLivePadStream.
Version	Yes	String	Common Params. The value used for this API: 2018-08-01.
Region	No	String	Common Params. This parameter is not required.
AppName	Yes	String	Ensure the streaming path uses the same AppName as the push/play URLs (default: 'live').
PushDomainName	Yes	String	Your RTMP push domain.
StreamName	Yes	String	Your stream name.
Operator	No	String	Operator notes.

3. Output Parameters

Parameter Name	Type	Description
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 Request Example

Input Example

POST / HTTP/1.1
Host:live.intl.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: StartLivePadStream
<Common Request Parameters>

{
    "PushDomainName": "5000.livepush.com",
    "AppName": "live",
    "StreamName": "stream1"
}

Output Example

{
    "Response": {
        "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e"
    }
}

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	Operation failed.
FailedOperation.CallOtherSvrFailed	Failed to call the internal service.
InternalError	Internal error.
InternalError.CallOtherSvrError	Error calling internal service.
InternalError.ConfigNotExist	The configuration does not exist.
InternalError.GetBizidError	Error getting user account.
InternalError.GetStreamInfoError	Failed to get the stream information.
InternalError.GetUpstreamInfoError	Error getting the live stream source information.
InternalError.NotPermmitOperat	No permission to operate.
InternalError.StreamStatusError	Exceptional stream status.
InternalError.UpdateDataError	Failed to update data.
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.
ResourceNotFound.UserNotExist	The CSS service has not been activated.

Was this page helpful?

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

Yes

Feedback

tencent cloud