DescribeChannelUsers - Query online users in a live channel - ApsaraVideo Live

Operation description

Queries information about online users in a channel, such as the total number of users during live streaming.

QPS limit

This operation allows up to 100 requests per second per account. Excess requests are dropped, which may cause service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeChannelUsers

list

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. Only one application ID can be specified per request.	aec****
ChannelId	string	Yes	The channel ID. Only one channel ID can be specified per request.	testId

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	AD86847D-1F36-18C8-A995-5EEA340B3202
Timestamp	integer	The UTC timestamp when the response is returned.	1691027655
IsChannelExists	boolean	Indicates whether the channel exists. Valid values: true false Note After all users leave a channel, cache clearing takes a few seconds. During this period, this parameter returns true while InteractiveUserNumber and LiveUserNumber return 0.	true
InteractiveUserNumber	integer	The number of co-streamers.	1
LiveUserNumber	integer	The number of viewers.	1
InteractiveUserList	array	The list of streamers/co-streamers.
	string	The list of interactive users.	aaa
LiveUserList	array	The list of viewers.
	string	The list of viewers. Up to 1,000 viewers are returned.	bbb

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	400	InvalidInput
401	401	InvalidAuth
500	500	SystemError, Please Check App And Channel Exists, RETRY
404	404	AppOrChannelNotExists

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.