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

移出用户 KickUser

最近更新时间2024.02.29 19:32:55

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

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

使用说明

接口行为

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

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

调用接口

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

注意事项

请求频率: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

请求示例

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

返回示例

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

错误码

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