当前该接口依然可用，但是我们强烈建议你使用BanRoomUser移出用户。
在你的音视频应用中，你可能会需要从房间中移出某个用户，比如主播/房主/管理员将指定用户从指定房间中移出。你可以使用 KickUser 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以调用 KickUser 接口，指定你所属的 AppId，将指定 roomId 房间中的指定 userId 的用户从房间中移出。

被移出用户会收到 -1006 错误通知。
如果被移出用户为可见用户，房间中其他用户将收到 onUserLeave 回调。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
UserId	String	是	`Your_UserId`	你希望移出用户的 ID

返回参数

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

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

请求示例

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

返回示例

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

错误码

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