이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

StopStreamIngest

1. API Description

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

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 Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: StopStreamIngest.
Version	Yes	String	Common Params. The value used for this API: 2019-07-22.
Region	Yes	String	Common 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.
SdkAppId	Yes	Integer	The SDKAppId of TRTC, which is the same as the SDKAppId corresponding to the task's room.
TaskId	Yes	String	The unique Task ID, which will be returned after the task is successfully started.

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 Stopping Inputting an Online Media Stream

This example shows you how to stop task 1234 for SdkAppId 1234567890.

Input Example

POST / HTTP/1.1
Host: trtc.intl.tencentcloudapi.com
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

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.TaskFinished	Task has ended when calling the interface.
InvalidParameter.BodyParamsError	Failed to parse body parameters.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
InvalidParameter.TaskId	TaskId parameter error.