DescribeLiveMessageGroup API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the details of a live interactive group.

Operation description

Before calling this operation, you must have already called CreateLiveMessageGroup to create an interactive messaging group.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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

get

*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
DataCenter	string	No	The data center. This value must be the same as the data center specified in CreateLiveMessageApp. Currently supported values: cn-shanghai (Shanghai) and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1815A27D-BAE2-10E6-89FD-D477951C****
GroupId	string	The group ID.	grouptest
CreatorId	string	The creator ID.	uid1
AdminList	array	The list of administrators.
	string	The administrator.	["uid1","uid2"]
Createtime	integer	The creation time. This value is a UNIX timestamp in seconds.	1698305471
GroupName	string	The group name.	mytestgroup
GroupInfo	string	The extended information of the group.	testgroupinfo
Delete	boolean	Indicates whether the group has been deleted.	false
TotalTimes	integer	The total number of sessions. This parameter is returned only when the group exists.	50
OnlineUserCounts	integer	The number of online users in the group. This parameter is returned only when the group exists.	2
MsgAmount	object	The message count statistics by category. This parameter is returned only when the group exists.
	integer	The number of messages.	{1 : 20, 2 : 30}
Deletatime	integer	The deletion time. This parameter is returned only when the group has been deleted. This value is a UNIX timestamp in seconds.	1698299827
Deletor	string	The user who deleted the group. This parameter is returned only when the group has been deleted.	uid1
SuperLargeGroup	boolean	Indicates whether the group is a super large group. Valid values: True: The group is a super large group. False: The group is not a super large group.	False

Examples

Success response

JSON format

{
  "RequestId": "1815A27D-BAE2-10E6-89FD-D477951C****",
  "GroupId": "grouptest",
  "CreatorId": "uid1",
  "AdminList": [
    "[\"uid1\",\"uid2\"]"
  ],
  "Createtime": 1698305471,
  "GroupName": "mytestgroup",
  "GroupInfo": "testgroupinfo",
  "Delete": false,
  "TotalTimes": 50,
  "OnlineUserCounts": 2,
  "MsgAmount": {
    "key": 0
  },
  "Deletatime": 1698299827,
  "Deletor": "uid1",
  "SuperLargeGroup": true
}

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.