# 封禁房间 (/zh-CN/api-reference/api-ref/whiteboard/restful/ban-room)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

封禁或取消封禁指定的房间。

- OpenAPI: /openapi/whiteboard/restful-wb.zh-CN.yaml
- Operation ID: patch-v5-rooms-uuid
- Method: PATCH
- Path: /v5/rooms/{uuid}
- Endpoint: https://api.netless.link/v5/rooms/{uuid}

## Servers

- https://api.netless.link

房间被封禁后，互动白板服务会移除房间内的用户并禁止新用户加入该房间。

你可以再次调用该 API，并在请求 Body 中将 `isBan` 设为 `false`，取消对房间的封禁。


## Parameters

- `region` (header, required, string) - 指定处理该请求的数据中心，取值如下：

- `cn-hz`：中国杭州，服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。

- `us-sv`：美国硅谷，服务区覆盖北美洲、南美洲。

- `sg`：新加坡，服务区覆盖新加坡、东亚、东南亚。

- `in-mum`：印度孟买，服务区覆盖印度。

- `eu`：欧洲（法兰克福），服务区覆盖欧洲。
  - Allowed: `cn-hz` | `us-sv` | `sg` | `in-mum` | `eu`
- `token` (header, required, string) - SDK Token，可以通过以下方式获取：

- 在声网控制台生成用于测试的 SDK Token，详见[获取互动白板项目的安全密钥](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/enable-service#获取互动白板项目的安全密钥)。

- 调用服务端 RESTful API， 详见[生成 SDK Token](generate-sdk-token)。

- 在 App 服务端用代码生成，详见[在 App 服务端生成 Token](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/generate-token#在-app-服务端生成-token)。
- `uuid` (path, required, string) - 房间的 UUID, 即房间的全局唯一标识符，可通过调用[创建房间 API](create-room) 或[获取房间信息 API](get-room) 获取。

## Request body

- `isBan` (boolean, required) - 是否封禁房间：

- `true`：封禁。

- `false`: （默认值）不封禁。
  - Default: `false`

## Responses

### 201

若返回的状态码为 `201` 则表示请求成功。响应 Body 中包含本次请求的结果。

若返回的状态码不为 `201` 则表示请求失败。你可以参考[响应状态码](/zh-CN/realtime-media/whiteboard/fastboard-sdk/reference/response-code)了解可能的原因。

- `uuid` (string) - 房间的 UUID，即房间的全局唯一标识符。
- `teamUUID` (string) - 互动白板控制台账号的唯一标识符。
- `appUUID` (string) - 互动白板项目的唯一标识符。
- `isRecord` (boolean) - 房间是否开启录制：

- `true`：开启。

- `false`: 不开启。
- `isBan` (boolean) - 房间是否被封禁：

- `true`：已封禁。

- `false`: 未封禁。
- `createdAt` (string) - 创建房间的 UTC 时间。
- `limit` (integer) - 已废弃，值固定为 `0`。

## Response examples

### 201

```json
{
  "uuid": "房间的 UUID，即房间的全局唯一标识符。     ",
  "teamUUID": "互动白板控制台账号的唯一标识符。     ",
  "appUUID": "互动白板项目的唯一标识符。",
  "isRecord": true,
  "isBan": true,
  "createdAt": "创建房间的 UTC 时间。   ",
  "limit": null
}
```