Query Group Messages with ListLiveMessageGroupMessages - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the message list of a group by calling ListLiveMessageGroupMessages.

Operation description

Before calling this operation, you must have already created an interactive message group by calling CreateLiveMessageGroup.

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

list

*Rtc

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive message application to query.	demo
GroupId	string	Yes	The group ID of the group to query.	grouptest
PageSize	integer	Yes	The number of messages to display at a time. Valid values: [10,50].	10
SortType	integer	Yes	The sort type. Messages are sorted by the time they were sent. Valid values: 1: ascending order 2: descending order Valid values: 1 : ascending order. 2 : descending order.	1
NextPageToken	integer	No	The start position of the query page. If this parameter is left empty, the first page is returned by default.	1
MsgType	integer	No	The message type to query. If this parameter is left empty, all message types are returned by default.	1
BeginTime	integer	No	The query start time, expressed as a UNIX timestamp. Unit: seconds. If this parameter is left empty, the earliest time is used by default.	1697783235
EndTime	integer	No	The query end time, expressed as a UNIX timestamp. Unit: seconds. If this parameter is left empty, the latest time is used by default.	1698301635
DataCenter	string	No	The data center. This value must be consistent with the data center specified in CreateLiveMessageApp. Currently supported data centers are Shanghai (cn-shanghai) and Singapore (ap-southeast-1).	cn-shanghai

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1668FDC3-63D7-102F-B5D4-3D2F91D1****
GroupId	string	The group ID of the group to query.	grouptest
NextPageToken	integer	The start position of the next page. The value is 0 if there is no next page.	0
Hasmore	boolean	Indicates whether there is a next page.	false
MessageList	array<object>	The message list.
	array<object>	The list details.
Sender	object	The message sender details.
UserId	string	The ID of the user who sent the message.	uid2
UserInfo	string	The additional information about the user who sent the message.	testusermeta2
Body	string	The message body.	step2 helo, cc group
Timestamp	integer	The time when the message was created, expressed as a UNIX timestamp. Unit: seconds.	1697081134
MsgTid	string	The message identifier.	c-1-1-0
MsgType	integer	The message type.	2
SeqNumber	integer	The message sequence number.	1
TotalMessages	integer	The total number of messages.	1

Examples

Success response

JSON format

{
  "RequestId": "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "MessageList": [
    {
      "Sender": {
        "UserId": "uid2",
        "UserInfo": "testusermeta2"
      },
      "Body": "step2 helo, cc group",
      "Timestamp": 1697081134,
      "MsgTid": "c-1-1-0",
      "MsgType": 2,
      "SeqNumber": 1,
      "TotalMessages": 1
    }
  ]
}

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.