实时音视频
服务端 API
当前页

CloseRoom

GET

https://rtc-api.zego.im/

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

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

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

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

ZegoExpress SDKLiveRoom SDK
iOS/macOSonRoomStateChangedonKickout
AndroidonRoomStateChangedonKickout
WindowsonRoomStateChangedOnKickOut
WebroomStateChangedonKickout
调用频率限制
同一个 AppID 下所有房间:1 次/秒(测试环境:1 次/秒)

Request

Query Parameters

    Action string必填

    可选值: [CloseRoom]

    接口原型参数

    https://rtc-api.zego.im?Action=CloseRoom

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    RoomId string必填

    房间 ID。

    CustomReason string

    关闭原因,最大长度为 256 字节。 使用时,需对其内容执行 URL 编码(UrlEncode)处理。

    RoomCloseCallback boolean

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

    📌 注意

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

Responses​

操作成功
Schema
    Code int32

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

    返回码说明处理建议
    5018房间已销毁或不存在。请确认请求房间 RoomId 是否存在。
    5024房间不存在,与 104、50001 内部判断逻辑相同。请确认请求房间 RoomId 是否存在。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

上一篇

获取简易流列表

下一篇

踢出房间用户

当前页

返回到顶部