RemoveUsers - 踢出用户

更新时间: 2024-11-08 17:29:52

本接口用于踢出频道内的用户。

接口说明

使用说明

本接口用于踢出在线频道内的用户。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:RemoveUsersdelete
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

eo85****
ChannelIdstring

已加入的频道 ID,仅支持传单个 ID。

testid
Usersarray<object>

用户列表,N 的取值:1~30。

object
UserIdstring

用户 ID。

1811****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CF8
Usersarray<object>

用户列表。

Userobject
Codeinteger

状态码,成功返回 0,失败返回错误码描述。

0
UserIdstring

用户 ID。

1811****
Messagestring

删除终端操作结果。取值:

  • Success:成功。
  • Failed:失败。
Success

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8",
  "Users": [
    {
      "Code": 0,
      "UserId": "1811****",
      "Message": "Success"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

上一篇: DescribeChannel - 查询在线频道信息 下一篇: 云端录制
阿里云首页 音视频通信 相关技术圈