文档中心
ExpressAudioSDK 实时语音
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 实时语音
  • 服务端 API
  • 房间信令接口
  • 关闭房间

服务端 API 版块于4月16日至5月15日升级维护,期间暂停信息更新,如有任何疑问,请联系ZEGO技术支持。

关闭房间

更新时间:2025-04-15 17:17

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 请求参数

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

参数 类型 是否必选 描述
RoomId
String
是
房间 ID。
CustomReason
String
否
关闭原因,最大长度为 256 字节。

使用时,请对该参数内容进行 UrlEncode。

RoomCloseCallback
Boolean
否
是否产生 房间关闭回调,默认为 false。

由于通常是开发者主动发起的关闭行为,故不再另行通过 房间关闭回调 通知开发者。如果您需要通过 房间关闭回调 进行统一的逻辑处理,可自行修改为 true。

该参数只影响是否产生 房间关闭回调,其他原因导致房间关闭的回调通知(例如 退出房间回调)不受影响。

4 请求示例

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

5 响应参数

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

6 响应示例

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

7 返回码

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

返回码 说明 处理建议
5018 房间已销毁或不存在。 请确认请求房间 RoomId 是否存在。
5024 房间不存在,与 104、50001 内部判断逻辑相同。 请确认请求房间 RoomId 是否存在。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈