すべてのプロダクト
Search

このプロダクト

    :ListChatGroupParticipants

    ドキュメントセンター

    :ListChatGroupParticipants

    最終更新日:Jul 28, 2026

    IM グループのメンバーリストを取得します。

    操作説明

    重要 API を通じて IM グループのメンバーリストを取得する特徴は、Meta のベータ版特徴です。アクセスを申請するには、アカウントマネージャーにお問い合わせください。

    • この操作を呼び出す前に、作成した IM グループに招待リンクが追加されており、メンバーがそのリンクを通じて IM グループに参加していることを確認してください。

    • 作成済みの IM グループがない場合は、 AddChatGroup および AddChatGroupInviteLink 操作を使用して IM グループを作成し、招待リンクを追加してください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:ListChatGroupParticipants

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BusinessNumber

    string

    必須

    ビジネス電話番号。 ListChatGroup 操作を呼び出してビジネス電話番号を確認できます。

    8613800***
    ChannelType

    string

    任意

    チャンネルタイプ。有効な値:

    • WHATSAPP

    説明

    WhatsApp チャンネルタイプのみサポートされています。

    WHATSAPP。
    GroupId

    string

    必須

    グループ ID。 ListChatGroup 操作を呼び出してグループ ID を確認できます。

    EA939****
    CustSpaceId

    string

    必須

    ISV サブ顧客のスペース ID で、インスタンス ID でもあります。これはチャンネル ID であり、コンソールの チャンネル管理 ページで確認できます。

    cams-k***
    Page

    object

    任意

    ページネーション情報。

    Size

    integer

    任意

    1 ページあたりのエントリ数。

    20
    Index

    integer

    任意

    ページ番号。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    AccessDeniedDetail

    string

    アクセス拒否の詳細。

    None。
    Message

    string

    エラーメッセージ。

    None。
    RequestId

    string

    リクエスト ID。

    90E63D28-E31D-1EB2-8939-A94866411B2O
    Data

    object

    返されたデータ。

    Total

    integer

    レコードの総数。

    8
    List

    array<object>

    グループメンバーのリスト。

    object

    グループメンバー情報。

    ParticipantNumber

    string

    グループメンバー。

    861382***
    Code

    string

    リクエスト状態コード。有効な値:

    • OK: リクエストが成功しました。

    • その他のエラーコードについては、「エラーコード」をご参照ください。

    OK
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値:

    • true: 呼び出しが成功しました。

    • false: 呼び出しが失敗しました。

    true。

    例

    成功レスポンス

    JSONJSON

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 8,
    "List": [
      {
        "ParticipantNumber": "861382***"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

    エラーコード

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

    変更履歴

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