ログイン無料トライアルを開始
Meta Tech Provider

WhatsApp の通話 Webhook: Calling API のイベントと Coexistence 番号での通話

calls Webhook フィールドは、WhatsApp Business Calling API のイベントを報告します。SDP のアンサーまたはオファーを伴う接続、RINGING、ACCEPTED、REJECTED の通話ステータス、COMPLETED または FAILED と通話時間を伴う終了、そして call_recording_available と call_transcription_available です。Meta の Coexistence ガイドによると、音声通話とビデオ通話は WhatsApp Business アプリでは変わらず、Cloud API ではサポートされていません。そのため、これらの通話は電話で受けることになります。

easyCoexistence は、WhatsApp Business アプリの番号を、Coexistence を通じて Meta の Cloud API に接続します。

Not supported

Cloud API で、WhatsApp Business アプリで登録された番号の音声通話とビデオ通話。アプリでは変わりません。

2,000

ユニークな受信者数で数えた、1 日あたりのメッセージ送信上限の最小値。番号が Calling API を使うために必要です。

7 days

通話の録音と文字起こしが、その Webhook の配信後にダウンロード可能な期間。

wacid

通話 id の接頭辞。通話の接続、ステータス、終了の各 Webhook を結びつける値です。

whatsapp_business_messaging

calls Webhook を受け取るためにアプリに必要な権限。メッセージの場合と同じです。

calls Webhook フィールドは何を報告しますか?

Calling API で発信または受信した通話に起きることすべてを、段階ごとのイベントとして 1 つのフィールドで報告します。企業側から発信した通話では、接続イベント、ステータス更新、終了イベントが発生します。SIP 経由で処理された通話では、接続イベントの代わりに call_created が報告され、SDP セッションは含まれません。関連するイベントが 1 つ別のフィールドにあります。顧客が通話許可リクエストに応答すると、その返信は messages フィールドに、タイプ call_permission_reply のインタラクティブメッセージとして届きます。

connectThe call is ready to connect; session carries the SDP to apply to your WebRTC stack.
call_createdA SIP call was attempted, business- or user-initiated.
statuses (type call)RINGING, ACCEPTED or REJECTED for a business-initiated call.
terminateThe call ended: status COMPLETED or FAILED, with times and duration when answered.
call_recording_availableA media id for the finished audio recording.
call_transcription_availableA media id for the transcript, a JSON document.

calls Webhook はどのような形ですか?

他の WhatsApp Webhook と同じエンベロープで、value の下に calls 配列があり、field は calls に設定されます。direction は BUSINESS_INITIATED か USER_INITIATED を示し、from と to には電話番号が入ります。to_user_id は顧客の BSUID で、ユーザー名を使う顧客の場合は、どちらの番号も欠けることがあります。metadata.phone_number_id は、他のフィールドと同じく自社の番号を示します。以下は Meta の Call Connect の例で、プレースホルダーは Meta の表記のままです。

Meta's example: the Call Connect webhook
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "16315553601",
              "phone_number_id": "<PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<CALLEE_NAME>",
                  "username": "<USERNAME>"
                },
                "wa_id": "16315553602",
                "user_id": "<BSUID>",
                "parent_user_id": "<PARENT_BSUID>"
              }
            ],
            "calls": [
              {
                "id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
                "to": "16315553601",
                "to_user_id": "<BSUID>",
                "to_parent_user_id": "<PARENT_BSUID>",
                "from": "16315553602",
                "event": "connect",
                "timestamp": "1671644824",
                "direction": "BUSINESS_INITIATED",
                "session": {
                  "sdp_type": "answer",
                  "sdp": "<<RFC 8866 SDP>>"
                }
              }
            ]
          },
          "field": "calls"
        }
      ]
    }
  ]
}

terminate イベントでは、どのフィールドが追加されますか?

terminate は通話を終了させるため、多くのシステムが保存するイベントです。Meta のリファレンスによる、そのフィールドは次のとおりです。

  • status: 予期しないエラーなく終了した場合は COMPLETED(応答のない通話も含む)。接続できなかった、または途中で切れた場合は FAILED。
  • start_time、end_time と秒単位の duration: 相手が応答したときだけ含まれます。
  • errors: FAILED の通話では code、message、href、error_data.details を含みます。
  • biz_opaque_callback_data: 通話の発信または応答時に渡した場合の、自社の追跡用文字列です。

Coexistence 番号で calls Webhook は機能しますか?

Meta の Coexistence ガイドは、機能表でこの点に答えています。音声通話とビデオ通話は WhatsApp Business アプリでは変わらず、この方法で登録された番号では Cloud API でサポートされていません。Calling API の前提条件も、反対側から同じことを述べています。企業番号は WhatsApp Business アプリではなく、Cloud API で使われている必要があります。したがって Coexistence 番号では、顧客はこれまでどおり電話をかけ、通話は電話上の WhatsApp Business アプリで鳴り、calls フィールドには報告されるものがありません。ソフトウェアで通話を扱う必要がある企業は、Cloud API のみの番号を使います。

1 件の通話のイベントはどのようにつながりますか?

通話 id によってつながります。通話 id は wacid で始まり、その通話のすべてのイベントで同じ値が繰り返されます。企業発信の通話では、SDP アンサーを伴う接続、RINGING のあと ACCEPTED または REJECTED のステータス、最後に終了が報告されます。ユーザー発信の通話では、自社のスタックが応答するための SDP オファーを伴う接続のあと、終了が報告されます。録音と文字起こしのイベントは、有効にしている場合、終了のあとに届きます。保存するイベントは、id と event の組み合わせをキーにしてください。再送で同じイベントが繰り返されることがあり、到着順は保証されていないためです。Calling API の前提条件の全一覧は、Coexistence 番号での通話に関するページにあります。

AI は Coexistence 番号の通話について何ができますか?

チャットでの対応は AI が担い、通話は電話に出る担当者に任せます。easyCoexistence は calls フィールドを購読しておらず、通話用のツールもありません。コネクタと自動化は、メッセージとテンプレートを扱います。実際には、AI の返信で、担当者がいつ話せるか、どの番号に電話すればよいかを顧客に伝えられます。キーワード自動化で「call」または「phone」に、その情報で返信することもできます。オーナーは、これまでどおり WhatsApp Business アプリで通話に出ます。

よくある間違い

  • Coexistence 番号で通話を購読し、イベントを待つこと。Meta は、これらの番号では Cloud API で通話をサポートしないと記載しています。
  • すべての terminate に start_time と duration があると期待すること。これらは通話に応答があった場合にのみ現れます。応答のない通話も、COMPLETED で終わります。
  • 通話許可の返信を calls フィールドで探すこと。これらは messages に、インタラクティブな call_permission_reply として届きます。
  • 録音と文字起こしを Meta に残したままにすること。どちらも Webhook の後 7 日間だけダウンロードでき、その後は消えます。
EasyCoexistence で実現する

これにより、AI と自動化がメッセージに答え、テンプレートを送る一方で、通話は電話上の WhatsApp Business アプリで鳴り続けます。すべての番号は 24/7 で監視され、アプリが開かれない番号を切断する 14 日間のルールも含まれます。接続済みの番号 1 件あたり月額 US$ 9 から、番号を増やすほど下がり US$ 0.75 まで。最初の 3 日間は無料です。

よくある質問

Coexistence 経由で番号を API に接続すると、顧客は通話の発信ができなくなりますか?

Meta の Coexistence ガイドは、音声通話とビデオ通話が WhatsApp Business アプリでは変わらないと記載しています。顧客は同じ番号に電話をかけ、オーナーは電話上のアプリで応答します。

Calling API の料金はメッセージと同じ仕組みですか?

いいえ。Meta の料金ページによると、Calling API は別の料金体系で、通話料金は別の料金ドキュメントを参照します。そのため、通話料金はメッセージステータスの pricing オブジェクトには表示されません。

Calling API の通話は録音または文字起こしできますか?

はい、録音または文字起こしが有効な場合に可能です。通話後、Meta は音声の media id を伴う call_recording_available、または JSON ドキュメントの id を伴う call_transcription_available を送信します。通常は 1 分以内です。

通話の Webhook を、アプリのエンドポイントとは別のエンドポイントに送れますか?

はい。calls は、messages や Coexistence のフィールドと並んで、WhatsApp Business アカウントまたは電話番号が別のコールバック URL に振り分けられるフィールドの 1 つです。

続きを読む

始める準備はできましたか?

WhatsApp Coexistence の設定は数分で完了し、数か月もかかりません。スマートフォン上のアプリも引き続き使えます。

無料トライアルを始める

確認日