云端录制旧版文档
  • 快速开始
  • 常用功能
  • API 文档
  • 常见错误码
  • 文档中心
  • 云端录制旧版文档
  • API 文档
  • 结束录制

结束录制

更新时间:2021-09-10 14:48

1 描述

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

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

2 接口原型

  • 请求方式:POST/JSON

  • 请求地址:

    服务环境 调用频率限制 请求地址
    国内正式环境
    50 次/秒
    https://cloudrecord-sh.zego.im/stop
    国内测试环境
    50 次/秒
    https://cloudrecord-test.zego.im/stop
    海外正式环境
    50 次/秒
    https://cloudrecord-hk.zegocloud.com/stop
    海外测试环境
    50 次/秒
    https://cloudrecord-test.zegocloud.com/stop
  • 传输协议:HTTPS

3 请求参数

参数 类型 是否必选 描述
app_id
Int64
ZEGO 给开发者分配的 AppID,唯一标识一个应用。
access_token
String
接口鉴权凭证,通过 获取 AccessToken 接口获取。
task_id
String
录制任务 ID,长度固定为 16 个字节的字符串。

4 请求示例

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

{
    "app_id": 0000,
    "access_token": "xxxx",
    "task_id": "XXXXXXXXXXX"
}

5 响应参数

参数 类型 描述
code
Int
错误码。
message
String
错误描述。

6 响应示例

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

{
    "code": 0,
    "message": "succeed"
}
本篇目录