You need to enable JavaScript to run this app.
导航
移出用户 KickUser
最近更新时间:2024.07.15 16:59:26首次发布时间:2023.04.12 12:01:31

当前该接口依然可用,但是我们强烈建议你使用BanRoomUser移出用户。

在实时音视频通话场景中,若需将特定用户从房间中移出,你可以通过调用此接口实现。

通过指定应用标识、房间 ID 和用户 ID,你可以将指定用户从房间中移出,被移出的用户会收到 -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
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
RoomId
String
Room1
房间的 ID,是房间的唯一标志
UserId
String
User1
你希望移出用户的 ID

返回参数

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

参数
类型
示例值
描述
message
String
success

请求示例

POST https://rtc.volcengineapi.com?Action=KickUser&Version=2020-12-01
{
    "AppId" : "661e****543cf",
    "RoomId" : "Room1",
    "UserId" : "user1"
}

返回示例

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

错误码

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