解散房间 DismissRoom--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

解散房间 DismissRoom

最近更新时间：2024.07.16 15:31:21首次发布时间：2023.04.12 12:01:32

当前该接口依然可用，但是我们强烈建议你使用BanRoomUser解散房间。

在实时音视频通话场景中，如果你需要解散指定的房间，通过调用此接口实现。

通过指定应用标识和房间标识，你可以将指定房间解散，房间内所有用户会收到 -1011 错误通知。调用后，接口返回操作结果，确认房间是否成功解散。

注意事项

请求频率：QPS 不得超过 60。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=DismissRoom&Version=2020-12-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DismissRoom`	接口名称。当前 API 的名称为 `DismissRoom`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
RoomId	String	是	`Room1`	房间的 ID，是房间的唯一标志

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
message	String	`success`	仅在请求成功时返回消息 "success", 失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=DismissRoom&Version=2020-12-01
{
    "AppId" : "661e****543cf",
    "RoomId" : "Room1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "DismissRoom",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "message": "success"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。