停止在线媒体流输入 StopRelayStream--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

停止在线媒体流输入 StopRelayStream

最近更新时间：2025.08.14 15:33:37首次发布时间：2024.01.03 20:25:16

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

停止一个正在向 RTC 房间或 WTN 网络推送的在线媒体流任务。

请求频率

QPS 不得超过 150。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=StopRelayStream&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`StopRelayStream`	接口名称。当前 API 的名称为 `StopRelayStream`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	RTC 或 WTN 应用 ID。根据推送的目标不同，获取方式不一样：推送至 RTC 房间：在 RTC 控制台获取，参看获取 AppId。推送至 WTN 网络：在 WTN 控制台获取。
RoomId	String	否	`Room1`	停止将流推送至 RTC 房间时必填。任务所在的房间 ID。
TaskId	String	否	`Task1`	停止将流推送至 RTC 房间时必填。需要停止的任务 ID，需与 StartRelayStream 时设置的 TaskId 一致。
WtnStreamId	String	否	`wtn_live_stream_01`	停止将流推送至 WTN 网络时必填。需要停止推送的 WTN 流的 ID，在 StartRelayStream 发起推送时设置的。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok，失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=StopRelayStream&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "TaskId": "Task1"
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "StopRelayStream",
        "Version": " 2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。