API 標準および多言語対応の SDK
本製品 (cams/2020-06-06) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
IMグループ管理
|
API |
タイトル |
説明 |
| AddChatGroup | AddChatGroup | IM グループを作成します。 |
| AddChatGroupInviteLink | IM グループの招待リンクを追加します。 | IM グループの招待リンクを追加します。 |
| DeleteChatGroupInviteLink | IM グループの招待リンクを削除します。 | IM グループの招待リンクを削除します。 |
| DeleteChatGroupParticipants | DeleteChatGroupParticipants | インスタントメッセージング (IM) グループからメンバーを削除します。 |
| ListChatGroupParticipants | IM グループメンバーリストの取得。 | IM グループのメンバーリストを取得します。 |
| ListChatGroup | IM グループのリストを取得します。 | IM グループのリストを取得します。 |
| UpdateChatGroup | IM グループ情報を変更します。 | IM グループの情報を変更します。 |
| DeleteChatGroup | IM グループの削除。 | 作成済みの IM グループを削除します。 |
Messengerマーケティングメッセージ
|
API |
タイトル |
説明 |
| SyncMessengerSubscriptionToken | カスタムオーディエンストークンの同期。 | Messenger サブスクリプショントークンを照会します。 |
| SyncMessageCampaign | SyncMessageCampaign | 予算を同期的に照会します。 |
| ListMessengerSubscriptionToken | ListMessengerSubscriptionToken | カスタムオーディエンスとサブスクリプショントークンのリストを照会します。 |
| ListMessageCampaign | ListMessageCampaign | 予算のリストを取得します。 |
| ListCustomAudience | ListCustomAudience | カスタムオーディエンスのリストを照会します。 |
| GetMessageCampaignInsights | GetMessageCampaignInsights | 予算メトリックをクエリできます。 |
| DeleteMessageCampaign | DeleteMessageCampaign | メッセンジャーメッセージを送信するマーケティングキャンペーンの予算を削除します。 |
| CreateMessageCampaign | CreateMessageCampaign | 予算を作成します。 |
| CreateCustomAudience | CreateCustomAudience | カスタムオーディエンスを作成します。 |
| AddCustomAudienceUser | AddCustomAudienceUser | カスタムオーディエンスにユーザーを追加します。 |
インスタンス/スペース管理
|
API |
タイトル |
説明 |
| ListInstance | インスタンスリストを照会します。 | インスタンスのリストを照会します。 |
| QueryInstance | QueryInstance | 指定されたインスタンスの詳細を取得します。 |
フローエディター
|
API |
タイトル |
説明 |
| TriggerChatFlow | Trigger an Online Flow | 手動トリガーを持つフローの公開バージョンをトリガーします。 |
WhatsAppフロー
|
API |
タイトル |
説明 |
| CreateFlow | フローを作成します。 | フローを作成します。 |
| ListFlow | フローリストの照会。 | フローのリストを照会します。 |
| GetFlow | フローの詳細を取得します。 | フローの詳細を取得します。 |
| SyncFlow | WhatsApp フローを同期します。 | WhatsApp フローを同期します。 |
| ModifyFlow | フローの基本情報を変更します。 | フローの基本情報を変更します。 |
| UpdateFlowJSONAsset | JSON を使用してフローのコンテンツを更新します。 | JSON を使用してフローのコンテンツを更新します。 |
| GetFlowJSONAssest | フローの JSON コンテンツを取得します。 | フローの JSON 形式のコンテンツを取得します。 |
| GetFlowPreviewUrl | フローのプレビュー URL を取得します。 | フローのプレビュー URL を取得します。 |
| PublishFlow | フローを公開します。 | フローを公開します。 |
| DeprecateFlow | フローを非推奨にします。 | フローを非推奨にします。 |
| DeleteFlow | フローを削除します。 | フローを削除します。DRAFT ステータスのフローのみ削除できます。 |
組み込み統合
|
API |
タイトル |
説明 |
| IsvGetAppId | アプリ ID の取得。 | ISV のアプリ ID を取得します。 |
| ChatappBindWaba | WABA のバインド。 | ノースバウンドインターフェイスを通じて WhatsApp Business Account (WABA) をバインドします。 |
| GetPermissionByCode | 埋め込みコードを使用して権限付与を取得します。 | 埋め込み統合から取得したコードを使用して権限付与を取得します。 |
| ChatappSyncPhoneNumber | 電話番号情報の同期。 | 電話番号情報を同期します。 |
| AddChatappPhoneNumber | WhatsApp 電話番号を追加します。 | WABA に電話番号を追加します。 |
| GetPhoneNumberVerificationStatus | 電話番号の認証ステータスを照会します。 | 電話番号の認証ステータスを取得します。 |
| GetChatappVerifyCode | GetChatappVerifyCode | ノースバウンド API を呼び出して CAPTCHA を取得します。 |
| ChatappVerifyAndRegister | 電話番号の検証と登録。 | 認証コードを検証し、ノースバウンドインターフェイスを通じて登録します。 |
| ChatappPhoneNumberRegister | 電話番号を登録します。 | ノースバウンドインターフェイスを通じて電話番号を登録します。 |
| ChatappPhoneNumberDeregister | WhatsApp 電話番号の登録を解除します。 | WABA から電話番号の登録を解除します。 |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | WhatsApp Business アカウント (WABA) のビジネス情報を照会します。 |
| UpdatePhoneWebhook | 電話番号のコールバック URL 情報を変更します。 | 電話番号のコールバック URL 情報を変更します。 |
| UpdateAccountWebhook | UpdateAccountWebhook | アカウントのコールバック URL を変更します。 |
| QueryPhoneBusinessProfile | 電話番号のビジネス情報を照会します。 | 電話番号のビジネス情報を照会します。 |
| ModifyPhoneBusinessProfile | 電話番号の商用情報を変更します。 | 電話番号の商用情報を変更します。 |
| CreateChatappMigrationInitiate | CreateChatappMigrationInitiate | 電話番号の移行を開始します。 |
| GetMigrationVerifyCode | 移行用電話番号の認証コードを取得します。 | 移行用電話番号の認証コードを取得します。 |
| ChatappMigrationVerified | 移行用の電話番号を検証します。 | 移行用の電話番号を検証します。 |
| ChatappMigrationRegister | 電話番号登録の移行。 | 電話番号登録を移行します。 |
| GetChatappUploadAuthorization | GetChatappUploadAuthorization | ファイルのアップロードに使用される認証情報を取得します。 |
| GetCommerceSetting | GetCommerceSetting | 電話番号のビジネス設定を照会します。 |
| UpdateCommerceSetting | UpdateCommerceSetting | 電話番号のコマース設定を更新します。 |
| SyncBusinessAppHistory | ビジネスアプリの履歴メッセージを同期します。 | ビジネスアプリの履歴レコードを同期します。 |
電話番号管理
|
API |
タイトル |
説明 |
| GetWhatsappHealthStatus | Get Whatsapp message send health status | さまざまなタイプのノードのメッセージングの正常性ステータスを照会します。 |
| UpdateConversationalAutomation | 電話番号のウェルカムメッセージ、会話の開始プロンプト、およびコマンドを変更します。 | 電話番号のウェルカムメッセージ、会話の開始プロンプト、およびコマンドを変更します。 |
| GetConversationalAutomation | Get number welcome messages, opening remarks, and commands | 歓迎メッセージ、開始の挨拶、およびコマンドを設定します。 |
| GetPhoneEncryptionPublicKey | 電話番号の暗号化公開鍵を取得します。 | 電話番号の暗号化公開鍵を取得します。 |
| UpdatePhoneEncryptionPublicKey | 電話番号の暗号化公開鍵を更新します。 | 電話番号の暗号化公開鍵を更新します。 |
| UpdatePhoneMessageQrdl | メッセージ QR コードの変更。 | メッセージ QR コードを変更します。 |
| ListPhoneMessageQrdl | メッセージ QR コードリストの照会。 | メッセージ QR コードのリストを照会します。 |
| DeletePhoneMessageQrdl | メッセージ QR コードの削除。 | メッセージ QR コードを削除します。 |
| CreatePhoneMessageQrdl | メッセージ QR コードを作成します。 | メッセージ QR コードを作成します。 |
| QueryChatappPhoneNumbers | QueryChatappPhoneNumbers | 顧客のメッセージ送信に使用されるすべての電話番号とそのステータスを照会します。 |
| QueryChatappBindWaba | QueryChatappBindWaba | 顧客アカウントにバインドされている WhatsApp Business Account (WABA) を照会します。 |
| UpdateWhatsappUserName | WhatsApp ビジネス電話番号のユーザー名を更新します。 | ビジネス電話番号の WhatsApp ユーザー名を更新します。 |
| DeleteWhatsappUserName | WhatsApp ビジネス電話番号のユーザー名を削除します。 | ビジネス電話番号の WhatsApp ユーザー名を削除します。 |
| GetWhatsappUserName | WhatsApp ビジネス電話番号のユーザー名を取得します。 | ビジネス電話番号の WhatsApp ユーザー名を取得します。 |
| GetWhatsappUserNameSuggestions | WhatsApp ビジネス電話番号の推奨ユーザー名を取得します。 | WhatsApp ビジネス電話番号の推奨ユーザー名を取得します。 |
メッセージ送信
|
API |
タイトル |
説明 |
| SendChatappMassMessage | チャットアプリメッセージをバッチで送信します。 | Chat App メッセージをバッチで送信します。 |
| SendChatappMessage | チャット App メッセージを送信します | Chat App Message Service のメッセージを送信します。 |
| WhatsappCall | WhatsappCall | WhatsApp の音声通話を発信・応答・終了します。 |
テンプレート管理
|
API |
タイトル |
説明 |
| CreateChatappTemplate | チャットアプリテンプレートを作成します。 | メッセージテンプレートを作成します。テンプレートが承認されると、メッセージの送信に使用できます。 |
| ModifyChatappTemplate | チャットアプリテンプレートの変更。 | メッセージテンプレートを変更します。変更済みできるのは、審査未完了または審査に失敗したテンプレートのみです。 |
| ListChatappTemplate | チャットアプリのメッセージテンプレートリストを照会します。 | メッセージテンプレートのリストを取得します。 |
| GetChatappTemplateDetail | チャットアプリメッセージテンプレートの詳細を照会します。 | Chat App Message サービスのメッセージテンプレートの詳細を取得します。 |
| DeleteChatappTemplate | DeleteChatappTemplate | メッセージテンプレートを削除します。 |
| CheckDirectSendMessageSample | WhatsApp ダイレクト送信テンプレートコンテンツの検証。 | WhatsApp ダイレクト送信テンプレートのコンテンツを検証します。 |
| GetAutoGeneratedTemplate | GetAutoGeneratedTemplate | 自動生成されたテンプレートを取得します。 |
| ArchiveChatappTemplate | テンプレートのアーカイブ | Chat App Message サービスのテンプレートをアーカイブします。現在、アーカイブをサポートしているのは WhatsApp テンプレートのみです。 |
製品カタログ
|
API |
タイトル |
説明 |
| ListProductCatalog | プロダクトカタログの一覧表示。 | Meta Business プラットフォームのカタログリストを照会します。 |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | WhatsApp Business アカウント (WABA) に関連付けられている製品カタログを照会します。 |
| ListProduct | ListProduct | カタログ内のプロダクトのリストをクエリします。 |
統計メトリクス
|
API |
タイトル |
説明 |
| GetChatappPhoneNumberMetric | 電話番号の送信ボリュームメトリックを照会します。 | WhatsApp チャンネルの電話番号のメッセージ送信ボリュームメトリックを照会します。 |
| EnableWhatsappROIMetric | WhatsApp ROI メトリックコレクションの有効化。 | WhatsApp 関連のメトリックコレクションを有効にします。 |
| GetChatappTemplateMetric | マーケティングテンプレートのメトリックを取得します。 | マーケティングタイプテンプレートに関連するメトリックを取得します。 |
| RequestWhatsappConversionApi | WhatsApp Conversions API をリクエストします | WhatsApp Conversions API にリクエストを送信します。 |
その他
|
API |
タイトル |
説明 |
| ListChatappMessage | メッセージリストの照会。 | メッセージリストを照会します。 |
| GetPreValidatePhoneId | GetPreValidatePhoneId | 事前登録された電話番号の ID を取得します。この ID を使用して、新しい確認コードを取得せずに、埋め込みシナリオで番号を選択します。 |
| CreateChatFlow | フローを作成します。 | フローを作成します。 |
| CreateChatFlowByImport | フローを作成してインポートします。 | フローを作成してインポートします。 |
| CreateChatFlowLogSetting | フローログ設定を作成します。 | フローログ設定を作成します。 |
| CreateFlowVersion | フローバージョンを作成します。 | 既存のフローバージョンをコピーして、新しいフローバージョンを作成します。 |
| DeleteChatFlow | フローを削除します。 | フローを削除します。 |
| DeleteFlowVersion | フローバージョンを削除します。 | フローバージョンを削除します。 |
| FlowBindPhone | フローに電話番号またはマーチャントアカウント ID をバインドします。 | フローに電話番号またはマーチャントアカウント ID をバインドします。 |
| FlowRebindPhone | フローに電話番号またはマーチャントアカウント ID を再バインドします。 | フローに電話番号またはマーチャントアカウント ID を再バインドします。 |
| FlowUnbindPhone | フローから電話番号またはマーチャントアカウント ID の関連付けを解除します。 | フローから電話番号またはマーチャントアカウント ID の関連付けを解除します。 |
| GetChatFlowTemplate | フローテンプレートの詳細を照会します。 | フローテンプレートの詳細を照会します。 |
| ListBindingRelationsForFlowVersion | バインドされている電話番号またはビジネスアカウント ID を照会します。 | フローコードに基づいて、フローにバインドされている電話番号またはビジネスアカウント ID のリストを照会します。 |
| ListChatFlow | フローの一覧表示。 | フローの一覧を表示します。 |
| ListChatFlowTemplate | フローテンプレートのリストを照会します。 | フローテンプレートのリストを照会します。 |
| ListFlowNodePrototypeV2 | フローコンポーネントのプロトタイプを一覧表示します。 | フローコンポーネントのプロトタイプを一覧表示します。 |
| ListFlowVersion | フローバージョンの一覧を取得します。 | フローバージョンの一覧を取得します。 |
| OfflineFlowVersion | フローバージョンをオフラインにします | フローバージョンをオフラインにします。 |
| OnlineFlowVersion | フローバージョンを公開します。 | フローバージョンを公開します。 |
| ReadChatFlow | フローの詳細を取得します。 | フローの詳細を取得します。 |
| ReadChatFlowLogSetting | フローログ設定の表示。 | フローログの設定を照会します。 |
| ReadFlowVersion | フローバージョンの取得。 | フローバージョンを取得します。 |
| UpdateChatFlow | フローの基本情報を更新します。 | フローコードに基づいてフローの基本情報を更新します。 |
| UpdateChatFlowLogSetting | フローログの設定を更新します。 | フローログの設定を更新します。 |
| UpdateContactById | 連絡先情報を更新します。 | 連絡先を変更します。 |
| UpdateFlowVersion | フローバージョンの DSL データを更新します。 | フローバージョンの DSL データを更新します。キャンバス上のフローバージョンの更新に使用されます。 |
| GetChatappPhoneNumberSetting | ChatApp 電話番号の設定を取得します。 | ChatApp 電話番号のその他の設定を取得します。 |
| BeeBotAssociate | Chatbot 関連付け。 | ユーザー入力に基づいてナレッジベースから関連する FAQ を取得します。 |
| BeeBotChat | Chatbot の会話を開始します。 | 一意の Chatbot 識別子 (Chatbot ID) を使用して、Chatbot との会話を開始します。 |
| ChatappEmbedSignUp | 組み込みエントリー。 | ノースバウンドの組み込みインターフェイスを提供します。組み込み SDK を呼び出す際は v2 バージョンを使用し、この操作は無視してください。 |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | 独立系ソフトウェアベンダー (ISV) の顧客の契約情報を送信します。 |
| AddAddressRecoverSuspend | 送信先の変更、再開、または一時停止。 | 送信先の変更、再開、または一時停止のリクエストを送信します。 |
| AddAuditViberOpen | AddAuditViberOpen | Viber アカウントに登録します。 |
| AddContacts | 連絡先を追加。 | 連絡先を編集します - 連絡先を追加します。 |
| AddGroup | グループを追加します。 | グループを追加します。 |
| AddMarketingFlow | キャンペーンを作成します。 | キャンペーンを作成します。 |
| BindInstagramPage | ページをインスタンスに関連付けます。 | ページをインスタンスに関連付けます。 |
| BindMessengerPage | Messenger ページをバインドします。 | 選択した pageId をバインドします。 |
| CopyTemplate | テンプレートをコピーします | テンプレートをコピーします。 |
| CreateWhatsappConversionApi | 埋め込みコードによる pageId の取得。 | 埋め込みコードに基づいて pageId を取得および保存します。 |
| DeleteContactsByIds | 連絡先の一括削除。 | 連絡先を選択して削除します。 |
| DeleteGroupById | グループを削除します。 | グループを削除します。 |
| DeleteInstagramPage | Instagram ページを削除します。 | Instagram インスタンスからページを削除します。 |
| DeleteMarketingFlow | マーケティングキャンペーンを削除します。 | マーケティングキャンペーンを削除します。 |
| DeleteMessengerPage | Messenger パブリックページを削除します。 | Messenger ページを削除します。 |
| GeneratePresignedUrl | 一時的な URL を取得します。 | 一時的な URL を取得します。 |
| GetAuditRequestByTypeUnAudit | 審査待ちチケットのビュー。 | タイプ別に個人用の審査待ちチケットを照会します。 |
| GetChatappOpenStatus | ChatApp の有効化ステータスを照会します。 | ChatApp の有効化ステータスを照会します。 |
| GetCustomerSite | 顧客のソースサイトを照会します。 | 顧客のソースサイトを照会します。 |
| GetDownloadExcelList | Excel データのダウンロード。 | Excel データをダウンロードします。 |
| GetFbInstagramPages | Instagram パブリックページリスト。 | インスタンスの Instagram ページリストを取得します。 |
| GetFbMessengerPages | Messenger パブリックページを一覧表示します。 | Facebook ページ ID のリストを取得します。 |
| GetGroupExist | グループ名の重複を確認します。 | グループ名が既に存在するかどうかを照会します。 |
| GetPledgeTemplateAddress | 保証状テンプレートのダウンロード URL。 | 保証状テンプレートのダウンロード URL を取得します。 |
| GetViberByRequestNo | GetViberByRequestNo | requestNo に基づいてアプリケーションを取得します。 |
| GetViberPauseTimes | Viber の利用可能な一時停止リクエスト数を照会します。 | 一時停止をリクエストできる回数を照会します。 |
| GetWhatsappConversionApi | 埋め込み権限付与の取得。 | 埋め込み権限付与ページを取得します。 |
| ListAllGroups | グループリストの照会。 | グループのリストを照会します。 |
| ListFacebookPosts | Facebook 投稿のリストを照会します。 | Facebook 投稿のリストを照会します。 |
| ListFlowNodeGroup | フローコンポーネントグループのリストを照会します。 | フローコンポーネントグループのリストを照会します。 |
| ListInstagramPage | Instagram パブリックページの一覧表示。 | インスタンスに関連付けられた Instagram ページを取得します。 |
| ListInstagramPosts | Instagram 投稿の一覧表示。 | Instagram 投稿のリストを照会します。 |
| ListMarketingFlow | マーケティングキャンペーンリストの照会。 | マーケティングキャンペーンのリストを照会します。 |
| ListViberServiceMessage | Viber サービス番号情報の表示。 | アプリケーションフォームの Viber サービス番号カードを表示します。 |
| MoveContactToGroup | 連絡先グループの変更。 | 連絡先のグループ関連付けを変更します。 |
| OpenChatappService | Chat App Message サービスを有効化します | Chat App Message サービスを有効化します。 |
| PauseMarketingFLow | キャンペーンを一時停止します。 | サービスを一時停止します。 |
| RemoveContactById | 単一の連絡先を削除します。 | 現在のグループから単一の連絡先を削除します。 |
| UpdateAuditRequest | UpdateAuditRequest | Viber リクエストを変更します。 |
| UpdateGroupName | グループ名の変更。 | グループ名を変更します。 |
| UpdateMarketingFLow | キャンペーン情報を変更します。 | キャンペーン情報を変更します。 |
| ChangeResourceGroup | リソースをリソースグループに移動します。 | リソースを別のリソースグループに移動します。 |
| CreateInstance | CreateInstance | インスタンスを作成します。 |
| DeleteContacts | 連絡先を削除します。 | 連絡先リストから連絡先を削除します。 |
| DeleteInstance | DeleteInstance | 指定されたインスタンスを削除します。 |
| ListWhatAppTemplate | ListWhatAppTemplate | メッセージテンプレートの一覧を取得します。 |
| UpdateInstance | UpdateInstance | 指定されたインスタンスを更新します。 |
| SubmitVerifyCodeResult | 検証コード結果を送信します | 検証コードチェックの結果を送信します。 |
| BindDmAccount | DM アカウントを関連付けます。 | DM アカウントを関連付けます。 |
| CreateMessengerPage | 埋め込みメッセンジャーの権限付与。 | 埋め込みメッセンジャーを権限付与します。 |
| GetChatFlowMetric | ChatFlow のランタイムデータを取得します。 | ChatFlow のランタイムデータを取得します。 |
| ListBindDmAccount | バインドされたメールボックスアカウントの照会。 | バインドされた DM アカウントを照会します。 |
| ListDmAccount | DirectMail アカウントの照会。 | Alibaba Cloud アカウント配下の DirectMail アカウントを照会します。 |
| ListDmTag | DirectMail タグリストの照会。 | DirectMail のタグを照会します。 |
| ListPageAdAccount | ページの広告アカウントを照会します。 | ページにバインドされた広告アカウントのリストを照会します。 |
| ModifyChatappTemplateProperties | テンプレートプロパティの変更。 | テンプレートの一部のプロパティを変更します。 |
| QueryMMLActive | MML ステータスの照会。 | マーケティングメッセージが有効かどうかを照会します。 |
| UnbindDmAccount | DM アカウントのバインドを解除します。 | メールアカウントのバインドを解除します。 |
| UpdateWabaMmlStatus | MML 埋め込み完了後の MML ステータスの更新。 | WABA の MML ステータスを更新します。 |