文档中心
体验 App客户端 API服务端 API常见问题
中文
中文 English
文档中心
体验 App
客户端 API
服务端 API
常见问题
进入控制台
立即注册
登录控制台
中文站 English
服务端 API v2
    展开所有目录
    • API概览
    • 快速开始
    • 调用方式
    • 房间信令接口
    • 混流接口
    • 媒体服务接口
    • 媒体文件接口
    • 音视频流审核接口
    • 场景服务接口
    • 回调说明
    • 全局返回码
    • 使用 Postman 调试

    关闭房间

    更新时间：2023-01-04 18:53

    1 描述

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

    服务端调用此接口后，会收到 退出房间回调，了解用户退出房间的情况，如需接受此回调，请参考 回调配置说明 进行相关配置。

    服务端调用此接口后，原房间内的流的状态为关闭，服务端会收到 流关闭回调，知悉有关房间内流关闭的信息，如需接受此回调，请参考 回调配置说明 进行相关配置。

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

    ZegoExpress SDK LiveRoom SDK
    iOS/macOS onRoomStateChanged onKickout
    Android onRoomStateChanged onKickout
    Windows onRoomStateChanged OnKickOut
    Web roomStateChanged onKickout

    2 接口原型

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

    3 请求参数

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

    参数 类型 是否必选 描述
    RoomId
    String
    是
    房间 ID。

    4 请求示例

    https://rtc-api.zego.im/?Action=CloseRoom
&RoomId=123
&<公共请求参数>

    5 响应参数

    参数 类型 描述
    Code
    Number
    返回码。
    Message
    String
    操作结果描述。
    RequestId
    String
    请求 ID。

    6 响应示例

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

    7 返回码

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

    返回码 说明 处理建议
    5018 房间状态不一致。 请稍后重试。
    5024 房间不存在，与 104、50001 内部判断逻辑相同。 请确认请求房间 RoomId 是否存在。