DescribeLiveMessageGroup - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the information about an interactive messaging group.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	coims-pre
GroupId	string	Yes	The ID of the interactive messaging group whose information you want to query.	grouptest
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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1815A27D-BAE2-10E6-89FD-D477951C67C7
GroupId	string	The group ID.	grouptest1
CreatorId	string	The ID of the group creator.	uid1
AdminList	array	The list of the group administrators.
Admins	string	The ID of the administrator.	uid1
Createtime	long	The time when the group was created. The value is a UNIX timestamp. Unit: seconds.	1698305471
GroupName	string	The name of the group.	mytestgroup
GroupInfo	string	Additional information about the group.	testgroupinfo
Delete	boolean	Indicates whether the group was deleted.	false
TotalTimes	long	The total number of sessions. This parameter is returned only if the group exists.	50
OnlineUserCounts	long	The number of online users in the group. This parameter is returned only if the group exists.	2
MsgAmount	object	The categorized message statistics. This parameter is returned only if the group exists.
	long	Number of messages.	{1 : 20, 2 : 30}
Deletatime	long	The time when the group was deleted. This parameter is returned only if the group was deleted.	1698299827
Deletor	string	The ID of the user who deleted the group. This parameter is returned only if the group was deleted.	uid1
SuperLargeGroup	boolean	Indicates whether the group is a super group. Valid values: True False	False

Examples

Sample success responses

JSONformat

{
  "RequestId": "1815A27D-BAE2-10E6-89FD-D477951C67C7",
  "GroupId": "grouptest1",
  "CreatorId": "uid1",
  "AdminList": [
    "uid1"
  ],
  "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
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-03-26	The Error code has changed. The response structure of the API has changed	View Change Details