最近更新时间:2024.04.11 11:50:48
首次发布时间:2023.04.12 12:01:31
当前该接口依然可用,但是我们强烈建议你使用BanRoomUser移出用户。
在你的音视频应用中,你可能会需要从房间中移出某个用户,比如主播/房主/管理员将指定用户从指定房间中移出。你可以使用 KickUser
这个 OpenAPI 实现这一功能。
你可以调用 KickUser
接口,指定你所属的 AppId
,将指定 roomId
房间中的指定 userId
的用户从房间中移出。
-1006
错误通知。onUserLeave
回调。关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法。
请求频率:QPS 不得超过 60。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | KickUser | 接口名称。当前 API 的名称为 KickUser 。 |
Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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" } }
您可访问公共错误码,获取更多错误码信息。