Menu

StartStreamIngest

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

Push an online media stream to the TRTC room.

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: StartStreamIngest.
VersionYesStringCommon Params. The value used for this API: 2019-07-22.
RegionYesStringCommon Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-jakarta, ap-mumbai, ap-singapore.
SdkAppIdYesIntegerTRTC's SdkAppId, the same as the SdkAppId corresponding to the Record room.
RoomIdYesStringTRTC's RoomId, the RoomId corresponding to the Record TRTC room.
RoomIdTypeYesIntegerType of TRTC RoomId. 【*Note】Must be the same as the RoomId type corresponding to the Record room: 0: String type RoomId 1: 32-bit Integer type RoomId (default)
UserIdYesStringUserId of the Pull stream Relay Robot, used to enter the room and initiate the Pull stream Relay Task.
UserSigYesStringUserSig corresponding to the Pull stream Relay Robot UserId, i.e., UserId and UserSig are equivalent to the Robot's Login password for entering the room. For the specific Calculation method, please refer to the TRTC UserSig Scheme.
SourceUrl.NYesArray of String
Source URL. Example value: https://a.b/test.mp4
PrivateMapKeyNoStringTRTC room permission Encryption ticket, only needed when advanced permission control is enabled in the Console. After enabling advanced permission control in the TRTC Console, TRTC's backend service system will verify a so-called [PrivateMapKey] 'Permission ticket', which contains an encrypted RoomId and an encrypted 'Permission bit list'. Since PrivateMapKey contains RoomId, providing only UserSig without PrivateMapKey does not allow entry into the specified room.
VideoEncodeParamsNoVideoEncodeParamsVideo Codec Parameters. Optional, if not filled, Keep original stream Parameters.
AudioEncodeParamsNoAudioEncodeParamsAudio Codec Parameters. Optional, if not filled, Keep original stream Parameters.

3. Output Parameters

Parameter NameTypeDescription
TaskIdStringThe Task ID of the Pull stream Relay. The Task ID is a unique identifier for a Pull stream Relay lifecycle process, and it loses its meaning when the task ends. The Task ID needs to be saved by the business as a parameter for the next operation on this task.
RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 启动输入在线媒体流

启动一个输入在线媒体流任务,将在线媒体流"https://a.b/test.mp4"输入TRTC房间,音视频编码采用默认编码值,转推成功后返回TaskId

Input Example

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartStreamIngest
<common request parameters>

{
    "SdkAppId": 1234567890,
    "RoomId": "room123",
    "UserId": "robot123",
    "UserSig": "xxxxxxxxxxxxxxx",
    "PrivateMapKey": "xxxxxxxxxxxxxxx",
    "RoomIdType": 1
}

Output Example

{
    "Response": {
        "TaskId": "-gCTFWtU7t7DUlo7A8IswFszO9z2O-rbERqJAoK-4pycoZXKjIAAnasdcasdOEycyX4CnzhIm4RAQ..",
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"
    }
}

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
FailedOperation.NotRtmpFunction
FailedOperation.RestrictedConcurrencyMaximum number of concurrent on-cloud recording tasks reached. Contact us to raise the limit.
FailedOperation.TaskExistTask already exists
InternalError.HttpParseFailedHTTP request parsing failed.
InternalError.InternalErrorInternal error, please retry.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.RoomIdRoomId is incorrect.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.StrRoomIdStrRoomId parameter error.
InvalidParameter.TaskIdTaskId parameter error.
InvalidParameter.UserSig
MissingParameter.RoomIdRoomId is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.TaskIdTaskId parameter missing.
ResourceInsufficient.RequestRejectionInsufficient resources.