A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.

Como enviar modelos de mensagem

Você pode usar o ponto de extremidade /messages para enviar modelos de mensagem a clientes. Um modelo de mensagem pode ser de texto, de mídia ou interativo.

Para saber mais sobre modelos de mensagem, acesse Mensagens, Mensagens iniciadas pela empresa.

Antes de começar

Verifique se você concluiu as ações descritas na documentação sobre pré-requisitos de mensagens.

Etapa 1: crie um modelo via Gerenciador do WhatsApp

Modelos de mensagem são criados no Gerenciador do WhatsApp, que faz parte da sua conta do WhatsApp no Gerenciador de Negócios do Facebook. Seus modelos de mensagem serão revisados para garantir que não violem as políticas do WhatsApp. Assim que forem aprovados, sua empresa terá seu próprio namespace em que os modelos de mensagem serão armazenados.

Ao criar um modelo de mensagem, é necessário ter o seguinte:

  1. Nome do modelo de mensagem – só pode conter caracteres alfanuméricos minúsculos e sublinhados (_). Nenhum outro caractere ou espaço em branco é permitido.
  2. Componentes do modelo de mensagem – preencha o modelo com o texto e/ou os componentes de mídia, incluindo os espaços reservados do parâmetro, conforme exigido. Verifique se não há novas linhas, tabulações nem mais de 4 espaços consecutivos. Além disso, é necessário atender às restrições de comprimento apontadas no Gerenciador de Negócios ou na API de Gerenciamento do WhatsApp Business.
  3. Todas as outras traduções desejadas pela empresa.

Para gerar uma amostra do modelo de mensagem durante o processo de criação, clique no botão Adicionar amostra. Isso nos ajuda durante o processo de avaliação e aprovação, para que possamos entender que tipo de mensagem você planeja enviar. Confirme que são exemplos que não incluem informações pessoais ou confidenciais.

Para ver etapas mais detalhadas sobre a criação de modelos de mensagem, consulte Criar modelos de mensagem para a sua conta da WhatsApp Business API.

Exemplos

Criar uma mensagem de boas-vindas em que o nome do modelo seja welcome e a mensagem seja a seguinte:

  "Welcome {{1}}. We look forward to serving you on WhatsApp." 

Criar uma mensagem de confirmação do pedido em que o nome do modelo seja order_confirmation e a mensagem seja a seguinte:

  "Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}." 

Traduções

O WhatsApp não faz traduções para a sua empresa. É necessário inserir todas as traduções dos modelos de mensagem no mesmo formato descrito aqui. O nome do elemento é o mesmo para todas as traduções. Para saber mais, consulte estes recursos:

Etapa 2: faça uma solicitação POST a /messages

Quando o modelo estiver pronto, você poderá enviá-lo aos clientes usando o objeto template:

POST /v1/messages
{
  "to": "recipient_wa_id",
  "type": "template",
  "template": {
        "namespace": "your-namespace",
        "name": "your-template-name",
        "language": {
            "code": "your-language-and-locale-code",
            "policy": "deterministic"
        },
        "components": [{
            "type": "body",
            "parameters": [
                {
                    "type": "text",
                    "text": "your-text-string"
                },
                {
                    "type": "currency",
                    "currency": {
                        "fallback_value": "$100.99",
                        "code": "USD",
                        "amount_1000": 100990
                    }
                },
                {
                    "type": "date_time",
                    "date_time" : {
                        "fallback_value": "February 25, 1977",
                        "day_of_week": 5,
                        "day_of_month": 25,
                        "year": 1977,
                        "month": 2,
                        "hour": 15,
                        "minute": 33
                    }
                },
                {
                "type": "date_time",
                    "date_time" : {
                    "fallback_value": "February 25, 1977",
                    "timestamp": 1485470276
                    }
                }
            ]
        }]
    }
}

Somente os tipos de botões URL, QUICK_REPLY e PHONE_NUMBER são compatíveis.

Se um modelo contiver um tipo de botão que não esteja nesta lista, a API retornará um erro.

Parâmetros

Etapa 3: verifique a resposta da API

Uma resposta bem-sucedida inclui um objeto messages com um id.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}  

Uma resposta malsucedida contém um objeto com uma cadeia de caracteres de erro, um código correspondente e outras informações. Consulte Mensagens de erro e status para mais informações.

Limites de mensagem de modelo de marketing por usuário

A partir de 6 de fevereiro de 2024, os limites de mensagem de modelo de marketing por usuário serão aplicados a mensagens enviadas a um pequeno número de usuários do WhatsApp na Índia e afetarão todos os usuários do WhatsApp com um número de telefone indiano até 13 de fevereiro de 2024.

Estamos lançando novas abordagens com consumidores na Índia primeiro para criar experiências do usuário de alta qualidade e aumentar o engajamento com mensagens de modelo de marketing. Isso pode incluir a limitação do número de mensagens de modelo de marketing que uma pessoa recebe de uma empresa em um determinado período, começando com um pequeno número de conversas que têm menor probabilidade de serem lidas. Observe que o limite é determinado com base no número de mensagens de modelo de marketing que a pessoa já recebeu de uma empresa e não está relacionado especificamente ao seu negócio.

O limite será aplicado apenas a mensagens de modelo de marketing que normalmente iniciariam uma nova conversa de marketing. Se você já tiver iniciado uma conversa de marketing com um usuário do WhatsApp, as mensagens de modelo de marketing enviadas a ele não serão afetadas.

Caso uma mensagem de modelo de marketing não seja entregue a um determinado usuário devido ao limite descrito, a API Local retornará o código de erro 1026. Importante: esse código de erro abrange uma ampla gama de problemas que podem resultar na não entrega de uma mensagem e, por questões de privacidade, não divulgaremos se de fato a mensagem não foi entregue devido ao limite. Consulte as perguntas frequentes do artigo "Por que minha taxa de entrega não é de 100%?" para saber mais.

Se você receber um desses códigos de erro e suspeitar que seja devido ao limite descrito, evite reenviar imediatamente a mensagem de modelo, já que isso gerará outra resposta de erro. Em vez disso, tente novamente aplicando incrementos de tempo maiores até que a mensagem seja entregue, já que o limite talvez esteja em vigor por diferentes períodos.

Continuaremos aperfeiçoando nossa abordagem e agradecemos sua parceria à medida que investimos para tornar o WhatsApp a melhor experiência possível para sua empresa e seus clientes.