首页 音视频通信 开发参考 API参考 API目录 数据服务 频道数据 DescribeChannelTopPubUserList - 获取频道内发布端的用户列表

DescribeChannelTopPubUserList - 获取频道内发布端的用户列表

更新时间: 2024-11-08 17:33:34

本接口用于获取频道内发布端的用户列表(按用户在线时长降序)。

接口说明

使用说明

本接口用于获取频道内发布端的用户列表(按用户在线时长降序)。例如:在用户列表中您可以查询用户加入通话时间、通信时长等信息。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

创建频道的时间戳,支持查询最近 30 天的数据。使用 UNIX 时间戳表示,单位:秒。

1615893133
DestroyedTslong

释放频道的时间戳,使用 UNIX 时间戳表示,单位:秒。参数为空表示获取当前时间。

说明 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
1615893757

返回参数

名称类型描述示例值
object
TopPubUserDetailListarray<object>

Top 发布用户详情列表

UserDetailobject
UserIdstring

用户 ID。

testuserid
Locationstring

地域位置,例如:北京市-北京市

浙江省-杭州市
OnlinePeriodsarray<object>

在线期间用户列表。

OnlinePeriodobject
JoinTslong

加入频道时间,使用 UNIX 时间戳表示,单位:秒。

1615893327
LeaveTslong

离开频道时间,使用 UNIX 时间戳表示,单位:秒。

1615893442
CreatedTslong

第一次加入频道的时间,使用 UNIX 时间戳表示,单位:秒。

1615893327
DestroyedTslong

最后一次离开频道的时间,使用 UNIX 时间戳表示,单位:秒。

1615893442
OnlineDurationlong

通信时长,单位:秒。

115
Durationlong

总时长,单位:秒。

115
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "TopPubUserDetailList": [
    {
      "UserId": "testuserid",
      "Location": "浙江省-杭州市",
      "OnlinePeriods": [
        {
          "JoinTs": 1615893327,
          "LeaveTs": 1615893442
        }
      ],
      "CreatedTs": 1615893327,
      "DestroyedTs": 1615893442,
      "OnlineDuration": 115,
      "Duration": 115
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizCreatedTsErrorA business CreatedTs error occurred.参数会议创建时间不准确。
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

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

上一篇: DescribeChannelAreaDistributionStatData - 获取频道地区分布统计数据 下一篇: DescribeChannelUserMetrics - 查询频道概览中的用户数据
阿里云首页 音视频通信 相关技术圈