获取频道展示在线人数

更新时间：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 以实际错误信息为准。）

直播服务端 API