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.
As empresas podem compartilhar produtos com os clientes de várias maneiras:
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.
Você precisa ter um inventário carregado na Meta em um catálogo de comércio eletrônico conectado à sua conta do WhatsApp Business.
Use o ponto de extremidade WhatsApp Business Phone Number > Messages para enviar uma mensagem de catálogo.
POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages
{ "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>" } }
Espaço reservado | Descrição | Exemplo de valor |
---|---|---|
String | Obrigatório. Texto a ser exibido no corpo da mensagem. Máximo de 1.024 caracteres. |
|
String | Opcional. Texto a ser exibido no rodapé da mensagem. Máximo de 60 caracteres. |
|
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 |
|
String | O número de telefone do cliente. |
|
{ "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!" } } }'
{ "messaging_product": "whatsapp", "contacts": [ { "input": "16505551234", "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI0ODVEREUwQzEzQkVBRjQ1RUUA" } ] }
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.
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
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: |
Os usuários que recebem mensagens multiproduto ou de produto único podem realizar três ações principais:
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:
2.21.100
(multiproduto) e 2.21.210
(produto único).2.21.9.15
(multiproduto) e 2.21.19
(produto único).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.
As mensagens multiproduto e de produto único podem ser:
As mensagens multiproduto, de catálogo e de produto único não podem ser:
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 atualizada | Processo de atualização |
---|---|
Preço, título, descrição e imagem do produto. |
|
Alteração na disponibilidade |
|
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:
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.
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.
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.
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.
É 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.
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.
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:
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:
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.
Antes de enviar uma mensagem, obtenha o ID do WhatsApp do destinatário com uma chamada para o nó /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.
Para enviar uma mensagem de produto único, crie um objeto interactive
do tipo product
com estes componentes:
Objeto | Descrição |
---|---|
| Opcional. Um objeto de corpo. Veja todas as opções do objeto |
| Opcional. Um objeto de rodapé. Veja todas as opções do objeto |
| Obrigatório. O campo de ação precisa incluir o seguinte:
|
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" } }
Para enviar mensagens multiproduto, crie um objeto interactive
do tipo product_list
com estes componentes:
Objeto | Descrição |
---|---|
| Obrigatório. O |
| Obrigatório. Um objeto |
| Opcional. Um objeto |
| Obrigatório. O campo de ação precisa incluir o seguinte:
Em cada seção, inclua o seguinte:
Cada objeto contém um |
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" } ... ]}, ... ] }, }
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:
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.
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}" }] }
É 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.