ListMessageGroupUserById - ApsaraVideo Live - Alibaba Cloud Documentation Center

Call ListMessageGroupUserById to query user information by user ID list.

Operation description

QPS limits

The QPS limit for this API is 100 queries per second per user. If the limit is exceeded, API calls will be throttled, which may affect your business. You can call the API properly to avoid this issue. 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 support 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:ListMessageGroupUserById

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	Interactive message application ID.	VKL3***
GroupId	string	Yes	Message group ID.	AE35-****-T95F
UserIdList	array	Yes	User list.
	string	No	User ID.	de1**a0

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	Return result.
HasMore	boolean	Indicates whether there is a next page. Valid values: true: There is a next page. false: There is no next page.	false
Total	integer	Total number of users queried.	3
UserList	array	User list information.
	object
IsMute	boolean	Indicates whether the user is muted. Valid values: true: Muted. false: Not muted.	true
MuteBy	array	Mute type. Valid values: group: All members in the message group are muted. user: Individual user is muted.
	string	Mute type. Valid values: group: All members in the message group are muted. user: Individual user is muted.	user
UserAvatar	string	Profile picture URL.	"http://www.aliyundoc.com/xxyy.png"
UserExtension	string	Custom user information content.	12e
UserId	string	User ID.	ad***
UserNick	string	User nickname.	xxyy

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "HasMore": false,
    "Total": 3,
    "UserList": [
      {
        "IsMute": true,
        "MuteBy": [
          "user"
        ],
        "UserAvatar": "\"http://www.aliyundoc.com/xxyy.png\"",
        "UserExtension": "12e",
        "UserId": "ad***",
        "UserNick": "xxyy"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam	Parameter invalid.	Illegal input parameters
403	NoAuth	%s.	No permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.