查询 Channel（频道）实时在线用户列表。

接口说明

使用说明

本接口用于查询频道内在线用户列表的详细信息。例如：您可以查询通信模式和直播模式下的用户总数。

QPS 限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，通过控制台创建和查询，仅支持传单个 ID。	a2hz****
ChannelId	string	是	要查询的频道 ID，仅支持传单个 ID。	testId

返回参数

名称	类型	描述	示例值
	object
CommTotalNum	integer	通信模式下频道内的用户总数，如果频道为非通信模式，该参数为 0。	100
RequestId	string	请求 ID。	6159ba01-6687-4fb2-a831-f0cd8d188648
IsChannelExist	boolean	频道是否存在，取值： true：存在。 false：不存在。	true
LiveUserNum	integer	直播模式下频道内的观众总数，如果频道为非直播模式，该参数为 0。	0
Timestamp	integer	当前时刻的时间戳（UTC 时间）。	1557909133
ChannelProfile	integer	频道模式，取值： 1：Communication（通信模式）。 2：Interactive_live（直播模式）。	1
InteractiveUserNum	integer	直播模式下频道内的互动者用户总数，如果频道为非直播模式，该参数为 0。	0
UserList	array	通信模式下频道内用户的 ID 列表；非通信模式下为空。
	string	通信模式下频道的用户列表，如果频道为非通信模式，该参数为空。	[]
InteractiveUserList	array	直播模式下频道内互动用户的 ID 列表；非直播模式下为空。
	string	直播模式下频道内的互动用户列表，如果频道为非直播模式，该参数为空。	["4455**", "3267", "efbc**"]
LiveUserList	array	直播模式下频道内观众的 ID 列表，最多返回前 1000 人；非直播模式下为空。
	string	直播模式下频道内的观众列表，只返回前 1000 人，如果频道为非直播模式，该参数为空。	["4455**", "3267", "efbc**"]

示例

正常返回示例

JSON格式

{
  "CommTotalNum": 100,
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "IsChannelExist": true,
  "LiveUserNum": 0,
  "Timestamp": 1557909133,
  "ChannelProfile": 1,
  "InteractiveUserNum": 0,
  "UserList": [
    "[]"
  ],
  "InteractiveUserList": [
    "[\"4455****\", \"3267****\", \"efbc****\"]"
  ],
  "LiveUserList": [
    "[\"4455****\", \"3267****\", \"efbc****\"]"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	request.norequestid	no request	未找到RequestID
400	request.noaliuid	no aliuid	未找到该aliuid
400	request.noappid	no appid	未找到应用ID
400	request.nochannelid	no channelid	请求.未找到该频道ID
400	service.signalrequesterror	signal request error	服务，信令请求错误
401	request.illegalauth	illegal auth	非法的请求鉴权参数
401	request.authinvalid	auth invalid	请求鉴权无效
500	service.signalrequesterror	signal send msg error	服务，信令请求错误

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

变更历史

更多信息，参考变更详情。