1. API Description

Domain name for API request:

Stop a Pull stream Relay task.

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: StopStreamIngest.
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.
SdkAppIdYesIntegerThe SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the task's room.
TaskIdYesStringThe unique Task ID, which will be returned after the task is successfully started.

3. Output Parameters

Parameter NameTypeDescription
RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 停止输入在线媒体流


Input Example

Content-Type: application/json
X-TC-Action: StopStreamIngest
<common request parameters>

    "SdkAppId": 1234567890,
    "TaskId": "1234"

Output Example

    "Response": {
        "RequestId": "71993312-6ab8-4768-9124-118e0a20c45f"

5. Developer Resources


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.TaskFinishedTask has ended when calling the interface.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.TaskIdTaskId parameter error.