Queries the interactive messaging groups in an interactive messaging application.
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.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:ListLiveMessageGroups |
list |
*Rtc
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AppId |
string |
Yes |
The application ID. |
demo |
| SortType |
integer |
Yes |
The sort order based on the time when the groups were created. Valid values:
Valid values:
|
1 |
| NextPageToken |
integer |
No |
The starting page number for the query. If you leave this parameter empty, the query starts from the first page. |
1001 |
| GroupStatus |
integer |
No |
The status of the groups to query. Default value: 0. Valid values:
Valid values:
|
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 elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
B5D95365-5A46-1A6A-BBF5-C7B6BDED**** |
| Hasmore |
boolean |
Indicates whether the current page is followed by another page. |
false |
| NextpageToken |
string |
The starting page number for the next query. This parameter is returned only if the value of Hasmore is true. |
1001 |
| GroupList |
array<object> |
Details about the groups. |
|
|
object |
Details about the groups. |
||
| GroupId |
string |
The ID of the group. |
cU9MeBqf**** |
| CreatorId |
string |
The ID of the group creator. |
user_77 |
| AdminList |
array |
The list of the IDs of the group administrators. |
|
|
string |
Administrator. |
uid1 |
|
| Createtime |
integer |
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
Success response
JSON format
{
"RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
"Hasmore": false,
"NextpageToken": "1001",
"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 |
| 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.