CloseRoom
GET
https://rtc-api.zego.im/
调用本接口将把房间内所有用户从房间移出，并关闭房间。
如果开发者已参考 回调配置说明，配置了 退出房间回调、流关闭回调，服务端调用本接口时：
房间关闭后，客户端用户会被踢出房间，会收到 ZEGO SDK 回调接口：
| ZegoExpress SDK | LiveRoom SDK | |
|---|---|---|
| iOS/macOS | onRoomStateChanged | onKickout |
| Android | onRoomStateChanged | onKickout |
| Windows | onRoomStateChanged | OnKickOut |
| Web | roomStateChanged | onKickout |
调用频率限制
同一个 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）处理。
Responses
- 200
操作成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ZEGO 签名生成器
RESPONSE清除
点击上方 “发送” 按钮，在此处查看响应。