クラウドAPI

認証テンプレートの送信

このドキュメントでは、承認済みのワンタイムパスワードボタン付き認証テンプレートを送信する方法について説明します。

リクエスト

[WhatsApp Business電話番号] > [メッセージ]エンドポイントを使って、ワンタイムパスワードボタン付き認証テンプレートメッセージを送信します。

リクエストの構文

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

投稿本文

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<CUSTOMER_PHONE_NUMBER>",
  "type": "template",
  "template": {
    "name": "<TEMPLATE_NAME>",
    "language": {
      "code": "<TEMPLATE_LANGUAGE_CODE>"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "<ONE-TIME PASSWORD>"
          }
        ]
      },
      {
        "type": "button",
        "sub_type": "url",
        "index": "0",
        "parameters": [
          {
            "type": "text",
            "text": "<ONE-TIME PASSWORD>"
          }
        ]
      }
    ]
  }
}

本文のプロパティ

プレースホルダー説明値の例

<CUSTOMER_PHONE_NUMBER>

顧客のWhatsAppの電話番号。

12015553931

<ONE-TIME PASSWORD>

顧客に送信するワンタイムパスワードまたは認証コード。


この値はペイロードに2回表示される必要があることに注意してください。


最大15文字。

J$FpnYnP

<TEMPLATE_LANGUAGE_CODE>

テンプレートの言語とロケールコード。

en_US

<TEMPLATE_NAME>

テンプレートの名前。

verification_code

応答

成功すると、APIは以下のように応答します。

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<INPUT>",
      "wa_id": "<WA_ID>"
    }
  ],
  "messages": [
    {
      "id": "<ID>"
    }
  ]
}

応答の内容

プレースホルダー説明値の例

<INPUT>

文字列

メッセージ送信先の顧客電話番号。これはwa_idと一致していないことがあります。

+16315551234

<WA_ID>

文字列

メッセージ送信先の顧客のWhatsApp ID。これはinputと一致していないことがあります。

+16315551234

<ID>

文字列

WhatsAppメッセージID。「wamid.」の後にリストされているIDを使うことによって、メッセージのステータスをトラッキングすることができます。

wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3N0EyQUJDMjFEQzZCQUMzODMA

例

リクエストの例

curl -L 'https://graph.facebook.com/v19.0/105954558954427/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '{
      "messaging_product": "whatsapp",
      "recipient_type": "individual",
      "to": "12015553931",
      "type": "template",
      "template": {
        "name": "verification_code",
        "language": {
          "code": "en_US"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "J$FpnYnP"
            }
          ]
        },
        {
          "type": "button",
          "sub_type": "url",
          "index": "0",
          "parameters": [
            {
              "type": "text",
              "text": "J$FpnYnP"
            }
          ]
        }
      ]
    }
  }'

応答の例

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "12015553931",
      "wa_id": "12015553931"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI4Qzc5QkNGNTc5NTMyMDU5QzEA"
    }
  ]
}