すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:ListMessage

    ドキュメントセンター

    ApsaraVideo Live:ListMessage

    最終更新日:Jan 08, 2026

    メッセージリストを照会します。

    操作説明

    QPS 制限

    この API 操作のシングルユーザー QPS 制限は 100 クエリ/秒（QPS）です。制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。この問題を回避するには、API 操作を適切に呼び出すことができます。詳細については、「QPS 制限」をご参照ください。

    今すぐお試しください

    この 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:ListMessage

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GroupId

    string

    必須

    メッセージグループ ID。

    AE35-****-T95F
    AppId

    string

    必須

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

    VKL3***
    Type

    integer

    任意

    ユーザー定義メッセージタイプ。値は 10000 より大きい必要があります。

    10002
    SortType

    integer

    任意

    ソート方法。有効な値：

    • 0: 時間の昇順。

    • 1: 時間の降順。

    1
    PageNum

    integer

    必須

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

    10
    PageSize

    integer

    必須

    1 ページあたりに表示されるユーザー数。デフォルト値：20。有効な値：1 ～ 50。

    20

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエスト ID。

    16A96B9A-****-CB92E68F4CD8
    Result

    object

    返された結果。

    HasMore

    boolean

    次のページがあるかどうかを示します。有効な値：

    • true: 次のページがあります。

    • false: 次のページはありません。

    false
    MessageList

    array<object>

    メッセージリスト。

    object

    Data

    string

    メッセージ本文（JSONString 形式）。

    test
    GroupId

    string

    メッセージグループ ID。

    AE35-****-T95F
    MessageId

    string

    メッセージ ID。

    qt***
    SenderId

    string

    メッセージ送信者 ID。

    yi***
    Type

    integer

    メッセージタイプ。

    10002

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "HasMore": false,
    "MessageList": [
      {
        "Data": "test",
        "GroupId": "AE35-****-T95F",
        "MessageId": "qt***",
        "SenderId": "yi***",
        "Type": 10002
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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