すべてのプロダクト
Search
ドキュメントセンター

ApsaraVideo Live:ListMessageGroupUserById

最終更新日:Jun 09, 2026

ListMessageGroupUserById API を呼び出して、ユーザー ID リストに基づいてユーザー情報を照会します。

操作説明

QPS 制限

この API の QPS 制限は、ユーザーあたり 1 秒あたり 100 クエリです。制限を超えると、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:ListMessageGroupUserById

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

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

VKL3***

GroupId

string

必須

メッセージグループ ID。

AE35-****-T95F

UserIdList

array

必須

照会するユーザーのリスト。

string

任意

ユーザー ID。

de1**a0

レスポンスフィールド

フィールド

説明

object

返されたレスポンス。

RequestId

string

リクエスト ID。

16A96B9A-****-CB92E68F4CD8

Result

object

API の呼び出し結果。

HasMore

boolean

さらに読み込むデータがあるかどうかを示します。有効な値は次のとおりです:

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

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

false

Total

integer

照会されたユーザーの合計数。

3

UserList

array<object>

返されたユーザー情報のリスト。

object

IsMute

boolean

ユーザーがミュートされているかどうか。有効な値は次のとおりです:

  • true:ミュートされています。

  • false:ミュートされていません。

true

MuteBy

array

ミュートのタイプ。有効な値は次のとおりです:

  • group:メッセージグループ内のすべてのメンバーがミュートされています。

  • user:個々のユーザーがミュートされています。

string

ミュートのタイプ。有効な値は次のとおりです:

  • group:メッセージグループ内のすべてのメンバーがミュートされています。

  • user:個々のユーザーがミュートされています。

user

UserAvatar

string

プロフィール画像の URL。

"http://www.aliyundoc.com/xxyy.png"

UserExtension

string

ユーザーのカスタム拡張情報。

12e

UserId

string

ユーザー ID。

ad***

UserNick

string

ユーザーニックネーム。

xxyy

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "HasMore": false,
    "Total": 3,
    "UserList": [
      {
        "IsMute": true,
        "MuteBy": [
          "user"
        ],
        "UserAvatar": "\"http://www.aliyundoc.com/xxyy.png\"",
        "UserExtension": "12e",
        "UserId": "ad***",
        "UserNick": "xxyy"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 MissingParam Parameter invalid.
403 NoAuth %s.

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

変更履歴

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