实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考输入在线媒体流停止在线媒体流输入 StopRelayStream
复制全文
下载 pdf停止在线媒体流输入 StopRelayStream
文档反馈
问问助手调用 StopRelayStream 接口，停止一个正在向 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 必选 示例值：66****cf
RTC 或 WTN 应用 ID。与 StartRelayStream 发起推送时设置的保持一致。
- RTC 应用 ID：在 RTC 控制台获取。
- WTN 应用 ID：在 WTN 控制台获取。
RoomId String 可选 示例值：Room1
任务所在的房间 ID。
注意
停止将流推送至 RTC 房间时必填。
TaskId String 可选 示例值：Task1
需要停止的任务 ID，需与 StartRelayStream 时设置的 TaskId 一致。
注意
停止将流推送至 RTC 房间时必填。
WtnStreamId String 可选 示例值：wtn01
WTN 流 ID，在 StartRelayStream 发起推送时设置的。
注意
停止将流推送至 WTN 时必填。
返回参数
其中返回值 Result 仅在请求成功时返回 ok，失败时为空。
请求示例
POST https://rtc.volcengineapi.com?Action=StopRelayStream&Version=2023-11-01
{
"AppId" : "661e7ae5543cf",
"RoomId" : "Room1",
"TaskId" : "Task1"
}
返回示例
{
"Result": "ok",
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "StopRelayStream",
"Version": " 2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
}
}
错误码
最近更新时间：2026.03.13 10:26:40
这个页面对您有帮助吗？
有用
有用
无用
无用