关闭房间

描述

调用本接口将把房间内所有用户从房间移出，并关闭房间。

如果开发者已参考 回调配置说明，配置了 退出房间回调、流关闭回调，服务端调用本接口时：

• 服务端会收到 退出房间回调 通知，开发者可以了解用户退出房间的情况。
• 原房间内的流的状态为关闭，服务端会收到 流关闭回调，开发者可以知悉有关房间内流关闭的信息。

房间关闭后，客户端用户会被踢出房间，会收到 ZEGO SDK 回调接口：

接口原型

• 请求方法：GET
• 请求地址：https://rtc-api.zego.im/?Action=CloseRoom
• 传输协议：HTTPS
• 调用频率限制（同一个 AppID 下所有房间）：1 次/秒（测试环境：1 次/秒）

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 完整公共参数列表请参考 调用方式 中的 “公共请求参数”。

请求示例

https://rtc-api.zego.im/?Action=CloseRoom
&RoomId=room1
&CustomReason=clear
&RoomCloseCallback=false
&<公共请求参数>

https://rtc-api.zego.im/?Action=CloseRoom
&RoomId=room1
&CustomReason=clear
&RoomCloseCallback=false
&<公共请求参数>

响应参数

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId1642755866616219000"
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId1642755866616219000"
}

返回码

以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考 全局返回码。