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 stringrequired
Possible values: [CloseRoom]
接口原型参数
https://rtc-api.zego.im?Action=CloseRoom
AppId uint32required
💡公共参数。AppId，ZEGO 分配的用户唯一凭证。
SignatureNonce stringrequired
💡公共参数。随机字符串。
Timestamp int64required
💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。
Signature stringrequired
💡公共参数。签名，用于验证请求的合法性。
SignatureVersion stringrequired
Possible values: [2.0]
Default value: 2.0
💡公共参数。签名版本号。
IsTest string
Possible values: [true, false]
Default value: false
💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。
RoomId stringrequired
房间 ID。
CustomReason string
关闭原因，最大长度为 256 字节。 使用时，需对其内容执行 URL 编码（UrlEncode）处理。
Responses
- 200
操作成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSEClear
Click the "Send" button above and see the response here!