停止录制任务
更新时间: 2024/03/25 11:00:41
调用此接口停止某个已创建的云端录制任务。
当房间最后一个成员离开、房间被删除时,NERTC 服务端会自动结束云端录制。
URL
- 请求方法:POST
- URL:网易云信为该功能提供以下两个 API 请求地址,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。
https://logic-dev.netease.im/v2/api/cloudrecord/stop
https://logic-dev.netease.im/v3/api/cloudrecord/stop?cname={cname}
URL中参数说明:
类型 | 示例 | 描述 |
|
---|---|---|---|
cname | String | abc | 房间名称。仅在调用 V3 接口时需要设置。 |
接口请求频率
默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
请求中 Body 须为 JSON 格式,参数说明如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
cid | Number | 必选,仅适用于 V2 接口 | 6207760637435905 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。 |
taskId | String | 必选 | - | 任务唯一标识符,房间内唯一。 调用添加录制任务接口后,可在返回 body 中获取 taskId。 |
返回参数
云端录制相关接口返回参数中,业务相关参数封装在 record 参数中,其中包括:
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
taskId | String | 1143932537695968 | 任务唯一标识符,房间内唯一。 |
cid | Number | 123456 | 房间 ID。 |
示例
请求示例
{
"taskId": "23d73e2ae2c74135a732c8d24739b71d8723",
"cid": 114***7184
}
返回实例
{
"code": 200,
"record": {
"taskId": "23d73e2ae2c74135a732c8d24739b71d8723",
"cid": 1144***7184,
"state": 2
}
}
状态码
返回内容中,code 为 200 表示调用正常,若 code 为其他值,请根据 code 与 errmsg 在云端录制相关错误码中查看问题原因与解决方法。
此文档是否对你有帮助?