当前该接口依然可用,但是我们强烈建议你使用BanRoomUser移出用户。
在你的音视频应用中,你可能会需要从房间中移出某个用户,比如主播/房主/管理员将指定用户从指定房间中移出。你可以使用 KickUser 这个 OpenAPI 实现这一功能。
接口行为
你可以调用 KickUser 接口,指定你所属的 AppId,将指定 roomId 房间中的指定 userId 的用户从房间中移出。
-1006 错误通知。onUserLeave 回调。关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
QPS 不得超过 60。
使用 Post 方式发起请求。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | 接口名称,本接口取值:KickUser | |
| Version | String | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | String | 是 | Your_AppId | 你的音视频应用的唯一标志 |
| RoomId | String | 是 | Your_RoomId | 房间的 ID,是房间的唯一标志 |
| UserId | String | 是 | Your_UserId | 你希望移出用户的 ID |
https://rtc.volcengineapi.com/?Action=KickUser&Version=2020-12-01
postscript{
"AppId" : "Your_AppId",
"RoomId" : "Your_RoomId",
"UserId" : "Your_UserId"
}
json返回值 Result 仅在请求成功时返回消息 "success", 失败时为空。
{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "KickUser",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result":{
"Message": "success"
}
}
json