AddChatGroup API による IM グループの作成 - Chat App - Alibaba Cloud -

操作説明

重要 API を使用した IM グループの作成は、Meta によるクローズドベータテストの機能です。許可リストへの追加については、アカウントマネージャーにお問い合わせください。

この API の呼び出しによってのみ、IM グループを作成できます。
IM グループの作成後、AddChatGroupInviteLink API を呼び出して招待リンクを生成できます。
WhatsApp チャネルタイプの場合、IM グループのメンバー数は 8 名に制限されます。

今すぐお試しください

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

create

*すべてのリソース

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BusinessNumber	文字列	必須	ビジネスアカウントに関連付けられた電話番号です。	8613800***
Description	文字列	任意	グループの説明です。	This is a newly created group
Subject	文字列	任意	グループの件名です。	test
CustSpaceId	文字列	必須	ISV サブカスタマーの SpaceId またはインスタンス ID です。これはチャネル ID に相当します。チャネル管理ページで確認できます。	cams-***
ChannelType	文字列	任意	チャネルタイプです。有効な値： WHATSAPP 説明現在、WhatsApp チャネルタイプのみをサポートしています。	WHATSAPP
GroupLink	文字列	任意	WhatsApp グループへのリンクです。	https://chat.whatsapp.com/testgroup

レスポンスフィールド

フィールド	型	説明	例
レスポンスボディ	object
AccessDeniedDetail	文字列	アクセス拒否の詳細です。	None
UniqueCode	文字列	一意のリクエストコードです。	8938****
Message	文字列	レスポンスメッセージです。	None
RequestId	文字列	リクエストの一意の識別子です。	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	文字列	レスポンスステータスコードです。有効な値： `OK` ：リクエストは成功しました。その他のエラーコードについては、「エラーコード一覧」をご参照ください。	OK
Success	ブール値	API 呼び出しが成功したかどうかを示します。有効な値： true ：API 呼び出しは成功しました。 false ：API 呼び出しは失敗しました。	true

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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