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.

Compartilhar produtos com os clientes

As empresas podem compartilhar produtos com os clientes de várias maneiras:

Mensagens de catálogo

As mensagens de catálogo têm formato livre e permitem mostrar todo o seu inventário de produtos no WhatsApp.

Essas mensagens exibem uma imagem de cabeçalho da miniatura do produto à sua escolha, um texto personalizado, um título fixo, um subtítulo fixo e um botão Ver catálogo.

Quando um cliente toca no botão Ver catálogo, seu catálogo de produtos aparece no WhatsApp.

Requisitos

Você precisa ter um inventário carregado na Meta em um catálogo de comércio eletrônico conectado à sua conta do WhatsApp Business.

Sintaxe da solicitação

Use o ponto de extremidade WhatsApp Business Phone Number > Messages para enviar uma mensagem de catálogo.

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Corpo da publicação

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<TO>",
  "type": "interactive",
  "interactive" : {
    "type" : "catalog_message",
    "body" : {
      "text": "<BODY_TEXT>"
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "<THUMBNAIL_PRODUCT_RETAILER_ID>"
      }
    },

    /* Footer object is optional */
    "footer": {
      "text": "<FOOTER_TEXT>"
  }
}

Propriedades

Espaço reservadoDescriçãoExemplo de valor

<BODY_TEXT>

String

Obrigatório.


Texto a ser exibido no corpo da mensagem.


Máximo de 1.024 caracteres.

Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase.

<FOOTER_TEXT>

String

Opcional.


Texto a ser exibido no rodapé da mensagem.


Máximo de 60 caracteres.

Best grocery deals on WhatsApp!

<THUMBNAIL_PRODUCT_RETAILER_ID>

String

Obrigatório.


O número SKU do item, marcado como identificação do conteúdo no Gerenciador de Comércio.


A miniatura deste item será usada como a imagem de cabeçalho da mensagem.


Se o objeto parameters for omitido, será usada a imagem do primeiro item do seu catálogo.

2lc20305pt

<TO>

String

O número de telefone do cliente.

16505551234

Exemplo de solicitação

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "16505551234",
  "type": "interactive",
  "interactive": {
    "type": "catalog_message",
    "body": {
      "text": "Hello! Thanks for your interest. Ordering is easy. Just visit our catalog and add items to purchase."
    },
    "action": {
      "name": "catalog_message",
      "parameters": {
        "thumbnail_product_retailer_id": "2lc20305pt"
      }
    },
    "footer": {
      "text": "Best grocery deals on WhatsApp!"
    }
  }
}'

Exemplo de resposta

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

Mensagens de modelo de catálogo

As mensagens de modelo de catálogo contêm um botão que, quando tocado, exibe seu catálogo de produtos no WhatsApp.

Para enviar esse tipo de mensagem, você precisa ter um modelo de catálogo. Consulte o documento Sending Catalog Template Messages para saber como criar esses modelos e enviá-los em uma mensagem.

Mensagens com link para o catálogo

As empresas que quiserem direcionar o usuário para o catálogo completo de produtos poderão criar um link wa.me e incluí-lo em uma mensagem de texto padrão. Ao enviar uma mensagem de texto, as empresas poderão usar a preview_url opcional definida como true para renderizar um conjunto de miniaturas do catálogo de produtos de qualquer URL na string body da mensagem.

Se as empresas desabilitarem o catálogo, os links wa.me e o botão Ver catálogo nas mensagens com um link para os produtos exibirão o aviso Link de catálogo inválido quando tocados.

Para criar um link wa.me, anexe o número de telefone comercial da empresa, incluindo o código do país, ao final da string a seguir:

https://wa.me/c/

Por exemplo:

https://wa.me/c/15555455657

Mensagens de produto

As mensagens de produto único e de vários produtos são do tipo interactive.

Exemplo de mensagem multiproduto:
Exemplo de mensagem de produto único:
Menu exibido quando o usuário clica em Começar a comprar:
Exemplo de página de detalhes do produto:

Visão geral

Os usuários que recebem mensagens multiproduto ou de produto único podem realizar três ações principais:

  1. Ver produtos: os clientes podem ver uma lista de itens ou apenas um produto. Quando um usuário clica em um produto específico, buscamos as informações mais recentes sobre o item e exibimos uma página de detalhes do produto (PDP). No momento, as PDPs são compatíveis apenas com imagens. Ou seja, vídeos e/ou GIFs adicionados ao produto não serão exibidos nesse tipo de página.
  2. Adicionar produtos a um carrinho: um usuário pode adicionar um produto ao carrinho ou alterar a quantidade de itens diretamente na lista ou na página de detalhes do produto. Sempre que um usuário adiciona um produto ao carrinho de compras, buscamos as informações mais recentes sobre o item. Caso haja uma mudança de status relacionada a um dos itens, exibiremos um diálogo com a mensagem "Um ou mais itens do seu carrinho foram atualizados". Consulte Atualizações de produtos para saber mais. Um carrinho é mantido em um tópico da conversa com o cliente até ser enviado à empresa. Consulte Experiência do carrinho de compras para saber mais.
  3. Enviar um carrinho de compras para a empresa: após adicionarem todos os itens necessários, os clientes poderão enviar o carrinho para a empresa com a qual estão trocando mensagens. As empresas, então, poderão definir os próximos passos, como solicitar informações para a entrega ou oferecer opções de pagamento.

Se um cliente tiver diferentes aparelhos vinculados à mesma conta do WhatsApp, as mensagens multiproduto ou de produto único serão sincronizadas entre eles. No entanto, o carrinho de compras é configurado localmente para cada aparelho específico. Consulte Experiência do carrinho de compras para saber mais.

No momento, é possível receber esses tipos de mensagem nas seguintes plataformas:

  • iOS: 2.21.100 (multiproduto) e 2.21.210 (produto único).
  • Android: 2.21.9.15 (multiproduto) e 2.21.19 (produto único).
  • Web: o cliente web compatível com esses recursos já foi lançado.

Se a versão do app do destinatário não for compatível com as mensagens multiproduto e de produto único, será enviado um aviso explicando que o usuário não recebeu a mensagem porque está usando uma versão desatualizada do WhatsApp. A empresa também receberá uma notificação de webhook para informar que a mensagem não pôde ser entregue porque o destinatário está usando uma versão desatualizada do app.

Comportamento esperado das mensagens

As mensagens multiproduto e de produto único podem ser:

  • encaminhadas de um usuário para outro;
  • reabertas por um usuário dentro da mesma conversa.

As mensagens multiproduto, de catálogo e de produto único não podem ser:

  • enviadas como notificações. Elas só podem ser enviadas como parte de conversas existentes.

Atualizações de produtos

As empresas talvez precisem atualizar as propriedades dos itens do catálogo. Veja abaixo as propriedades atualizadas e a forma como lidamos com qualquer mensagem que mencione o produto em questão:

Propriedade atualizadaProcesso de atualização

Preço, título, descrição e imagem do produto.

  1. Uma empresa envia uma mensagem multiproduto ou de produto único contendo o produto A.
  2. A empresa atualiza as propriedades do produto A no catálogo.
  3. As telas que exibem o produto em questão são atualizadas assim que o cliente do usuário toma conhecimento da mudança pelo servidor.

Alteração na disponibilidade

  1. Uma empresa envia a um cliente uma mensagem multiproduto ou de produto único contendo o produto B.
  2. A empresa vende todas as unidades do produto B que estavam disponíveis. Depois, atualiza o catálogo informando que não há mais o produto B em estoque.
  3. Se o cliente já tiver adicionado o produto B ao carrinho, o item será removido de lá. O carrinho de compras exibirá um diálogo com a mensagem "Um ou mais itens do seu carrinho foram atualizados".
  4. Caso o cliente não tenha adicionado o produto B ao carrinho, a mensagem multiproduto ou de produto único mostrará o item como indisponível.

Experiência do carrinho de compras

Depois de visualizar os produtos, um cliente poderá adicioná-los ao carrinho de compras e enviar esse carrinho para a empresa. Em atividades de comércio realizadas no WhatsApp, um carrinho de compras precisa ter as seguintes características:

  • Ser exclusivo de um tópico da conversa entre a pessoa e a empresa em um aparelho específico: somente um carrinho é criado por tópico de conversa entre o cliente e a empresa. Além disso, os carrinhos não são mantidos em diferentes aparelhos. Assim que um carrinho é enviado, o cliente pode abrir outro com a empresa e iniciar o processo novamente.
  • Não ter data de validade: o carrinho fica disponível no tópico da conversa até ser enviado para a empresa. Após o envio, os itens são removidos do carrinho.

Os clientes podem colocar até 99 unidades de um mesmo item do catálogo em um carrinho de compras, mas não há um limite para a inclusão de itens diferentes.

Não será possível fazer edições após o envio do carrinho. Os clientes poderão enviar um novo carrinho se precisarem de outros itens ou quiserem alterar o pedido. As empresas não podem enviar carrinhos aos clientes.

Exemplo de experiência de carrinho de compras e comportamento esperado na alteração de status de um item.

Por que usar

As mensagens multiproduto e de produto único ajudam a oferecer experiências de usuário simples e personalizadas. Isso porque é melhor para o cliente ser direcionado a um subconjunto de itens relevantes para ele do que navegar por todo o inventário de produtos da empresa.

Simples e eficiente

Combinar esses recursos com ferramentas de navegação, como PLN, pesquisa de texto ou lista de mensagens e botões de resposta, permite à empresa chegar rapidamente ao que o cliente está procurando.

Pessoal

Como são preenchidas dinamicamente, as mensagens podem ser personalizadas para cada cliente ou situação. Por exemplo, você pode mostrar uma mensagem multiproduto com os itens mais pedidos por um cliente.

Resultados de negócios

É um canal de alto desempenho para impulsionar os pedidos. Durante a fase de testes, as empresas tiveram uma conversão média de 7% de mensagens multiproduto enviadas para carrinhos recebidos.

Sem modelos

Para usar as mensagens interativas, não é preciso aplicar modelos nem receber aprovações prévias. Elas são geradas em tempo real e sempre incluem os detalhes mais recentes de itens, preços e níveis de estoque do seu inventário.

Quando usar

As mensagens multiproduto são a melhor opção para direcionar os clientes a um subconjunto específico do inventário de uma empresa. Confira os casos de uso:

  • Comprar por meio de conversas. Por exemplo, usar a funcionalidade de pesquisa para permitir que os clientes digitem uma lista de compras e enviar uma mensagem multiproduto como resposta.
  • Navegar para uma categoria específica. Por exemplo, roupas de ginástica.
  • Enviar ofertas ou recomendações personalizadas.
  • Repetir pedidos de itens realizados anteriormente. Por exemplo, um usuário pode repetir um pedido de menos de 30 itens feito regularmente.

As mensagens de produto único são a melhor opção para direcionar os clientes a um item específico do inventário de uma empresa porque oferecem respostas rápidas a partir de um conjunto limitado de opções. Confira os casos de uso:

  • Responder a um pedido específico do cliente.
  • Enviar uma recomendação.
  • Repetir o pedido de um item realizado anteriormente.

Os dois recursos também podem ser usados como parte de um fluxo de agente humano. Contudo, será preciso criar o conjunto de ferramentas para permitir que o agente humano gere uma mensagem multiproduto ou de produto único no tópico.

Primeiros passos

Antes de enviar uma mensagem, obtenha o ID do WhatsApp do destinatário com uma chamada para o /contacts.

Recomendamos que você configure webhooks para receber o status da mensagem e notificações sobre mensagens de entrada. Dessa forma, será possível saber se uma mensagem foi enviada com sucesso e acompanhar as respostas dos clientes.

Etapa 1: criar o objeto interativo

Mensagens de produto único

Para enviar uma mensagem de produto único, crie um objeto interactive do tipo product com estes componentes:

ObjetoDescrição

body

Opcional.

Um objeto de corpo. Veja todas as opções do objeto body.

footer

Opcional.

Um objeto de rodapé. Veja todas as opções do objeto footer.

action

Obrigatório.

O campo de ação precisa incluir o seguinte:

  • catalog_id: a identificação do catálogo que você quer usar na mensagem. É possível obter essa identificação no Gerenciador de Comércio.
  • product_retailer_id: o identificador único de um produto.

Veja todas as opções do objeto action.

Ao final do processo, o objeto interativo deverá ser semelhante a isto:

"interactive": {
    "type": "product",
    "body": {
      "text": "text-body-content"
    },
    "footer": {
      "text": "text-footer-content"
    },
    "action": {
      "catalog_id": "catalog-id",
      "product_retailer_id": "product-SKU-in-catalog"
    }
}

Mensagens multiproduto

Para enviar mensagens multiproduto, crie um objeto interactive do tipo product_list com estes componentes:

ObjetoDescrição

header

Obrigatório.

O type do cabeçalho deve ser definido como text. Não se esqueça de adicionar um objeto text com o conteúdo desejado. Veja todos os campos de header disponíveis.

body

Obrigatório.

Um objeto body. Veja todas as opções do objeto body.

footer

Opcional.

Um objeto footer. Veja todas as opções do objeto footer.

action

Obrigatório.

O campo de ação precisa incluir o seguinte:

  • catalog_id: a identificação do catálogo que você quer usar na mensagem. É possível obter essa identificação no Gerenciador de Comércio.
  • sections: matriz de objetos da seção. Você precisa ter pelo menos uma seção.

Em cada seção, inclua o seguinte:

  • title: inclua um título para cada seção caso você planeje usar mais de uma.
  • product_items: a matriz de objetos de produto que devem ser exibidos.

Cada objeto contém um product_retailer_id, que corresponde ao identificador único de um produto. É possível obter essa identificação no Gerenciador de Comércio. Veja todas as opções do objeto action.

Ao final do processo, o objeto interactive deverá ser semelhante a isto:

"interactive": 
    {
    "type": "product_list",
    "header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "the-section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }

Itens ausentes

Se nenhum dos itens fornecidos nas chamadas de API acima corresponder a um produto do catálogo da empresa no Facebook, encaminharemos um aviso de erro, e a mensagem multiproduto ou de produto único não será enviada ao usuário.

Em mensagens multiproduto, pelo menos um item da lista de produtos deve corresponder a um item do catálogo da empresa no Facebook. Nesse caso:

  • as mensagens serão enviadas com sucesso;
  • itens sem correspondência serão descartados e
  • a empresa receberá uma mensagem de erro solicitando a atualização do catálogo.

Etapa 2: adicionar parâmetros de mensagem comuns

Assim que o objeto interativo estiver pronto, anexe os outros parâmetros que compõem uma mensagem: recipient_type, to e type. Lembre-se de definir type como interactive.

{
  "recipient_type": "individual",
  "to" : "whatsapp-id", // WhatsApp ID of the recipient
  "type": "interactive",
  "interactive":{
    // The interactive object  
   }
  }

Consulte os parâmetros comuns a todos os tipos de mensagem aqui.

Etapa 3: fazer uma chamada POST para /messages

Faça uma chamada POST para o ponto de extremidade /messages com o objeto JSON criado nas etapas 1 e 2. Caso a mensagem seja enviada com sucesso, você receberá a seguinte resposta:

{
  "messages": [{
    "id": "{message-id}"
  }]
  }

Modelos de mensagem multiproduto

É preciso ter um modelo multiproduto para enviar esse tipo de mensagem. Consulte o documento Multi-Product Message Templates para saber como criar esses modelos e enviá-los em uma mensagem.