API de Nuvem

Enviar modelos de autenticação

Este documento explica como enviar modelos de autenticação com botões de senha descartável aprovados.

Solicitação

Use o ponto de extremidade em WhatsApp Business Phone Number > Messages para enviar uma mensagem de modelo de autenticação com um botão de senha descartável.

Sintaxe da solicitação

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Corpo da publicação

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

Propriedades do corpo

Espaço reservadoDescriçãoExemplo de valor

<CUSTOMER_PHONE_NUMBER>

O número de telefone do WhatsApp do cliente.

12015553931

<ONE-TIME PASSWORD>

A senha descartável ou o código de verificação que será entregue ao cliente.


Esse valor precisa aparecer duas vezes na carga.


Máximo de 15 caracteres.

J$FpnYnP

<TEMPLATE_LANGUAGE_CODE>

O código da localidade e o idioma do modelo.

en_US

<TEMPLATE_NAME>

O nome do modelo.

verification_code

Resposta

Se o processo for bem-sucedido, a API enviará a seguinte resposta:

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

Conteúdo da resposta

Espaço reservadoDescriçãoExemplo de valor

<INPUT>

String

O número de telefone do cliente para quem a mensagem foi enviada. Talvez esse valor não corresponda a wa_id.

+16315551234

<WA_ID>

String

O ID do cliente para quem a mensagem foi enviada. Talvez esse valor não corresponda a input.

+16315551234

<ID>

String

O ID da mensagem do WhatsApp. Use o ID listado depois de "wamid." para acompanhar o status da mensagem.

wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3N0EyQUJDMjFEQzZCQUMzODMA

Exemplo

Exemplo de solicitação

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

Exemplo de resposta

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