NERoom 提供服务端接口来关闭房间，以便与您的业务系统对接，使管理员更加方便地管理和控制房间。此外，通过此功能，您还可以更好地管理应用程序，提高其安全性和稳定性。

调用该接口关闭已经结束的房间，将会直接返回成功。

功能描述

通过服务端关闭房间的应用场景包括：

• 管理视频直播：在直播过程中，主播可能需要紧急停止直播，或者管理员需要对直播进行审核和管理。此时，通过服务端接口关闭房间可以直接停止直播，保证直播内容的安全性和合法性。

• 多人音视频会议：在多人音视频会议中，可能会出现某个参会人员失去联系、滥用会议资源等问题，此时通过服务端接口关闭房间可以及时终止会议，保证会议的正常进行。

请求

URI

DELETE https://{endpoint}/neroom/v3/rooms/:room_archive_id

{endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。

Header

请求 Header 的设置请参见 请求结构。

路径参数

参数名称	类型	是否必选	示例	描述
room_archive_id	String	是	4***251	创建房间时，NERoom 服务端自动生成的一个用于标识房间的 ID，全局唯一，最大长度36个字符。 获取方法请参见创建房间 中的返回参数。

请求示例

javacurl --request DELETE 'https://roomkit.netease.im/neroom/v3/rooms/133456' \
--header 'AppKey: xxx' \
--header 'Nonce: xxx' \
--header 'CurTime: 1677050511' \
--header 'CheckSum: xxx' \
--header 'Content-Type: application/json' 

响应

响应参数

参数名称	类型	示例	描述
code	Integer	0	状态码，0表示成功，具体请参见错误码。
msg	String	Success	业务结果描述，Success表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
cost	String	48ms	处理该请求所消耗的时间。

响应体示例

java{
    "code":0,
    "msg":"Success",
    "ts":1619068087795,
    "request_id":"6e507107d1f4447ea731f651dc6d2432",
    "cost":"66ms"
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
400	Invalid parameter.	参数错误	检查接口传参
1004	Room not found.	房间不存在或者已关闭	根据业务场景处理

相关接口

接口	描述
创建房间	创建房间