查询云端录制配置
更新时间： 2025/09/17 09:14:53
查询指定录制任务信息，或查询所有进行中的录制任务信息。
请求信息
请求频率
默认上限为 50 次/秒，若请求频率超出限制，可能会返回 429 错误码。若您需要上调上限，请参考 如何处理调用服务端 RESTful API 超出频率限制。
请求 URL
- 请求方法：POST
- 请求 URL：网易云信为该功能提供以下两个 API 请求地址，使用 V3 地址需在 URL 中指定 cname，您可以根据业务需求调用任一接口。
https://rtc.yunxinapi.com/v2/api/cloudrecord/taskshttps://rtc.yunxinapi.com/v3/api/cloudrecord/tasks?cname={cname}
请求路径参数
URL 中参数说明：
| 参数名称 | 类型 | 示例 | 说明 |
|---|---|---|---|
| cname | String | abc | 房间名称。仅在调用 V3 接口时需要设置。 |
请求头参数
请求中 Header 的设置请参考 请求结构 描述。
请求体参数
请求中 Body 须为 JSON 格式，参数说明如下：
| 参数名称 | 类型 | 是否必选 | 示例 | 描述 |
|---|---|---|---|---|
| cid | Number | 必选，仅适用于 V2 接口 | 6207760637435905 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。 |
| taskId | String | 否 | - | 任务唯一标识符，房间内唯一。调用 创建云端录制任务 接口后，可在返回的 body 中获取 taskId。若不指定 taskId 或指定为空，表示查询所有进行中的任务，即房间内唯一的录制任务。 |
请求体示例
JSON{
"cid": 1144350751977184
}
如果使用 v3 接口，不指定 taskId，body 内容可为空或 {}。
响应信息
响应体参数
| 参数名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| code | Number | 200 | 响应状态码。 |
| - record | Object | - | 包含录制信息的对象。 |
| cid | Number | 1349219908472787 | 房间 ID。 |
| - record | Array | - | 录制任务列表。 |
| taskId | String | "5abd9fa70548478e82c9d40840eae05e4074" | 任务唯一标识符，房间内唯一。 |
|
Number |
1 |
当前云端录制服务状态。 |
| recordConfig | recordConfig | - | 录制配置。 |
| streamSubscribe | streamSubscribe | - | 录制订阅配置。 |
| detect | detect | - | 内容安全审核配置。 |
| layoutConfig | layoutConfig | - | 录制布局配置。 |
| watermark | watermark | - | 水印配置。 |
响应体示例
JSON{
"code": 200,
"record": {
"cid": 1349219908472787,
"record": [
{
"taskId": "5abd9fa70548478e82c9d40840eae05e4074",
"recordConfig": {
"recordtype": 2
},
"layoutConfig": {
"layoutType": 0
},
"state": 1
}
]
}
}
状态码
响应内容中，code 为 200 表示调用正常，若 code 为其他值，请根据 code 与 errmsg 在 云端录制相关错误码 中查看问题原因与解决方法。
此文档是否对你有帮助？
