ListLiveMessageGroupByPage - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries interactive messaging groups by page.

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 ID of the interactive messaging application.	demo
SortType	integer	Yes	The sort order based on the time when the groups were created. Valid values: 1: ascending order 2: descending order	1
PageSize	integer	No	The number of entries per page. Valid values:[1,50]. Default value: 20.	20
PageNumber	integer	No	The page number. Valid values: [1,10000]. Default value: 1.	1
GroupStatus	integer	No	The status of the groups to query. Default value: 0. Valid values: 0: all groups 1: existing groups 2: deleted groups	1
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	Schema of Response
RequestId	string	The ID of the request.	B5D95365-5A46-1A6A-BBF5-C7B6BDED****
TotalCount	integer	The total number of entries returned.	50
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned on each page.	20
GroupList	array<object>	The list of groups.
Groups	object
GroupId	string	The ID of the interactive messaging group.	cU9MeBqf****
CreatorId	string	The ID of the user who created the group.	user_77
AdminList	array	The list of 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.	1698299727
GroupName	string	The name of the group.	mytestgroup
GroupInfo	string	The additional information about the group.	testgroupinfo
Delete	boolean	Indicates whether the group is deleted.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "TotalCount": 50,
  "PageNumber": 1,
  "PageSize": 20,
  "GroupList": [
    {
      "GroupId": "cU9MeBqf****",
      "CreatorId": "user_77",
      "AdminList": [
        "uid1"
      ],
      "Createtime": 1698299727,
      "GroupName": "mytestgroup",
      "GroupInfo": "testgroupinfo",
      "Delete": 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.