文档中心

实时音视频

请输入

云录屏

结束云录屏 StopWebCast

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

调用 StopWebcast 接口，结束一个正在进行的云录屏任务。

注意事项

请求频率：QPS 不得超过 150。

请求说明

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Query

Action String 必选示例值：StopWebcast

接口名称。当前 API 的名称为 StopWebcast。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

RoomId String 必选示例值：Room1

房间 ID。

TaskId String 必选示例值：Task1

目标任务 ID。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。

其中返回值 Result 仅在请求成功时返回 ok，失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=StopWebcast&Version=2023-11-01​
{​
    "AppId": "66****3cf",​
    "RoomId": "Room1",​
    "TaskId": "Task1"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420",​
        "Action": "StopWebcast",​
        "Version": "2023-11-01",​
        "Service": "rtc",​
        "Region": "cn-north-1"​
    },​
    "Result": "ok"​
}​

错误码

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

最近更新时间：2026.03.13 10:26:41

这个页面对您有帮助吗？

有用

无用