VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Visão geral

Como o WhatsApp da loja é configurado pelo seller: conta, ajustes, segmento, boas-vindas, consentimento, voz do assistente e mini-loja.

O WhatsApp Confluence é o canal de WhatsApp da loja. Um número conectado à Meta (a plataforma WhatsApp Business) recebe as mensagens dos clientes e as entrega a três coisas: uma caixa de entrada para a equipe, um assistente de vendas que atende sozinho e uma mini-loja aberta por link dentro da conversa. Esta seção reúne as rotas de configuração que o seller usa no painel (/api/v1/vendor/whatsapp-confluence/...).

Pontos-chave
  • Todas as rotas exigem o token de um usuário seller (lojista). Leituras funcionam para qualquer seller aprovado; gravações exigem o privilégio vendor_settings ou vendor_manage_whatsapp e que o WhatsApp da loja seja desse seller.
  • Os ajustes são por loja, não por seller. Num marketplace com mais de um seller com número próprio, só o administrador grava; o seller recebe 403 store_whatsapp_owner_required.
  • Conectar, desconectar e sincronizar números não existe na API do seller: é feito pelo administrador.
  • Mudanças valem para a próxima mensagem. Não há rascunho nem publicação.
  • Cada rota de gravação tem um comportamento diferente (mesclar, substituir, preservar). Leia a página antes de enviar um corpo parcial.

Como funciona

O fluxo típico de quem monta a tela de configuração do WhatsApp:

  1. Confira a conexão
    Chame Conta conectada. Se connected for false, mostre o assistente de conexão do administrador em vez da configuração.
  2. Escolha o segmento
    Em Segmento e perfil de comércio, escolha o ramo da loja. Ele muda regras e textos padrão.
  3. Ligue os recursos
    Em Ajustes do canal, ligue o que a loja usa (campanhas, mini-loja, PIX, áudio...).
  4. Escreva a recepção
    Configure Boas-vindas, Termo de consentimento e Voz do assistente.
  5. Capriche na mini-loja
    Ajuste a Mini-loja e divulgue o link.

Conceitos-chave

Conta, número e WABA

Uma conta (account) é um número de telefone conectado. Ela tem um phone_number_id e pertence a uma WABA (WhatsApp Business Account), a conta empresarial da Meta. Em coexistência (platform_type: COEXISTENCE) o mesmo número funciona na API e no aplicativo WhatsApp Business do celular ao mesmo tempo. A conta tem um status (P pendente, A ativa, E erro, D desconectada) e um onboarding_state (Q, X, S, H, C, E).

Quem enxerga e quem grava

PapelLêGrava ajustes da loja
Administrador da lojatudosim
Seller com o número da loja (único dono)tudo da lojasim, com o privilégio
Seller sem número, ou com número de outro sellersó o que é delenão (403)

Ajustes são por loja

Boas-vindas, termo, voz, segmento, mini-loja e ajustes vivem num registro único da loja. Por isso a regra de dono acima vale para eles e para o orçamento de mensagens.

Tempo e formatos

Datas em RFC 3339 (UTC). Valores monetários nesta seção, quando existem, são inteiros em centavos. Ids de conta e de conversa são UUID.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/vendor/whatsapp-confluence/onboarding/statusEstado da conexão e capacidades. Conta conectadaseller
GET/api/v1/vendor/whatsapp-confluence/accountsLista as contas visíveis. Conta conectadaseller
GET/api/v1/vendor/whatsapp-confluence/settingsLê os ajustes do canal. Ajustesseller
PUT/api/v1/vendor/whatsapp-confluence/settingsMescla ajustes do canal. Ajustesseller, dono
GET/api/v1/vendor/whatsapp-confluence/segmentsCatálogo de segmentos. Segmentoseller
GET/api/v1/vendor/whatsapp-confluence/commerce-profileLê o segmento da loja. Segmentoseller
PUT/api/v1/vendor/whatsapp-confluence/commerce-profileGrava o segmento. Segmentoseller, dono
GET/api/v1/vendor/whatsapp-confluence/welcomeLê a boas-vindas. Boas-vindasseller
PUT/api/v1/vendor/whatsapp-confluence/welcomeGrava a boas-vindas. Boas-vindasseller, dono
GET/api/v1/vendor/whatsapp-confluence/consent-termLê o termo. Termoseller
PUT/api/v1/vendor/whatsapp-confluence/consent-termGrava o termo. Termoseller, dono
GET/api/v1/vendor/whatsapp-confluence/ai/personaLê a voz do assistente. Vozseller
PUT/api/v1/vendor/whatsapp-confluence/ai/personaGrava a voz do assistente. Vozseller, dono
GET/api/v1/vendor/whatsapp-confluence/preview-settingsLê a aparência da mini-loja. Mini-lojaseller
PUT/api/v1/vendor/whatsapp-confluence/preview-settingsGrava a aparência. Mini-lojaseller, dono
GET/api/v1/vendor/whatsapp-confluence/preview-linkLink público da mini-loja. Mini-lojaseller

Erros comuns

  • Mandar um PUT parcial onde a gravação substitui. Perfil de comércio, voz e aparência da mini-loja apagam o que faltar. Só settings mescla.
  • Esperar que o seller grave num marketplace. Com vários sellers com número, só o administrador grava; leia o 403 store_whatsapp_owner_required.
  • Esquecer campos obrigatórios da boas-vindas. trigger e inactivity_hours não têm padrão no PUT.
  • Ligar o termo sem avisar a equipe. A primeira resposta manual a um telefone novo leva o termo junto.
  • Achar que enable_inbox ou enable_bot desligam. São chaves sempre ligadas: o valor enviado é ignorado.
  • Escrever os marcadores de outro jeito. {nome}, {loja} e {link_privacidade} são trocados pela plataforma no envio; escreva-os exatamente assim.

Próximos passos

Atendimento
Caixa de entrada, respostas, assistente e cobrança dentro da conversa.
Resultados
Volume, custo, funil, campanhas e orçamento de mensagens.
Tokens
Como obter o token do seller.
Anterior
Mini-shop no storefront
Próxima
Conta conectada
Nesta página
  • Como funciona
  • Conceitos-chave
  • Conta, número e WABA
  • Quem enxerga e quem grava
  • Ajustes são por loja
  • Tempo e formatos
  • Endpoints
  • Erros comuns
  • Próximos passos