You need to enable JavaScript to run this app.
导航

解散房间 DismissRoom

最近更新时间2024.01.12 16:39:45

首次发布时间2023.04.12 12:01:32

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

在你的音视频应用中,你可能会需要将房间中所有用户都移出房间。
你可以使用 DismissRoom 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以调用 DismissRoom 接口,指定你所属的 AppId,将指定 roomId 房间解散。
房间解散后,房间内所有用户会收到 -1011 错误通知。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:QPS 不得超过 60

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志
RoomIdStringYour_RoomId房间的 ID,是房间的唯一标志

返回参数

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

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

请求示例

POST https://rtc.volcengineapi.com?Action=DismissRoom&Version=2020-12-01
{
    "AppId" : "Your_AppId",
    "RoomId" : "Your_RoomId"
}

返回示例

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

错误码

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