结束白板录制任务 StopWBRecord--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

结束白板录制任务 StopWBRecord

最近更新时间：2024.03.26 16:19:49首次发布时间：2024.03.26 15:20:25

发起白板录制任务后，可以调用 StopWBRecord 结束录制任务。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间 ID。在同一个 appId 中，该参数为每个房间的唯一标志。
UserId	String	是	`Your_UserId`	调用接口的用户 ID
TaskId	String	是	`Your_TaskId`	录制任务 ID。调用 StartWBRecord 时使用的任务 ID。

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopWBRecord&Version=2023-11-01
{
    "AppId" : "600000000000000000000000",
    "RoomId" : "RoomId1",   
    "UserId" : "UserId1",
    "TaskId" : "TaskId1"
}

返回示例

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

错误码

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