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

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

接口说明

使用说明

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

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	APP ID。	testappid
ChannelId	string	是	频道 ID。	testid
CreatedTs	long	是	创建频道的时间戳，支持查询最近 30 天的数据。使用 UNIX 时间戳表示，单位：秒。	1615893133
DestroyedTs	long	否	释放频道的时间戳，使用 UNIX 时间戳表示，单位：秒。参数为空表示获取当前时间。说明如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。	1615893757

返回参数

名称	类型	描述	示例值
	object
TopPubUserDetailList	object []	Top 发布用户详情列表
UserId	string	用户 ID。	testuserid
Location	string	地域位置，例如：北京市-北京市	浙江省-杭州市
OnlinePeriods	object []	在线期间用户列表。
JoinTs	long	加入频道时间，使用 UNIX 时间戳表示，单位：秒。	1615893327
LeaveTs	long	离开频道时间，使用 UNIX 时间戳表示，单位：秒。	1615893442
CreatedTs	long	第一次加入频道的时间，使用 UNIX 时间戳表示，单位：秒。	1615893327
DestroyedTs	long	最后一次离开频道的时间，使用 UNIX 时间戳表示，单位：秒。	1615893442
OnlineDuration	long	通信时长，单位：秒。	115
Duration	long	总时长，单位：秒。	115
RequestId	string	请求 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	错误码	错误信息	描述
400	ApiParamError	API %s.	Api参数错误
403	BizCreatedTsError	A business CreatedTs error occurred.	参数会议创建时间不准确。
403	BizAppError	A business application permission error occurred.	业务应用权限错误
403	BizUidError	A business UID error occurred.	业务主账号错误
500	ServerInternalError	An internal error occurred.	服务器内部错误

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