CheckLiveMessageUsersOnline - Check user online status - ApsaraVideo Live

Operation description

This operation allows up to 50 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:CheckLiveMessageUsersOnline

none

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
UserIds	array	Yes	The user IDs to query.
	string	No	The user ID. Separate multiple IDs with commas (,). You can query 1 to 10 users per call.	uid
DataCenter	string	No	The data center. Must match the value specified when you called the CreateLiveMessageApp operation. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	178F572F-AECF-100B-937A-B8047B4D****
UserList	array<object>	The queried users.
	object
Online	boolean	Whether the user is online.	false
UserId	string	The user ID.	uid1

Examples

Success response

JSON format

{
  "RequestId": "178F572F-AECF-100B-937A-B8047B4D****",
  "UserList": [
    {
      "Online": false,
      "UserId": "uid1"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Invalid input parameters.
500	ServerError	%s.	Unknown error. Try again later or submit a ticket.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.