调用接口开始或关闭云端录制。通过服务端接口实现云端录制时，可以设置音视频通话全局的录制相关参数。例如设置录制模式为单流录制模式，对房间内所有成员生效。

使用云端录制功能之前，请参考云端录制概述，了解云端录制功能，并联系网易云信商务经理开通云端录制功能和网易云信点播服务。该功能涉及资源计费，请确认您已了解相关的计费规则。

• 此套服务端 RESTful API 接口仅适用于 V4.5.0 之前版本 SDK，且不再更新迭代。我们推荐您尽快切换至新版云端录制 API，以体验更为灵活的云端录制配置。具体请参考实现云端录制。
• 同一房间中，不可同时使用新旧两套云端录制 API。

注意：

• 使用云端录制功能之前，您可以在控制台中设置云端录制的画面布局。详细说明请参考录制布局。
• 调用服务端接口开始云端录制时，您需要设置房间内所有成员的录制模式，详细说明请参考录制模式。
• 如果需要同时录制音频和视频，请同时开启音频和视频录制开关。需要停止录制时，请同时关闭音频和视频录制开关。

URL

• 请求方法：POST

• URL：

  网易云信为该功能提供以下两个 API 请求地址，使用 V2 地址需在 URL 中指定 cid，使用 V3 地址需在 URL 中指定 cname，您可以根据业务需求调用任一接口。

  • https://logic-dev.netease.im/v2/api/record/{cid}
  • https://logic-dev.netease.im/v3/api/record?cname={cname}

URL 中参数说明：

参数名称	类型	示例	描述
cid	int64	6207760637435905	房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。
cname	String	abc	房间名称。仅在调用 V3 接口时需要设置。

请求参数

参数名称	类型	是否必选	示例	描述
cid	int64	可选	6207760637435905	房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
a_record	Boolean	必选	true	房间音频录制开关。开启后，该房间的所有音频信息均会被录制。可设置为： true：开启音频录制。 false：关闭音频录制。
v_record	Boolean	必选	true	房间视频录制开关。开启后，该房间的所有视频信息均会被录制。可设置为： true：开启视频录制。 false：关闭视频录制。
type	int	可选	0	录制模式。录制模式的详细说明请参考录制模式。 可设置为： 0：合流+单流录制。 1：合流录制。 2：单流录制。
uid	int64	可选	123	录制时，主讲人的用户 ID。仅在录制布局为主讲人模式时生效。录制布局的详细说明请参考录制布局。
enableSpamDetect	Boolean	可选	true	是否开启云端录制文件内容安全审核。 true：开启。 false：（默认）关闭。
scFrequency	Integer	可选	10	截图检测频率，取值范围为 1 ~ 60 秒。 默认5 秒截图检测一次。
detectTyp	Integer	可选	0	检测类型。 0：（默认）视频与音频同时检测。 1：仅检测视频。

返回参数

Body 中不返回任何参数。

示例

请求示例

{   
    "a_record": true,              
    "v_record": true,               
    "type" : 0,                       
    "uid" : 123                        
}

正常返回示例

该接口返回的消息中，Header 中的 code 为 200，表示请求成功。

错误码

• header 中的状态码：

  状态码列表请参考 header 中的 HTTP 状态码。

• body 中的错误码（code）

  该接口在 HTTP Body 中返回错误码（code），错误码列表请参考业务错误码。