すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:ListMessageGroup

    ドキュメントセンター

    ApsaraVideo Live:ListMessageGroup

    最終更新日:Jun 10, 2026

    ListMessageGroup を呼び出して、指定されたユーザーのメッセージグループリストをクエリします。

    操作説明

    QPS limits

    The single-user QPS limit for this API is 100 queries per second. If this limit is exceeded, API calls will be throttled, which may affect your business. You can call this API at a reasonable rate. For more information, see QPS limits.

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:ListMessageGroup

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    UserId

    string

    任意

    ユーザー ID。ユーザーによってカスタマイズされ、AppId 内で一意である必要があります。異なるユーザーは異なる UserId を使用する必要があります。

    説明

    正常なクエリを実行するには、このパラメーターを正しく塗りつぶしする必要があります。

    de1**a0
    AppId

    string

    任意

    インタラクティブなメッセージアプリケーション ID。

    説明

    正常なクエリを実行するには、このパラメーターを正しく塗りつぶしする必要があります。

    VKL3***
    SortType

    integer

    任意

    ソートメソッド。有効な値:

    • 0: 時間の昇順で注文。

    • 1: 時間の降順で注文。

    1
    PageNum

    integer

    必須

    ページ番号。デフォルト値: 1。有効な値: 1～100000。

    10
    PageSize

    integer

    必須

    ページあたりに表示するメッセージグループの数。デフォルト値: 20。

    有効な値: 1～50。

    20

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Schema of Response

    RequestId

    string

    Request ID.

    16A96B9A-****-CB92E68F4CD8
    Result

    object

    Return result.

    GroupList

    array<object>

    Message group list.

    array<object>

    Message group details.

    AppId

    string

    Interactive Messages application ID.

    VKL3***
    CreateTime

    integer

    UTC timestamp when the message group was created.

    1502280113
    CreatorId

    string

    Creator ID.

    as****hs
    Extension

    object

    Extension field.

    string

    Extension field.

    test001
    GroupId

    string

    Message group ID.

    AE35-****-T95F
    Status

    integer

    Message group status. The default value is 1, indicating that the message group status is normal.

    1
    HasMore

    boolean

    Indicates whether there is a next page. Valid values:

    • true: There is a next page.

    • false: There is no next page.

    false
    Total

    integer

    Total number of message groups.

    5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "GroupList": [
      {
        "AppId": "VKL3***",
        "CreateTime": 1502280113,
        "CreatorId": "as****hs",
        "Extension": {
          "key": "test001"
        },
        "GroupId": "AE35-****-T95F",
        "Status": 1
      }
    ],
    "HasMore": false,
    "Total": 5
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。