Queries online users in a channel.

Usage notes

You can call this operation to query online users in a channel. The returned result does not include details about the users.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeChannelParticipants

The operation that you want to perform. Set the value to DescribeChannelParticipants.

AppId String Yes aec****

The ID of the application. You can specify only one application ID.

ChannelId String Yes testId

The ID of the channel. You can specify only one channel ID.

PageNum Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

Order String No asc

The sort order. Valid values:

  • asc: ascending order.
  • desc: descending order. This is the default value.

Response parameters

Parameter Type Example Description
TotalPage Integer 1

The page number of the returned page.

RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

The ID of the request.

TotalNum Integer 3

The number of entries returned.

Times Long 1557909133

The time elapsed until the result was returned. Unit: seconds. The value is a UNIX timestamp.

UserList Array of String 27f9****,bb87****,df82****

The IDs of the users in the channel. Multiple user IDs are separated by commas (,).

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeChannelParticipants
&AppId=aec****
&ChannelId=testId
&PageNum=1
&PageSize=10
&Order=asc
&<Common request parameters>

Sample success responses

XML format

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 format

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****" ]
  }
}

Error codes

For a list of error codes, see Service error codes.