查询频道内在线用户列表的详细信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeChannelUsers | list | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | 应用 ID，仅支持传单个 ID。 | aec**** |
| ChannelId | string | 是 | 已加入的频道 ID，仅支持传单个 ID。 | testId |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "AD86847D-1F36-18C8-A995-5EEA34******",
"Timestamp": 1691027655,
"IsChannelExists": true,
"InteractiveUserNumber": 1,
"LiveUserNumber": 1,
"InteractiveUserList": [
"aaa"
],
"LiveUserList": [
"bbb"
]
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | 400 | InvalidInput |
| 401 | 401 | InvalidAuth |
| 404 | 404 | AppOrChannelNotExists |
| 500 | 500 | SystemError, Please Check App And Channel Exists, RETRY |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-31 | OpenAPI 错误码发生变更 | 查看变更详情 |