销毁房间
描述
调用此接口,开发者可销毁房间。
调用频率限制:20 次/秒
客户端将通过 ZIM SDK 的回调接口,接收房间被销毁的消息通知。
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
roomStateChanged | onRoomStateChanged | roomStateChanged | onRoomStateChanged | roomStateChanged |
小程序 | Flutter | Unity3D | uni-app | React Native |
roomStateChanged | onRoomStateChanged | OnRoomStateChanged | roomStateChanged | roomStateChanged |
接口原型
- 请求方法:GET
- 请求地址:
https://zim-api.zego.im/?Action=DestroyRoom
- 传输协议:HTTPS
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
RoomId | String | 是 | 房间 ID。 |
说明
RoomId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。
请求示例
Untitled
https://zim-api.zego.im/?Action=DestroyRoom
&RoomId=123
&<公共请求参数>
1
响应参数
参数 | 类型 | 描述 |
---|---|---|
Code | Number | 返回码。 |
Message | String | 请求结果的说明信息。 |
RequestId | String | 请求 ID。 |
响应示例
Untitled
{
"Code":0,
"Message":"success",
"RequestId":"343649807833778782"
}
1
返回码
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 |
---|---|
660300001 | 房间不存在。 |