查询频道内在线用户详细信息_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeChannelUsers	系统规定参数。取值：DescribeChannelUsers。
AppId	String	是	aec****	应用ID，仅支持传单个ID。
ChannelId	String	是	testId	已加入的频道ID，仅支持传单个ID。

返回数据

名称	类型	示例值	描述
RequestId	String	AD86847D-1F36-18C8-A995-5EEA340B3202	请求ID。
Timestamp	Long	1691027655	当前时刻的时间戳（UTC时间）。
IsChannelExists	Boolean	true	频道是否存在，取值： true：存在。 false：不存在。说明频道无人后，会有若干秒的缓存，此时接口返回true，但互动者与观众人数都为0。
InteractiveUserNumber	Integer	1	互动者用户总数。
LiveUserNumber	Integer	1	频道内的观众总数。
InteractiveUserList	Array of String	aaa	互动用户列表。
LiveUserList	Array of String	bbb	观众列表，最多返回1000人。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeChannelUsers
&AppId=aec****
&ChannelId=testId
&公共请求参数

正常返回示例

XML格式

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

<DescribeChannelUsersResponse>
    <RequestId>AD86847D-1F36-18C8-A995-5EEA340B3202</RequestId>
    <Timestamp>1691027655</Timestamp>
    <IsChannelExists>true</IsChannelExists>
    <InteractiveUserNumber>1</InteractiveUserNumber>
    <LiveUserNumber>1</LiveUserNumber>
    <InteractiveUserList>aaa</InteractiveUserList>
    <LiveUserList>bbb</LiveUserList>
</DescribeChannelUsersResponse>

JSON格式

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

{
  "RequestId" : "AD86847D-1F36-18C8-A995-5EEA340B3202",
  "Timestamp" : 1691027655,
  "IsChannelExists" : true,
  "InteractiveUserNumber" : 1,
  "LiveUserNumber" : 1,
  "InteractiveUserList" : [ "aaa" ],
  "LiveUserList" : [ "bbb" ]
}

错误码

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