提交工单
咨询集成、功能及报价等问题
调用本接口将把房间内所有用户从房间移出,并关闭房间。
服务端调用此接口后,会收到 退出房间回调,了解用户退出房间的情况,如需接受此回调,请参考 回调配置说明 进行相关配置。
服务端调用此接口后,原房间内的流的状态为关闭,服务端会收到 流关闭回调,知悉有关房间内流关闭的信息,如需接受此回调,请参考 回调配置说明 进行相关配置。
房间关闭后,客户端用户会被踢出房间,会收到 ZEGO SDK 回调接口:
ZegoExpress SDK | LiveRoom SDK | |
---|---|---|
iOS/macOS | onRoomStateChanged | onKickout |
Android | onRoomStateChanged | onKickout |
Windows | onRoomStateChanged | OnKickOut |
Web | roomStateChanged | onKickout |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
RoomId |
String |
是 |
房间 ID。 |
https://rtc-api.zego.im/?Action=CloseRoom
&RoomId=123
&<公共请求参数>
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 |
Message |
String |
操作结果描述。 |
RequestId |
String |
请求 ID。 |
{
"Code": 0,
"Message": "success",
"RequestId": "TestRequestId1642755866616219000"
}
以下仅列出了常见的接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
5018 | 房间状态不一致。 | 请稍后重试。 |
5024 | 房间不存在,与 104、50001 内部判断逻辑相同。 | 请确认请求房间 RoomId 是否存在。 |
联系我们
文档反馈