調(diào)用DescribeChannelTopPubUserList獲取頻道內(nèi)發(fā)布端的用戶(hù)列表。

使用說(shuō)明

本接口用于獲取頻道內(nèi)發(fā)布端的用戶(hù)列表（按用戶(hù)在線(xiàn)時(shí)長(zhǎng)降序）。例如：在用戶(hù)列表中您可以查詢(xún)用戶(hù)加入通話(huà)時(shí)間、通信時(shí)長(zhǎng)等信息。

QPS限制

本接口的單用戶(hù)QPS限制為10次/秒。超過(guò)限制，API調(diào)用會(huì)被限流，這可能會(huì)影響您的業(yè)務(wù)，請(qǐng)合理調(diào)用。更多信息，請(qǐng)參見(jiàn)QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求頭

該接口使用公共請(qǐng)求頭，無(wú)特殊請(qǐng)求頭。請(qǐng)參見(jiàn)公共請(qǐng)求參數(shù)文檔。

請(qǐng)求語(yǔ)法

POST /api/channel/describeChannelTopPubUserList HTTP/1.1

請(qǐng)求參數(shù)

名稱(chēng) 類(lèi)型 位置 是否必選 示例值 描述
AppId String Query 是 9qb1****

App ID，可通過(guò)控制臺(tái)創(chuàng)建和查詢(xún)。
ChannelId String Query 是 311

頻道ID。
CreatedTs Long Query 是 1615893133

創(chuàng)建頻道的時(shí)間戳，支持查詢(xún)最近30天的數(shù)據(jù)。使用UNIX時(shí)間戳表示，單位：秒。
DestroyedTs Long Query 否 1615893757

釋放頻道的時(shí)間戳，使用UNIX時(shí)間戳表示，單位：秒。參數(shù)為空表示獲取當(dāng)前時(shí)間。

說(shuō)明 如果傳入的頻道釋放時(shí)間超過(guò)真實(shí)的釋放時(shí)間，將返回從創(chuàng)建時(shí)間開(kāi)始到真實(shí)釋放時(shí)間之間的數(shù)據(jù)。

返回?cái)?shù)據(jù)

名稱(chēng) 類(lèi)型 示例值 描述
TopPubUserDetailList Array of UserDetail

發(fā)布端的用戶(hù)列表。
UserId String d58e3582****

用戶(hù)ID。
Location String 浙江省-杭州市

地域位置，例如：浙江省-杭州市。
OnlinePeriods Array of OnlinePeriod

在線(xiàn)時(shí)段信息。
JoinTs Long 1615893327

加入通話(huà)時(shí)間，使用UNIX時(shí)間戳表示，單位：秒。
LeaveTs Long 1615893442

離開(kāi)通話(huà)時(shí)間，使用UNIX時(shí)間戳表示，單位：秒。
CreatedTs Long 1615893327

第一次加入通話(huà)的時(shí)間，使用UNIX時(shí)間戳表示，單位：秒。
DestroyedTs Long 1615893442

最后一次離開(kāi)通話(huà)的時(shí)間，使用UNIX時(shí)間戳表示，單位：秒。通話(huà)未結(jié)束時(shí)值為0。
OnlineDuration Long 115

通信時(shí)長(zhǎng)，單位：秒。
Duration Long 115

總時(shí)長(zhǎng)，單位：秒。
RequestId String 3024CAAA-962D-459F-871B-C263841F264A

請(qǐng)求ID。

示例

請(qǐng)求示例

POST api/channel/describeChannelTopPubUserList?AppId=9qb1****&ChannelId=123333&CreatedTs=1615893133&DestroyedTs=1615893757 HTTP/1.1 
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeChannelTopPubUserListResponse>
    <code>200</code>
    <data>
        <TopPubUserDetailList>
            <DestroyedTs>1615893757</DestroyedTs>
            <UserId>d58e3582****</UserId>
            <Duration>616</Duration>
            <CreatedTs>1615893141</CreatedTs>
            <OnlineDuration>616</OnlineDuration>
            <OnlinePeriods>
                <JoinTs>1615893141</JoinTs>
            </OnlinePeriods>
            <Location>浙江省-杭州市</Location>
        </TopPubUserDetailList>
        <TopPubUserDetailList>
            <DestroyedTs>1615893442</DestroyedTs>
            <UserId>6af2a3b1bd5a****</UserId>
            <Duration>115</Duration>
            <CreatedTs>1615893327</CreatedTs>
            <OnlineDuration>115</OnlineDuration>
            <OnlinePeriods>
                <LeaveTs>1615893442</LeaveTs>
                <JoinTs>1615893327</JoinTs>
            </OnlinePeriods>
            <Location>浙江省-杭州市</Location>
        </TopPubUserDetailList>
        <RequestId>3024CAAA-962D-459F-871B-C263841F264A</RequestId>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>3024CAAA-962D-459F-871B-C263841F264A</requestId>
    <successResponse>true</successResponse>
</DescribeChannelTopPubUserListResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "TopPubUserDetailList" : [ {
      "DestroyedTs" : 1615893757,
      "UserId" : "d58e3582****",
      "Duration" : 616,
      "CreatedTs" : 1615893141,
      "OnlineDuration" : 616,
      "OnlinePeriods" : [ {
        "JoinTs" : 1615893141
      } ],
      "Location" : "浙江省-杭州市"
    }, {
      "DestroyedTs" : 1615893442,
      "UserId" : "6af2a3b1bd5a****",
      "Duration" : 115,
      "CreatedTs" : 1615893327,
      "OnlineDuration" : 115,
      "OnlinePeriods" : [ {
        "LeaveTs" : 1615893442,
        "JoinTs" : 1615893327
      } ],
      "Location" : "浙江省-杭州市"
    } ],
    "RequestId" : "3024CAAA-962D-459F-871B-C263841F264A"
  },
  "httpStatusCode" : "200",
  "requestId" : "3024CAAA-962D-459F-871B-C263841F264A",
  "successResponse" : true
}