ListLiveMessageGroupMessages でグループメッセージをクエリ - LIVE - Alibaba Cloud - ApsaraVideo Live

グループのメッセージリストを照会します。

操作説明

この操作を呼び出す前に、 CreateLiveMessageGroup を呼び出してインタラクティブなメッセージグループを作成しておく必要があります。

QPS 制限

この操作の単一ユーザー QPS 制限は、1 秒あたり 50 回の呼び出しです。制限を超えると API の呼び出しがスロットリングされ、ビジネスに影響が出る可能性があります。この操作は適切に呼び出してください。

今すぐお試しください

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

list

*Rtc

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	クエリするインタラクティブなメッセージアプリケーションの ID。	demo
GroupId	string	必須	クエリするグループのグループ ID。	grouptest
PageSize	integer	必須	一度に表示するメッセージ数。有効な値: [10,50]。	10
SortType	integer	必須	ソートタイプ。メッセージは送信時間でソートされます。有効な値: 1: 昇順 2: 降順列挙値: 1 : 昇順。 2 : 降順。	1
NextPageToken	integer	任意	クエリページの開始位置。このパラメーターが空の場合、デフォルトで最初のページが返されます。	1
MsgType	integer	任意	クエリするメッセージタイプ。このパラメーターが空の場合、デフォルトですべてのメッセージタイプが返されます。	1
BeginTime	integer	任意	クエリの開始時刻 (UNIX タイムスタンプ)。単位: 秒。このパラメーターが空の場合、デフォルトで最も古い時間が使用されます。	1697783235
EndTime	integer	任意	クエリの終了時間 (UNIX タイムスタンプ)。単位: 秒。このパラメーターが空の場合、デフォルトで最新の時間が使用されます。	1698301635
DataCenter	string	任意	データセンター。この値は CreateLiveMessageApp で指定されたデータセンターと一致している必要があります。現在サポートされているデータセンターは、上海 (cn-shanghai) とシンガポール (ap-southeast-1) です。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	1668FDC3-63D7-102F-B5D4-3D2F91D1****
GroupId	string	クエリするグループのグループ ID。	grouptest
NextPageToken	integer	次のページの開始位置。次のページがない場合、値は 0 です。	0
Hasmore	boolean	次のページがあるかどうかを示します。	false
MessageList	array<object>	メッセージリスト。
	array<object>	リストの詳細。
Sender	object	メッセージ送信者の詳細。
UserId	string	メッセージを送信したユーザーの ID。	uid2
UserInfo	string	メッセージを送信したユーザーに関する追加情報。	testusermeta2
Body	string	メッセージ本文。	step2 helo, cc group
Timestamp	integer	メッセージが作成された時間 (UNIX タイムスタンプ)。単位: 秒。	1697081134
MsgTid	string	メッセージ識別子。	c-1-1-0
MsgType	integer	メッセージタイプ。	2
SeqNumber	integer	メッセージシーケンス番号。	1
TotalMessages	integer	メッセージの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "MessageList": [
    {
      "Sender": {
        "UserId": "uid2",
        "UserInfo": "testusermeta2"
      },
      "Body": "step2 helo, cc group",
      "Timestamp": 1697081134,
      "MsgTid": "c-1-1-0",
      "MsgType": 2,
      "SeqNumber": 1,
      "TotalMessages": 1
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InputInvalid	%s.	入力パラメーターが無効です。
500	ServerError	%s.	不明なエラーが発生しました。後でもう一度お試しいただくか、チケットを送信してください。
403	NoAuth	%s.	必須の権限がありません。
404	ResourceNotExist	%s.	リクエストされたリソースが存在しません。リクエストを確認して再試行してください。

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

変更履歴

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