Infobip API を使用してWhatsAppを統合する

WhatsApp Business APIは、WhatsAppをコミュニケーションチャネルとして統合することで、企業がプログラムでメッセージを送受信できるようにするスケーラブルなソリューションです。WhatsAppを介して顧客と対話するための信頼性の高い方法を提供しながら、エンドツーエンドの暗号化を通じてデータ保護とコンプライアンスを維持します。

このガイドは、Infobip の API を使用して、メッセージの認証、構成、送信、配信の追跡、顧客とのやり取りの監視を行うのに役立ちます。

WhatsApp API APIでできること

WhatsApp Business APIを使用して、次のことを行います。

• メッセージテンプレートと自由形式メッセージを作成して送信します。
• 受信ユーザーメッセージを受信して応答します。
• 配信、確認されたステータス、ユーザーのアクションを追跡します。
• 主要なイベント(クリック、オプトイン、支払いなど)に登録します。
• エンゲージメント分析を使用して、テンプレートボタン内のURLを短縮して追跡します。

この API は、オンボーディングやトランザクション アラートから豊富な双方向のカスタマー サービスまで、フル サイクルの通信をサポートします。

認証と構成のセットアップ

メッセージの送受信を開始する前に、次の手順を実行します。

• API 認証 ガイド (opens in a new tab)を使用して統合を認証します。
• 設定の編集セクションで送信者の動作と受信メッセージのルーティングを設定します。
• 構成でグローバル Webhook URL を割り当てるか、notifyURL パラメーターを使用してメッセージごとにオーバーライドします。

イベント サブスクリプション

WhatsAppを使用する場合、サブスクリプションを使用すると、通信中の特定のイベントの通知を追跡および受信できます。メッセージ配信やユーザーとの対話などのこれらのイベントは、指定されたWebhookに送信される通知をトリガーし、WhatsAppメッセージの進行状況とステータスを監視するのに役立ちます。テンプレートが 特定の applicationID または 'エンティティ ID' になったら、テンプレートの更新を受信するサブスクリプションを作成できます。

WhatsAppの場合、次のイベントタイプを追跡できます。

イベント通知を設定するには、 サブスクリプション管理 API (opens in a new tab) を使用して、追跡するイベントと通知を受信する Webhook を指定するサブスクリプション ルールを定義できます。複数のサブスクリプションを作成して、さまざまなイベントを管理したり、通知をさまざまな Webhook にルーティングしたりできます。

詳細は、サブスクリプション管理のページを参照してください。

配信レポート

API を使用して、通信のパフォーマンスを追跡します。次のレポートは、定義されたエンドポイントに転送されます。

• 配信レポート (opens in a new tab)
• 既読メッセージレポート (opens in a new tab)

または、notifyURL パラメーターを使用して、各メッセージのエンドポイントを指定することもできます。これにより、個々のメッセージに対するメッセージ ステータス レポートの送信先をカスタマイズし、グローバル構成設定を上書きできます。

短縮とトラッキングを含む動的テンプレート ボタン URL

WhatsAppメッセージテンプレートは、次の2種類のボタンURLをサポートしています。

• 静的 URL: すべてのパラメーターを含め、Meta に完全に登録されています。
• 動的 URL: より柔軟です。ドメインを Meta に登録する必要がありますが、メッセージの送信時に Infobip WhatsApp API API を使用して入力されるプレースホルダー パラメーターを定義できます。

テンプレートには、最大 10 個のボタンを含めることができます。ただし、動的ボタンの URL は 2 つまでしか追加できません。

API 経由でテンプレートを作成する (opens in a new tab)ときに、動的ボタンの URL を短縮して追跡できます。

この機能を有効にするには、テンプレートの作成時に次のことを確認してください。

1. [登録](/URL 短縮/登録カスタムドメイン) カスタムドメイン。
2. shorteningOptions オブジェクトの下にドメインを追加します。
3. 動的 URL の場合は、パスをテンプレート構造内のプレースホルダーとして定義します。

テンプレートが登録され、送信する準備ができたら、次の操作を行います。

• 動的リンクの場合は、プレースホルダー値を定義し、urlOptionsの下にカスタムドメインを追加します。
• 静的リンクの場合、追加の設定は必要ありません。

各リンクには、メッセージの送信時に動的 ID が割り当てられます。これにより、Infobip は顧客のクリックを追跡できます。

URL短縮の設定の詳細については、URL短縮とトラッキングページを参照してください。

次のサンプルリクエストを使用して、追跡可能な短縮ボタンURLを持つWhatsAppメッセージ テンプレートを作成できます。

{
"name": "media_template_with_dynamic_url_button",
"language": "en",
"category": "MARKETING",
"structure": {
"body": {
"text": "bodycontent"
},
"buttons": [
{
  "text": "visit website",
  "url": "https://www.infobip.com/{{1}}",
  "example": "https://www.infobip.com/docs",
  "type": "URL"
}
],
"shorteningOptions": {
"customDomain": "client.customDomain.com"
},
"type": "MEDIA"
}
}

shorteningOptions オブジェクトは、追跡可能な短縮 URL を生成するために必要な customDomain プロパティを含む、テンプレートの URL 短縮設定を定義します。Infobip システムの外部でこのオブジェクトを変更すると、エラーが発生する可能性があるため、変更しないことをお勧めします。

同様に、追跡可能な短縮ボタンURLを含むテンプレートを送信することもできます。

{
  "messages": [
    {
      "from": "441134960000",
      "to": "441134960001",
      "messageId": "a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
      "content": {
        "templateName": "media_template_with_dynamic_url_button",
        "templateData": {
          "body": {
            "placeholders": []
          },
          "buttons": [
            {
              "type": "URL",
              "parameter": "docs"
            }
          ]
        },
        "language": "en"
      },
      "urlOptions": {
        "shortenUrl": true,
        "trackClicks": true,
        "trackingUrl": "https://client.customDomain.com/click-report",
        "customDomain": "client.customDomain.com"
      }
    }
  ]
}

アプリケーションとエンティティの割り当て

作成時、編集時、取得時にテンプレートにapplicationIDとentityIDを割り当てることができるため、特定のアプリケーションまたはエンティティに割り当てられたテンプレートを管理するプロセスを柔軟に行うことができます。

{
  "name": "text_template",
  "language": "en",
  "category": "MARKETING",
  "allowCategoryChange": false,
  "structure": {
    "body": {
      "text": "body {{1}} content",
      "examples": [
        "example"
      ]
    },
    "type": "TEXT"
  },
  "platform": {
    "entityId": "test-entity",
    "applicationID": "test-application"
  }
}

アプリケーションとエンティティの詳細については、アプリケーションとエンティティの管理 の記事を参照してください。