云端 API

发送身份验证模板

本文档介绍如何发送已获批准的包含一次性密码按钮的身份验证模板。

请求

使用 WhatsApp Business 电话号码 > 消息端点发送包含一次性密码按钮的身份验证模板消息。

请求语法

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

POST 请求正文

{
  "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 编号。值可能与 input 不一致。

+16315551234

<ID>

字符串

WhatsApp 消息编号。您可以使用“wamid.”后列出的编号来追踪消息状态。

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"
    }
  ]
}