Query Live Messaging Group Users via CheckLiveMessageUsersInGroup API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Before you call this operation, make sure that you have called the CreateLiveMessageGroup operation to create an interactive messaging group.

QPS limit

You can call this operation up to 50 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.

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

none

*Rtc

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
GroupId	string	Yes	The group ID.	grouptest
UserIds	array	Yes	The list of users that you want to query.
	string	Yes	The user ID. Separate multiple user IDs with commas (,). The number of users to query in each call can range from 1 to 10.	uid
DataCenter	string	No	The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F1F68D81-1543-1FE4-B56E-82200DD2****
Users	array<object>	The list of users queried.
	object
UserId	string	The ID of the user.	uid1
Online	boolean	Indicates whether the user is in the group.	false

Examples

Success response

JSON format

{
  "RequestId": "F1F68D81-1543-1FE4-B56E-82200DD2****",
  "Users": [
    {
      "UserId": "uid1",
      "Online": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.