ListLiveMessageGroupMessages - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the messages sent in a 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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:ListLiveMessageGroupMessages	list	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the interactive messaging application to query.	demo
GroupId	string	Yes	The ID of the group to query.	grouptest
PageSize	integer	Yes	The number of entries per page. Valid values: 10 to 50.	10
SortType	integer	Yes	The sort order based on the time when the messages were sent. Valid values: 1: ascending order 2: descending order	1
NextPageToken	long	No	The starting page number for the query. If you leave this parameter empty, the query starts from the first page.	1
MsgType	long	No	The type of messages that you want to query. If you leave this parameter empty, all types of messages are queried.	1
BeginTime	long	No	The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you leave this parameter empty, the earliest available time is used.	1697783235
EndTime	long	No	The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you leave this parameter empty, the latest available time is used.	1698301635
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
RequestId	string	The request ID.	1668FDC3-63D7-102F-B5D4-3D2F91D1****
GroupId	string	The ID of the group queried.	grouptest
NextPageToken	long	The starting page number for the next query. A value of 0 indicates that no further pages can be queried.	0
Hasmore	boolean	Indicates whether the current page is followed by another page.	false
MessageList	array<object>	Details about the messages.
Messages	object
Sender	object	The details about the user who sent the message.
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	long	The time when the message was sent. The value is a UNIX timestamp. Unit: seconds.	1697081134
MsgTid	string	The ID of the message.	c-1-1-0
MsgType	long	The type of the message.	2
SeqNumber	long	The sequence number of the message.	1
TotalMessages	long	The total number of messages.	1

Examples

Sample success responses

JSONformat

{
  "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
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

No change history