DeleteChatGroupParticipants API で IM グループメンバーを一括削除 - Chat App - Alibaba Cloud -

操作説明

重要この操作は Meta のベータ機能です。ご利用の前に、アカウントマネージャーにご連絡いただき、アカウントを許可リストに追加するよう依頼してください。

この操作には、メンバーが招待リンク経由で参加した既存の 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:DeleteChatGroupParticipants

削除

* すべてのリソース

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BusinessNumber	文字列	必須	ビジネス番号。ビジネス番号は ListChatGroup API を呼び出すことで取得できます。	8613800**
ChannelType	文字列	任意	チャネルタイプ。有効な値： WHATSAPP 説明現在、WhatsApp チャネルのみがサポートされています。	WHATSAPP
GroupId	文字列	必須	グループ ID。グループ ID は ListChatGroup API を呼び出すことで取得できます。	EA93UU****
CustSpaceId	文字列	必須	ISV サブ顧客のスペース ID またはインスタンス ID。この ID はチャネル ID でもあります。チャネル ID は [Channel Management] ページで確認できます。	cams-**
List	配列 <オブジェクト>	任意	削除するグループメンバーのリスト。
	オブジェクト	任意	グループメンバーに関する情報。
ParticipantNumber	文字列	任意	グループメンバーの参加者番号。グループメンバーの参加者番号は ListChatGroupParticipants API を呼び出すことで取得できます。	86138***

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト
AccessDeniedDetail	文字列	アクセス拒否に関する詳細。	None
Message	文字列	応答メッセージ。	None
RequestId	文字列	リクエスト ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	文字列	ステータスコード。有効な値： OK：リクエストは成功しました。その他のエラーコードについては、「エラーコード一覧」をご参照ください。	OK
Success	ブール値	リクエストが成功したかどうかを示します。有効な値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。	true
Result	整数	影響を受けた行数。	20

例

成功レスポンス

JSONJSON

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": true,
  "Result": 20
}

エラーコード

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

変更履歴

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