云端录制
  • 产品简介
    • 概述
    • 发布日志
    • 计费说明
  • 快速开始
    • 实现云端录制
  • 基础功能
  • 服务端 API v2
  • 常见问题
  • 文档中心
  • 云端录制
  • 服务端 API v2
  • 结束录制

结束录制

更新时间:2021-12-10 16:35

  1. 本 API 为最新服务端 API v2 接口,支持全球就近接入、统一的鉴权方式、统一的参数风格和公共错误码。后续相关功能的新增都会在此更新。
  2. 旧版 API 接口仅供 2021-09-10 前接入的旧用户维护使用。旧版接口文档请参考 旧版服务端 API

1 描述

调用本接口结束云端录制。

当开发者成功调用 StopRecord 接口后,云端录制服务会退出录制的房间并上传录制文件至设定的第三方云存储。

2 接口原型

  • 请求方法:POST
  • 请求地址:https://cloudrecord-api.zego.im/?Action=StopRecord
  • 传输协议:HTTPS
  • 调用频率限制:50 次/秒(测试环境:20 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数,公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
TaskId
String
录制任务 ID,长度固定为 16 个字节的字符串。

4 请求示例

以下是 StopRecord 接口的请求示例。

  • 请求 URL
    https://cloudrecord-api.zego.im/?Action=StopRecord
    &AppId=1234567890
    &SignatureNonce=15215528852396
    &Timestamp=1234567890
    &Signature=7a2c0f11145fb760d607a07b54825013
    &SignatureVersion=2.0
    &IsTest=false
  • 请求消息体
    {
      "TaskId": "XXXXXXXXXXX"
    }

5 响应参数

参数 类型 描述
Code
Int64
错误码。
Message
String
错误描述。
RequestId
String
请求 ID。

6 响应示例

以下是 StopRecord 接口的响应示例。

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}
本篇目录