# 使用 SID 强制断开推流 (/zh-CN/api-reference/api-ref/rtmp-gateway/force-disconnection)

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

使用推流会话 ID 强制断开正在进行的推流。

- OpenAPI: /openapi/media-gateway/media-gateway.zh-CN.yaml
- Operation ID: delete-region-v1-projects-appId-rtls-ingress-online-streams-sid
- Method: DELETE
- Path: /{region}/v1/projects/{appId}/rtls/ingress/online-streams/{sid}
- Endpoint: https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/online-streams/{sid}

## Servers

- https://api.sd-rtn.com/

使用推流会话 ID（SID）断开指定的正在进行的推流。

你可以结合该接口和[销毁推流码 API](delete-streaming-key)，实现禁用流的功能。销毁推流码只会将推流码从数据库删除，之后就不能再使用该推流码，但不能断开正在进行的推流。如需断开正在进行的推流，你可以参考如下操作：

- 方法一：先调用[销毁推流码 API](delete-streaming-key)，再使用本接口断开正在进行的推流。
- 方法二：使用声网[封禁用户权限：将用户一次性踢出频道 API](/zh-CN/api-reference/api-ref/rtc/create-ban-rule) 同样也可以强制断开推流，如果已经集成过踢人接口，可以继续使用踢人接口来断开推流。


:::warning[注意]
一定要先销毁推流码，否则单独使用本接口强制断开后，推流软件会立即重连上来，此时会生成一个新的推流会话（对应一个新的 `sid`），断开失败。
:::

## Authorization

This endpoint requires authentication.

- `Basic Auth`
- `API Key`

## Parameters

- `X-Request-ID` (header, optional, string) - 本次请求的 UUID（通用唯一识别码）。传入该字段后，声网服务器会在响应 Header 中返回该字段。声网推荐你对 `X-Request-ID` 赋值。如果不赋值，声网服务器会自动生成一个 UUID 传入。
- `region` (path, required, string) - 创建推流码的区域。声网支持分区域创建推流码，目前支持以下区域：
- `cn`：中国大陆
- `ap`：除中国大陆以外的亚洲区域
- `na`：北美
- `eu`：欧洲

> [!CAUTION]
> - 请确保设置的 `region` 与输入的源流在同一个区域。
> - 请确保设置的 `region` 与推流使用的域名在同一个区域。
> - 请确保传入 `region` 的值为小写。
- `appId` (path, required, string) - 声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
- `sid` (path, required, string) - 推流会话 ID（Session ID），是每次发起的推流任务的唯一标识。可以通过[查询当前在推流列表 API](query-streaming-list) 获得，也可通过接收[消息通知回调](/zh-CN/realtime-media/rtmp-gateway/reference/ncs-events)的 Payload 获取。

## Request body

No request body.

## Responses

### 2XX

如果状态码为 `2XX`，则请求成功。

- `status` (string) - 请求状态，值为 `success`。
### default

如果状态码不为 `2XX`，则请求失败。你可以参考[响应状态码](/zh-CN/realtime-media/rtmp-gateway/reference/response-code)了解可能的原因。

- `message` (string) - 请求失败的具体原因。

## Response examples

### 2XX

```json
{
  "status": "请求状态，值为 `success`。"
}
```
### default

```json
{
  "message": "string"
}
```