NTT CPaaS API を使用してWhatsAppを統合する
NTT CPaaSのWhatsApp Business API ↗は、WhatsAppを通信チャネルとして統合することで、企業がプログラムでメッセージを送受信できるようにするスケーラブルなソリューションであり、WhatsAppプラットフォーム要件を満たし、安全な通信をサポートします。
このガイドは、NTT CPaaS の API を使用して、メッセージの認証、構成、送信、配信の追跡、顧客とのやり取りの監視を行うのに役立ちます。
もっと詳しく知る完全なエンドポイント仕様、リクエストの例、および応答パラメーターについては、 NTT CPaaS WhatsApp API ドキュメント をご覧ください。
WhatsApp API APIでできること
WhatsApp Business API ↗ を使用して、次のことを行います。
- メッセージテンプレートと自由形式メッセージを作成して送信します。
- 受信ユーザーメッセージを受信して応答します。
- 配信、確認されたステータス、ユーザーのアクションを追跡します。
- 主要なイベント(クリック、オプトイン、支払いなど)に登録します。
- エンゲージメント分析を使用して、テンプレートボタン内のURLを短縮して追跡します。
この API は、オンボーディングやトランザクション アラートから豊富な双方向のカスタマー サービスまで、フル サイクルの通信をサポートします。
認証と構成のセットアップ
メッセージの送受信を開始する前に、次の手順を実行します。
- API 認証ガイドを使用して統合を認証します。
- 送信者動作とインバウンドメッセージルーティングは、構成の編集セクションで構成します。
- 構成でグローバル Webhook URL を割り当てるか、
notifyURLパラメーターを使用してメッセージごとにオーバーライドします。
イベント サブスクリプション [#event-subscription-message-templates]
WhatsAppを使用する場合、サブスクリプションを使用すると、通信中の特定のイベントの通知を追跡および受信できます。メッセージ配信やユーザーとの対話などのこれらのイベントは、指定されたWebhookに送信される通知をトリガーし、WhatsAppメッセージの進行状況とステータスを監視するのに役立ちます。テンプレートが 特定の applicationID または 'エンティティ ID' になったら、テンプレートの更新を受信するサブスクリプションを作成できます。
WhatsAppの場合、次のイベントタイプを追跡できます。
| イベントタイプ | 説明 |
|---|---|
ACCOUNT_REGISTRATION | アカウント登録が発生したときに通知します。また、このイベントを使用して、登録失敗の理由を追跡し、ビジネス ポートフォリオ ID を表示することもできます。 |
ACCOUNT_UPDATE_NOTIFICATION | WhatsApp Business アカウントの更新について通知します。 |
BILLING | アカウントの請求に関連する更新を提供します。 |
BUSINESS_APP_CONTACT_SYNC | WhatsApp Businessアプリが連絡先情報をNTT CPaaSと同期したときに通知します。 |
CLICK | ユーザーがメッセージ内のボタンまたはリンクをクリックしたときに追跡します。 |
DELIVERY | メッセージが受信者に正常に配信されたことを示します。 |
IDENTITY_CHANGE | エンドユーザーのWhatsApp IDが変更されたときに通知します。 |
INBOUND_MESSAGE | エンドユーザーから新しい受信メッセージを受信したときにアラートを発します。 |
MARKETING_SUBSCRIPTION_UPDATE | エンドユーザーがマーケティングメッセージの受信をオプトインまたはオプトアウトしたときに通知します。 |
PAYMENT_STATUS | 支払関連メッセージのステータスを監視します。 |
SEEN | 受信者がメッセージを見たことを確認します。 |
TEMPLATE_UPDATE | メッセージ テンプレートが変更されたときに更新を提供します。 |
イベント通知を設定するには、 サブスクリプション管理 API を使用して、追跡するイベントと通知を受信する Webhook を指定するサブスクリプション ルールを定義できます。複数のサブスクリプションを作成して、さまざまなイベントを管理したり、通知をさまざまな Webhook にルーティングしたりできます。
詳細は、[サブスクリプション管理]ページをご参照ください。
配信レポート
API を使用して、通信のパフォーマンスを追跡します。次のレポートは、定義されたエンドポイントに転送されます。
または、notifyURL パラメーターを使用して、各メッセージのエンドポイントを指定することもできます。これにより、個々のメッセージに対するメッセージ ステータス レポートの送信先をカスタマイズし、グローバル構成設定を上書きできます。
短縮とトラッキングを含む動的テンプレート ボタン URL
WhatsAppメッセージテンプレートは、次の2種類のボタンURLをサポートしています。
- 静的 URL: すべてのパラメーターを含め、Meta に完全に登録されています。
- 動的 URL: より柔軟です。ドメインを Meta に登録する必要がありますが、メッセージの送信時に NTT CPaaS WhatsApp API API を使用して入力されるプレースホルダー パラメーターを定義できます。
テンプレートには、最大 10 個のボタンを含めることができます。ただし、動的ボタンの URL は 2 つまでしか追加できません。
API 経由でテンプレートを作成するときに、動的ボタンの URL を短縮して追跡できます。
この機能を有効にするには、テンプレートの作成時に次のことを確認してください。
- 登録 カスタムドメイン。
shorteningOptionsオブジェクトの下にドメインを追加します。- 動的 URL の場合は、テンプレート構造内のURLの末尾にプレースホルダ(
{{1}}など)を追加します。
テンプレートが登録され、送信する準備ができたら、次の操作を行います。
- 動的リンクの場合は、プレースホルダー値を定義し、
urlOptionsの下にカスタムドメインを追加します。 - 静的リンクの場合、追加の設定は必要ありません。
各リンクには、メッセージの送信時に動的 ID が割り当てられます。これにより、NTT CPaaS は顧客のクリックを追跡できます。
URL短縮の設定の詳細については、URL短縮とトラッキングページを参照してください。
次のサンプルリクエストを使用して、追跡可能な短縮ボタンURLを持つWhatsAppメッセージ テンプレートを作成できます。
shorteningOptions オブジェクトは、追跡可能な短縮 URL を生成するために必要な customDomain プロパティを含む、テンプレートの URL 短縮設定を定義します。このオブジェクトをNTT CPaaSシステム外で変更すると、エラーが発生する可能性があるため、変更しないでください。
同様に、追跡可能な短縮ボタンURLを含むテンプレートを送信することもできます。
テンプレート メッセージ要求を送信する場合、customDomain はテンプレートの作成時に使用されたドメインと一致する必要があります。それ以外の場合、要求は失敗します。
アプリケーションとエンティティの割り当て [#application-and-entity-assignment-message-templates]
作成、編集、取得時にテンプレートにapplicationIdとentityIdを割り当てることができるため、特定のアプリケーションまたはエンティティに割り当てられたテンプレートを管理するプロセスを柔軟に行うことができます。
アプリケーションとエンティティの詳細については、「アプリケーションとエンティティの管理」の記事を参照してください。
サポートされているテンプレート言語
以下は、サポートされている言語とそれに対応する ISO コードの完全なリストです。 地域に違いがある言語の場合は、セクションを展開して、使用可能なすべてのコードを表示します。
その他の対応言語
このリストには、使用可能なコードが 1 つでサポートされている他のすべての言語が含まれています。
| 言語 | コード | 言語 | コード |
|---|---|---|---|
| アフリカーンス語 | af | アルバニア語 | 「スクエア」 |
| アゼルバイジャン語 | az | ベラルーシ語 | be_BY |
| ブルガリア語 | 'BG' | カタルーニャ語 | 「カ」 |
| クロアチア語 | hr | チェコ語 | cs |
| デンマーク語 | 「ダ」 | ダリ | prs_AF |
| エストニア語 | 'エット' | フィリピン語 | 'フィル' |
| フィンランド語 | 「フィ」 | グルジア語 | 「カ」 |
| ギリシャ語 | 「エル」 | グジャラート語 | 「グ」 |
| ハウサ語 | 「はぁ」 | ヘブライ語 | 「彼」 |
| ヒンディー語 | 「こんにちは」 | ハンガリー語 | 「フー」 |
| インドネシア語 | id | アイルランド語 | 「ガ」 |
| イタリア語 | 「それ」 | 日本語 | 「ジャ」 |
| カンナダ語 | kn | カザフ語 | kk |
| キニャルワンダ語 | rw_RW | 韓国語 | 「コ」 |
| キルギス(キルギス) | ky_KG | ラオス | 「ロー」 |
| ラトビア語 | lv | リトアニア語 | lt |
| マケドニアの | mk | マレー語 | ms |
| マラヤーラム語 | ml | マラーティー語 | 「ミスター」 |
| ノルウェー語 | 「注意」 | パシュトゥー語 | ps_AF |
| ペルシャ語 | 「ファ」 | ポーランド語 | pl |
| パンジャブ語 | 「パ」 | ルーマニア語 | 「ロ」 |
| ロシア語 | 「ル」 | セルビア語 | sr |
| シンハラ語 | si_LK | スロバキア語 | sk |
| スロベニア語 | sl | スワヒリ語 | 「SW」 |
| スウェーデン語 | sv | タミル語 | 「タ」 |
| テルグ語 | 「テ」 | タイ語 | th |
| トルコ語 | tr | ウクライナ語 | 「イギリス」 |
| ウルドゥー語 | 「あなたの」 | ウズベキスタン | 「ウズ」 |
| ベトナム語 | vi | ズールー語 | 「ズー」 |
NTT CPaaSソリューションでWhatsAppメッセージを送信する
ブロードキャスト、Moments、Conversations、または API を介してメッセージを送信します。
レポートとインサイト
配信、確認されたイベント、およびメッセージ分析を追跡します。
WhatsApp統合を管理する
メッセージング ウィンドウ、品質評価、メッセージング制限について説明します。