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

:ListChatGroupParticipants

最終更新日:Jun 08, 2026

IM グループのメンバーを一覧表示します。

操作説明

重要 この操作は内部プレビュー機能です。アクセスをリクエストするには、アカウントマネージャーにお問い合わせください。
  • この操作を呼び出す前に、招待リンクを持つ IM グループを作成し、メンバーがそのリンクを使用して参加済みであることを確認してください。

  • IM グループを作成して招待リンクを追加するには、AddChatGroup API と AddChatGroupInviteLink 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cams:ListChatGroupParticipants

list

*すべてのリソース

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

BusinessNumber

文字列

必須

ビジネス番号。ListChatGroup API を呼び出してビジネス番号を取得できます。

8613800***

ChannelType

文字列

任意

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

  • WHATSAPP

説明

この操作は WhatsApp チャネルのみをサポートします。

WHATSAPP

GroupId

文字列

必須

グループ ID。ListChatGroup API を呼び出してグループ ID を取得できます。

EA939****

CustSpaceId

文字列

必須

直接の顧客向けのインスタンス ID、または ISV サブ顧客向けの SpaceId です。ID は [Channel Management] ページで確認できます。

cams-k***

Page

object

任意

ページング情報。

Size

integer

任意

ページサイズ。

20

Index

integer

任意

ページ番号。

1

レスポンスフィールド

フィールド

説明

object

AccessDeniedDetail

文字列

アクセス拒否の詳細。

None

Message

文字列

エラーメッセージ。

None

RequestId

文字列

リクエスト ID。

90E63D28-E31D-1EB2-8939-A94866411B2O

Data

object

レスポンスデータ。

Total

integer

参加者の総数。

8

List

配列<object>

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

object

グループメンバーに関する情報。

ParticipantNumber

文字列

グループメンバーの電話番号。

861382***

Code

文字列

リクエストのステータスコード。有効な値:

  • OK:リクエストが成功したことを示します。

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

OK

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true :リクエストが成功したことを示します。

  • false :リクエストが失敗したことを示します。

true

成功レスポンス

JSON 形式 JSON

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

エラーコード

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

変更履歴

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