獲取頻道展示線上人數

更新時間：2026-08-12 17:10:12

介面描述

由业务服务端调用，获取指定频道当前展示在线人数；
返回值口径与监控页、端上展示人数一致（在线列表人数 + 列表外虚拟人数 factor）。
接口支持 HTTPS 协议。

介面URL

https://api.polyv.net/live/v5/chat/redirect/channel/online-user-count/get

請求方式

GET

介面約束

1、介面同時支援 HTTP、HTTPS，建議使用 HTTPS 確保介面安全。
2、displayCount 為展示線上人數，等於線上列表總人數加上列表外虛擬人數（factor），與監控頁、端上展示人數一致。
3、dummyCount 為列表內虛擬人數；realCount 為真實線上人數（列表總人數減去列表內虛擬人數）。
4、本介面與歷史介面「獲取頻道聊天室的線上人數」（/live/v3/channel/chat/count-online-user）不同：本介面額外區分真人數與虛擬人數，並回傳含虛擬加成後的展示人數。

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見獲取金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器獲取回應資料`【詳見簽名產生規則】
roomId	true	String(1,100)	頻道號（query 參數）

範例

請求範例：

GET https://api.polyv.net/live/v5/chat/redirect/channel/online-user-count/get?roomId=412738

回應體 JSON（成功）：

{
  "code": 200,
  "status": "success",
  "message": "获取成功",
  "data": {
    "displayCount": 10000,
    "dummyCount": 3000,
    "realCount": 1
  }
}

回應參數描述

參數名	類型	說明
code	Integer	200 表示成功；400 多為參數驗證失敗；500 多為業務錯誤或服務端異常
status	String	`success` / `fail` / `error`
message	String	如「獲取成功」或具體錯誤說明
data	Object	人數明細，見下表

data 欄位

參數名	類型	說明
displayCount	Number	展示線上人數（列表人數 + 列表外虛擬人數 factor），與監控頁/端上展示一致
dummyCount	Number	列表內虛擬人數
realCount	Number	真實線上人數

異常範例

參數驗證失敗：

{
  "code": 400,
  "status": "fail",
  "message": "缺少参数roomId"
}

頻道與帳號不匹配：

{
  "code": 400,
  "status": "fail",
  "message": "roomId非法"
}

未傳帳號鑑權資訊：

{
  "code": 400,
  "status": "fail",
  "message": "accountId is required"
}

服務端異常：

{
  "code": 500,
  "status": "error",
  "message": "获取在线人数失败"
}

（具體 message 以實際錯誤資訊為準。）