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 ペア
オーディエンスグループ管理
|
API |
タイトル |
説明 |
| AddChatGroup | AddChatGroup | IM グループを作成します。 |
| AddChatGroupInviteLink | AddChatGroupInviteLink | インスタントメッセージング (IM) グループの招待リンクを追加します。 |
| DeleteChatGroupInviteLink | DeleteChatGroupInviteLink | IM グループの招待リンクを削除します。 |
| DeleteChatGroupParticipants | DeleteChatGroupParticipants | インスタントメッセージング (IM) グループからメンバーを削除します。 |
| ListChatGroup | ListChatGroup | IM グループの一覧を取得します。 |
| UpdateChatGroup | UpdateChatGroup | IM チャットグループの情報を更新します。 |
| DeleteChatGroup | DeleteChatGroup | インスタントメッセージング (IM) グループを削除します。 |
Messenger マーケティングメッセージ
|
API |
タイトル |
説明 |
| SyncMessengerSubscriptionToken | SyncMessengerSubscriptionToken | Messenger サブスクリプショントークンを取得します。 |
| SyncMessageCampaign | SyncMessageCampaign | 予算を同期的に照会します。 |
| ListMessengerSubscriptionToken | ListMessengerSubscriptionToken | カスタムオーディエンスとサブスクリプショントークンのリストを照会します。 |
| ListMessageCampaign | ListMessageCampaign | 予算のリストを取得します。 |
| ListCustomAudience | ListCustomAudience | カスタムオーディエンスのリストを照会します。 |
| ListChatGroupParticipants | ListChatGroupParticipants | インスタントメッセージング (IM) グループのメンバーリストを取得します。 |
| GetMessageCampaignInsights | GetMessageCampaignInsights | 予算メトリックをクエリできます。 |
| DeleteMessageCampaign | DeleteMessageCampaign | メッセンジャーメッセージを送信するマーケティングキャンペーンの予算を削除します。 |
| CreateMessageCampaign | CreateMessageCampaign | 予算を作成します。 |
| CreateCustomAudience | CreateCustomAudience | カスタムオーディエンスを作成します。 |
| AddCustomAudienceUser | AddCustomAudienceUser | カスタムオーディエンスにユーザーを追加します。 |
Whatsapp Flow
|
API |
タイトル |
説明 |
| ListInstance | ListInstance | インスタンスの一覧を取得します。 |
| QueryInstance | QueryInstance | 指定されたインスタンスの詳細を取得します。 |
| ListInstance | ListInstance | インスタンスの一覧を取得します。 |
| QueryInstance | QueryInstance | 指定されたインスタンスの詳細を取得します。 |
| UpdateInstance | UpdateInstance | 指定されたインスタンスを更新します。 |
Embedded Signup 関連 API
|
API |
タイトル |
説明 |
| TriggerChatFlow | Trigger an Online Flow | 手動トリガーを持つフローの公開バージョンをトリガーします。 |
電話番号管理
|
API |
タイトル |
説明 |
| CreateFlow | CreateFlow | フローを作成します。 |
| ListFlow | ListFlow | この操作は、フローの一覧をクエリします。 |
| GetFlow | GetFlow | WhatsApp フローの詳細情報を取得します。 |
| ModifyFlow | ModifyFlow | フローを変更します。 |
| UpdateFlowJSONAsset | UpdateFlowJSONAsset | JSON を使用して Flow のコンテンツを更新します。 |
| GetFlowJSONAssest | GetFlowJSONAssest | JSON 形式でフローのコンテンツを取得します。 |
| GetFlowPreviewUrl | GetFlowPreviewUrl | フローのプレビュー URL を取得します。 |
| PublishFlow | PublishFlow | フローを公開します。 |
| DeprecateFlow | DeprecateFlow | フローを廃止します。 |
| DeleteFlow | DeleteFlow | フローを削除します。フローは、DRAFT 状態の場合にのみ削除できます。 |
メッセージ送信
|
API |
タイトル |
説明 |
| IsvGetAppId | IsvGetAppId | 独立系ソフトウェアベンダー (ISV) の App ID を取得します。 |
| ChatappBindWaba | ChatappBindWaba | WhatsApp Business Account (WABA) をバインドします。 |
| GetPermissionByCode | GetPermissionByCode | 埋め込みコードを使用して、付与された権限を取得します。 |
| ChatappSyncPhoneNumber | ChatappSyncPhoneNumber | 電話番号を同期します。 |
| AddChatappPhoneNumber | AddChatappPhoneNumber | WhatsApp Business Account (WABA) に電話番号を追加します。 |
| GetPhoneNumberVerificationStatus | GetPhoneNumberVerificationStatus | 電話番号の検証ステータスを取得します。 |
| GetChatappVerifyCode | GetChatappVerifyCode | ノースバウンド API を呼び出して CAPTCHA を取得します。 |
| ChatappVerifyAndRegister | ChatappVerifyAndRegister | 電話番号を WhatsApp Business アカウント (WABA) に関連付けます。 |
| ChatappPhoneNumberRegister | ChatappPhoneNumberRegister | ノースバウンドインターフェイスの登録番号です。 |
| ChatappPhoneNumberDeregister | ChatappPhoneNumberDeregister | WhatsApp Business Account ( WABA ) から電話番号の登録を解除します。 |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | WhatsApp Business アカウント (WABA) のビジネス情報を照会します。 |
| UpdatePhoneWebhook | UpdatePhoneWebhook | 返される HTTP ステータスコード。 \\* 値が OK の場合、呼び出しは成功です。 \\* その他の値は、呼び出しが失敗したことを示します。詳細については、「エラーコード」をご参照ください。 |
| UpdateAccountWebhook | UpdateAccountWebhook | アカウントのコールバック URL を変更します。 |
| QueryPhoneBusinessProfile | QueryPhoneBusinessProfile | 電話番号のビジネス情報を照会します。 |
| ModifyPhoneBusinessProfile | ModifyPhoneBusinessProfile | リクエストの ID。 |
| CreateChatappMigrationInitiate | CreateChatappMigrationInitiate | 電話番号の移行を開始します。 |
| GetMigrationVerifyCode | GetMigrationVerifyCode | 電話番号移行の検証コードを取得します。 |
| ChatappMigrationVerified | ChatappMigrationVerified | 移行用の電話番号を検証します。 |
| ChatappMigrationRegister | ChatappMigrationRegister | 移行のために電話番号を登録します。 |
| GetChatappUploadAuthorization | GetChatappUploadAuthorization | ファイルのアップロードに使用される認証情報を取得します。 |
| GetCommerceSetting | GetCommerceSetting | 電話番号のビジネス設定を照会します。 |
| UpdateCommerceSetting | UpdateCommerceSetting | 電話番号のコマース設定を更新します。 |
テンプレート管理
|
API |
タイトル |
説明 |
| GetWhatsappHealthStatus | Get Whatsapp message send health status | さまざまなタイプのノードのメッセージングの正常性ステータスを照会します。 |
| UpdateConversationalAutomation | Change the number welcome message, opening remarks, and commands | 電話番号のウェルカムメッセージ、開始の挨拶、コマンドを変更します。 |
| GetConversationalAutomation | Get number welcome messages, opening remarks, and commands | 歓迎メッセージ、開始の挨拶、およびコマンドを設定します。 |
| GetPhoneEncryptionPublicKey | Obtain the encrypted public key of the number | 電話番号の暗号化公開鍵を取得します。 |
| UpdatePhoneEncryptionPublicKey | Update the encrypted public key of the number | 電話番号の暗号化公開鍵を更新します。 |
| UpdatePhoneMessageQrdl | Modify message QR code | メッセージ QR コードを更新します。 |
| ListPhoneMessageQrdl | Query message QR code list | メッセージ QR コードの一覧をクエリします。 |
| DeletePhoneMessageQrdl | Delete message QR code | メッセージ QR コードを削除します。 |
| CreatePhoneMessageQrdl | Create message QR code | メッセージ QR コードを作成します。 |
| QueryChatappPhoneNumbers | QueryChatappPhoneNumbers | 顧客のメッセージ送信に使用されるすべての電話番号とそのステータスを照会します。 |
| QueryChatappBindWaba | QueryChatappBindWaba | 顧客アカウントにバインドされている WhatsApp Business Account (WABA) を照会します。 |
製品カタログ
|
API |
タイトル |
説明 |
| SendChatappMassMessage | SendChatappMassMessage | 一括メッセージ送信を行います。 |
| SendChatappMessage | SendChatappMessage | ChatApp メッセージを送信します。 |
| WhatsappCall | WhatsappCall | WhatsApp の音声通話を発信・応答・終了します。 |
統計メトリック
|
API |
タイトル |
説明 |
| CreateChatappTemplate | CreateChatappTemplate | メッセージテンプレートを作成します。テンプレートが承認された後、メッセージの送信に使用できます。 |
| ModifyChatappTemplate | ModifyChatappTemplate | メッセージテンプレートのコードです。 |
| ListChatappTemplate | ListChatappTemplate | メッセージテンプレートを照会します。 |
| GetChatappTemplateDetail | GetChatappTemplateDetail | メッセージテンプレートの情報を照会します。 |
| DeleteChatappTemplate | DeleteChatappTemplate | メッセージテンプレートを削除します。 |
その他
|
API |
タイトル |
説明 |
| ListProductCatalog | ListProductCatalog | Meta のビジネス マネージャー プラットフォーム上の製品カタログを照会します。 |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | WhatsApp Business アカウント (WABA) に関連付けられている製品カタログを照会します。 |
| ListProduct | ListProduct | カタログ内のプロダクトのリストをクエリします。 |
その他
|
API |
タイトル |
説明 |
| GetChatappPhoneNumberMetric | GetChatappPhoneNumberMetric | WhatsApp チャンネルの電話番号のメッセージ送信メトリックをクエリします。 |
| EnableWhatsappROIMetric | EnableWhatsappROIMetric | WhatsApp メトリックの統計を有効にします。 |
| GetChatappTemplateMetric | GetChatappTemplateMetric | マーケティングテンプレートのメトリックをクエリします。 |
その他
|
API |
タイトル |
説明 |
| GetPreValidatePhoneId | GetPreValidatePhoneId | 事前登録された電話番号の ID を取得します。この ID を使用して、新しい確認コードを取得せずに、埋め込みシナリオで番号を選択します。 |
| ChatappEmbedSignUp | ChatappEmbedSignUp | 埋め込みソフトウェア開発キット（SDK）の v2 を使用している場合、この埋め込み API は不要です。 |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | 独立系ソフトウェアベンダー (ISV) の顧客の契約情報を送信します。 |
| AddAuditViberOpen | AddAuditViberOpen | Viber アカウントに登録します。 |
| GetViberByRequestNo | GetViberByRequestNo | requestNo に基づいてアプリケーションを取得します。 |
| UpdateAuditRequest | UpdateAuditRequest | Viber リクエストを変更します。 |
| CreateInstance | CreateInstance | インスタンスを作成します。 |
| DeleteInstance | DeleteInstance | 指定されたインスタンスを削除します。 |
| ListWhatAppTemplate | ListWhatAppTemplate | メッセージテンプレートの一覧を取得します。 |