当前该接口依然可用,但是我们强烈建议你使用BanRoomUser解散房间。
在你的音视频应用中,你可能会需要将房间中所有用户都移出房间。
你可以使用 DismissRoom 这个 OpenAPI 实现这一功能。
你可以调用 DismissRoom 接口,指定你所属的 AppId,将指定 roomId 房间解散。
房间解散后,房间内所有用户会收到 -1011 错误通知。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
请求频率:QPS 不得超过 60。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DismissRoom | 接口名称。当前 API 的名称为 DismissRoom。 |
| Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
| RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| message | String | success | 仅在请求成功时返回消息 "success", 失败时为空。 |
POST https://rtc.volcengineapi.com?Action=DismissRoom&Version=2020-12-01
{
"AppId" : "Your_AppId",
"RoomId" : "Your_RoomId"
}
json{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "DismissRoom",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result":{
"message": "success"
}
}
json您可访问公共错误码,获取更多错误码信息。