All Products
Search

This Product

    ApsaraVideo Live:ListLiveMessageGroupByPage

    Document Center

    ApsaraVideo Live:ListLiveMessageGroupByPage

    Dernière mise à jour :Jul 16, 2026

    Queries the list of interactive message groups with pagination support.

    Operation description

    Before calling this operation, you must have already called CreateLiveMessageGroup to create an interactive message group.

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

    list

    *Rtc

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    The application ID.

    demo
    SortType

    integer

    Yes

    The sort order, based on group creation time. Valid values:

    • 1: Ascending order.

    • 2: Descending order.

    Valid values:

    • 1 :

      ascending order.

    • 2 :

      descending order.

    1
    PageSize

    integer

    No

    The page size. 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 group status. Default value: 0. Valid values:

    • 0: Queries all groups.

    • 1: Queries groups that are not deleted.

    • 2: Queries deleted groups.

    Valid values:

    • 0 :

      queries all groups.

    • 1 :

      queries groups that are not deleted.

    • 2 :

      queries deleted groups.

    1
    DataCenter

    string

    No

    The data center. This value must be the same as 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

    Schema of Response

    RequestId

    string

    The request ID.

    B5D95365-5A46-1A6A-BBF5-C7B6BDED****
    TotalCount

    integer

    The total number of entries.

    50
    PageNumber

    integer

    The current page number of the returned data.

    1
    PageSize

    integer

    The page size.

    20
    GroupList

    array<object>

    The group list.

    object

    The group object.

    GroupId

    string

    The group ID.

    cU9MeBqf****
    CreatorId

    string

    The creator ID.

    user_77
    AdminList

    array

    The list of administrator user IDs.

    string

    The administrator user ID.

    uid1
    Createtime

    integer

    The creation time, expressed as a UNIX timestamp. Unit: seconds.

    1698299727
    GroupName

    string

    The group name.

    mytestgroup
    GroupInfo

    string

    The extended information of the group.

    testgroupinfo
    Delete

    boolean

    Indicates whether the group is deleted.

    true

    Examples

    Success response

    JSON format

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