BatchGetOnlineUsers - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Usage notes

This operation supports batch queries. You can query the online status of up to 20 users at a time.

QPS limits

The single-user queries per second (QPS) limit for this operation is 100 times/second. If you exceed this limit, API calls will be throttled, which may affect your business. You should make API calls at a reasonable rate. For more information, see QPS limits.

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:BatchGetOnlineUsers

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application.	a494caec-***-695ef345db77
GroupId	string	Yes	The message group ID.	23wcaec-***695ef
UserIds	string	Yes	The list of user IDs. Separate multiple user IDs with commas (,). You can specify up to 20 user IDs.	de1a0,hu9

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	The returned result
OnlineUsers	array<object>	The array of objects
	object
JoinTime	integer	The UTC timestamp when the user joined the message group. Unit: milliseconds	12**45
Online	boolean	Indicates whether the user is online. Valid values: true: The user is online. false: The user is offline.	true
UserId	string	The user ID.	de1**a0

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "OnlineUsers": [
      {
        "JoinTime": 0,
        "Online": true,
        "UserId": "de1**a0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.