DescribeChannelUsers - 查询频道内在线用户列表

调用DescribeChannelUsers查询频道内在线用户列表的详细信息。

接口说明

本接口用于查询频道内在线用户列表的详细信息。例如:您可以查询直播模式下的用户总数。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

应用 ID,仅支持传单个 ID。

aec****
ChannelIdstring

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

testId

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

AD86847D-1F36-18C8-A995-5EEA34******
Timestamplong

当前时刻的时间戳(UTC 时间)。

1691027655
IsChannelExistsboolean

频道是否存在,取值:

  • true:存在。

  • false:不存在。

说明 频道无人后,会有若干秒的缓存,此时接口返回 true,但互动者与观众人数都为 0。
true
InteractiveUserNumberinteger

互动者用户总数。

1
LiveUserNumberinteger

频道内的观众总数。

1
InteractiveUserListarray

互动用户列表。

InteractiveUserstring

互动用户列表。

aaa
LiveUserListarray

观众列表。

LiveUserstring

观众列表,最多返回 1000 人。

bbb

示例

正常返回示例

JSON格式

{
  "RequestId": "AD86847D-1F36-18C8-A995-5EEA34******",
  "Timestamp": 1691027655,
  "IsChannelExists": true,
  "InteractiveUserNumber": 1,
  "LiveUserNumber": 1,
  "InteractiveUserList": [
    "aaa"
  ],
  "LiveUserList": [
    "bbb"
  ]
}

错误码

HTTP status code错误码错误信息
400400InvalidInput
401401InvalidAuth
404404AppOrChannelNotExists
500500SystemError, Please Check App And Channel Exists, RETRY

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

变更历史

变更时间变更内容概要操作
2023-08-31OpenAPI 错误码发生变更查看变更详情