查询指定录制任务信息，或查询所有进行中的录制任务信息。

请求信息

• 请求方法：POST
• URL：网易云信为该功能提供以下两个 API 请求地址，使用 V3 地址需在 URL 中指定 cname，您可以根据业务需求调用任一接口。
  • https://logic-dev.netease.im/v2/api/cloudrecord/tasks
  • https://logic-dev.netease.im/v3/api/cloudrecord/tasks?cname={cname}

请求 URL

URL 中参数说明：

参数名称	类型	示例	说明
cname	String	abc	房间名称。仅在调用 V3 接口时需要设置。

请求频率

默认上限为 50 次/秒，若请求频率超出限制，可能会返回 429 错误码。
若您需要上调上限，请参考 如何处理调用服务端 RESTful API 超出频率限制。

请求头参数

请求中 Header 的设置请参考 请求结构 描述。

请求体参数

请求中 Body 须为 JSON 格式，参数说明如下：

参数名称	类型	是否必选	示例	描述
cid	Number	必选，仅适用于 V2 接口	6207760637435905	房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。
taskId	String	否	-	任务唯一标识符，房间内唯一。调用 创建云端录制任务 接口后，可在返回的 body 中获取 taskId。若不指定 taskId 或指定为空，表示查询所有进行中的任务，即房间内唯一的录制任务。

请求体示例

JSON{
    "cid": 1144350751977184
}

如果使用 v3 接口，不指定 taskId，body 内容可为空或 {}。

响应信息

响应参数

参数名称	类型	示例	描述
cid	Number	123456	房间 ID。
taskId	String	1143932537695968	任务唯一标识符，房间内唯一。
state	Number	0	当前云端录制服务状态。 0：初始状态。此时房间中没有任何成员或房间成员没有发流，此时录制尚未开始。 1：运行中。此时云端录制服务正在运行中。 2：已停止。此时云端录制已完成。
recordConfig	recordConfig	-	录制配置。
streamSubscribe	streamSubscribe	-	录制订阅配置。
detect	detect	-	内容安全审核配置。
layoutConfig	layoutConfig	-	录制布局配置。
watermark	watermark	-	水印配置。

响应体示例

JSON{
    "code": 200,
    "record": {
        "cid": 1144***184,
        "record": [
            {
                "taskId": "23d73e2ae2c74135a732c8d24739b71d8723",
            }],
        "recordConfig": [
            {
            "recordType": 100,
            "modeList": [
                {
                    "mode": 0,
                    "layoutType": 2,
                    "layout":
                        {
                        "canvas": {
                            "width": 720,
                            "height": 480
                        },
                        "subStreams": [
                            {
                                "adaption": 0,
                                "x": 0,
                                "width": 720,
                                "y": 0,
                                "zOrder": 1,
                                "height": 384
                            }
                        ],
                        "users": [
                            {
                                "adaption": 1,
                                "x": 270,
                                "width": 144,
                                "zOrder": 2,
                                "y": 384,
                                "height": 96
                            }
                        ]
                    }
                }
            ]
        }]
                "streamSubscribe": {
                    "audioUidList": {
                        "subscribeUids": [
                            4455,
                            5566
                        ]
                    },
                    "streamType": 2,
                    "videoUidList": {
                        "subscribeUids": [
                            4455,
                            5566
                        ]
                    }
                },
                "detect": {
                    "detectType": 1,
                    "enableSpamDetect": true,
                    "scFrequency": 1
                },
                "layoutConfig": {
                    "hostUid": 66602,
                    "layoutType": 3
                },
                "watermark":{
                    "literaWms":[
                            {
                                "wmLitera": "水印测试",
                                "fontSize":50,
                                "fontColor":"#RRGGBB",
                                "offsetX":0,
                                "offsetY":0
                            }
                        ],
                    "transparentLayers":[
                        {
                            "offsetX":0,
                            "offsetY":0,
                            "wmWidth":480,
                            "wmHeight":100,
                            "bgTransparency":3
                        }
                    ],
                    "imgWms":[
                        {
                            "url":"https://freepngimg.com/XXX/XXX/example.png",
                            "offsetX":120,
                            "offsetY":120,
                            "wmWidth":100,
                            "wmHeight":100
                        }
                    ],
                    "timestampWm":{
                        "fontSize":50,
                        "fontColor":"#RRGGBB",
                        "offsetX":0,
                        "offsetY":50
                    }
                }
                    "state": 1
            }
        ]
    }
}

状态码

响应内容中，code 为 200 表示调用正常，若 code 为其他值，请根据 code 与 errmsg 在 云端录制相关错误码 中查看问题原因与解决方法。