你可以调用 StopWebRecord 接口,停止云录屏。

接口行为

你可以调用 StopWebRecord 接口,停止指定云录屏任务。

如果你已开通录制结束的消息通知功能,在云录屏结束后,你能够收到相关回调通知。关于消息通知服务,参看开通消息通知服务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 150。

请求方式

使用 POST 方式发起请求。

请求参数
Query
参数名类型必填示例值描述
ActionString是StopWebRecord接口名称,本接口取值:StopWebRecord
VersionString是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdstring是Your_AppId应用的唯一标志。
TaskIdstring是Your_TaskId任务 ID,是任务的唯一标志。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=StopWebRecord&Version=2020-12-01
postscript
Body
{
    "AppId" : "Your_AppId",
    "TaskId" : "Your_TaskId"
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"success",失败时为空。

正常返回示例
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopWebRecord",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result":{
        "Message": "success"
    }
}
json