调用DescribeChannelParticipants查询频道内在线用户列表。

使用说明

本接口用于查询频道内在线用户列表，不包含用户详细信息。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeChannelParticipants

系统规定参数。取值：DescribeChannelParticipants。
AppId String 是 aec****

应用ID，仅支持传单个ID。
ChannelId String 是 testId

加入的频道，仅支持传单个ID。
PageNum Integer 否 1

当前页码。默认值为1。
PageSize Integer 否 10

每页显示用户数量，默认每页显示10条用户数据。
Order String 否 asc

排序方式，取值：

  • asc：递增。
  • desc（默认值）：递减。

返回数据

名称 类型 示例值 描述
TotalPage Integer 1

返回分页数。
RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

请求ID。
TotalNum Integer 3

返回结果数。
Times Long 1557909133

返回结果时间，使用UNIX时间戳表示，单位：秒。
UserList Array of String 27f9****,bb87****,df82****

用户ID列表，多个用英文逗号（,）分隔。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeChannelParticipants
&AppId=aec****
&ChannelId=testId
&PageNum=1
&PageSize=10
&Order=asc
&公共请求参数

正常返回示例

XML格式

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

<DescribeChannelParticipantsResponse>
    <RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>
    <Timestamp>1557909133</Timestamp>
    <TotalNum>3</TotalNum>
    <TotalPage>1</TotalPage>
    <UserList>
        <User>27f9****</User>
        <User>bb87****</User>
        <User>df82****</User>
    </UserList>
</DescribeChannelParticipantsResponse>

JSON格式

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

{
  "RequestId" : "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "Timestamp" : 1557909133,
  "TotalNum" : 3,
  "TotalPage" : 1,
  "UserList" : {
    "User" : [ "27f9****", "bb87****", "df82****" ]
  }
}

错误码

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