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

WhatsApp: Flows da Meta

Telas nativas do WhatsApp (Flows da Meta): cadastro dos seus Flows, publicação, envio, IA, o pacote de Flows nativos e as chaves de criptografia.

Os Flows da Meta são telas nativas do WhatsApp: formulários, listas e seletores que abrem dentro da conversa, sem o cliente sair do aplicativo. Aqui você cadastra os seus próprios Flows, publica-os na conta da Meta, envia a clientes, e liga o pacote de Flows nativos da plataforma. Não confunda com os fluxos do bot, que são roteiros de mensagens.

Pontos-chave
  • Todas as rotas exigem o módulo whatsapp-commerce e o privilégio manage_settings.
  • O id de um Flow da loja é um número inteiro, não um UUID.
  • Criar e alterar só mexe no painel. Publicar, pré-visualizar e enviar falam com a Meta.
  • Um PUT volta o Flow para rascunho se você não enviar status.
  • Apagar não remove o Flow da Meta.

Como funciona

Rascunho→Publicado na Meta→Enviado ao cliente
  1. Desenhe

    POST /meta-flows com o flow_json. Se quiser um ponto de partida, peça um rascunho a POST /meta-flows/generate.

  2. Publique

    POST /meta-flows/{id}/publish. O meta_flow_id é preenchido e o status vira published.

  3. Confira

    GET /meta-flows/{id}/preview devolve um link para ver o Flow como o cliente verá.

  4. Envie

    POST /meta-flows/{id}/send com o telefone do cliente.

Para o pacote pronto da plataforma, o caminho é outro: POST /native-flows/activate, acompanhar com GET /native-flows/status e, quando quiser, POST /native-flows/send.

Conceitos-chave

O formato do flow_json

É o JSON de Flows da Meta: version, e uma lista de screens, cada uma com id único e layout do tipo SingleColumnLayout cheio de children (componentes). A plataforma valida antes de gravar e recusa com 422 e a lista errors. As regras:

RegraLimite
versionObrigatória
Telas por FlowDe 1 a 20, ids únicos
Componentes por telaAo menos 1
Tipos de componenteTextHeading, TextSubheading, TextBody, TextCaption, RichText, TextInput, TextArea, Dropdown, RadioButtonsGroup, CheckboxGroup, ChipsSelector, DatePicker, CalendarPicker, OptIn, EmbeddedLink, Image, ImageCarousel, PhotoPicker, DocumentPicker, NavigationList, Footer
Ação (on-click-action.name)navigate, data_exchange, complete ou update_data
Form e FooterNo máximo 1 de cada por tela; Footer por último; Form fora de If
NavigationListNo máximo 2 por tela, e sem outros componentes
DocumentPickerNo máximo 1 por tela, e não junto com PhotoPicker
ImageCarouselAté 10 imagens, fora de If
DropdownAté 200 itens fixos
RadioButtonsGroup, CheckboxGroup, ChipsSelectorAté 20 itens fixos
If aninhadoAté 3 níveis

Cada componente também tem propriedades obrigatórias (por exemplo TextInput pede name e label; Footer pede label). A validação local cobre isso, mas a Meta tem regras próprias e pode recusar na publicação.

Flow da loja e Flow nativo

Os Flows da loja (/meta-flows) são os que você desenha e publica. Os Flows nativos (/native-flows) são o pacote pronto da plataforma, que a plataforma mesma cria e mantém na conta da Meta quando você ativa.

Quem fala com a Meta

Criar, ler, alterar e apagar um Flow da loja só mexe no painel. Publicar e pré-visualizar usam o token e a conta empresarial compartilhados da plataforma. Enviar usa o número de WhatsApp da loja.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/whatsapp/meta-flowsLista os Flows da lojaFlows da loja
POST/api/v1/admin/whatsapp/meta-flowsCria um Flow da lojaFlows da loja
GET/api/v1/admin/whatsapp/meta-flows/{id}Lê um Flow da lojaFlows da loja
PUT/api/v1/admin/whatsapp/meta-flows/{id}Substitui um Flow da lojaFlows da loja
DELETE/api/v1/admin/whatsapp/meta-flows/{id}Apaga um Flow da lojaFlows da loja
POST/api/v1/admin/whatsapp/meta-flows/{id}/publishPublica um Flow na MetaPublicar e enviar
GET/api/v1/admin/whatsapp/meta-flows/{id}/previewGera o link de pré-visualização de um FlowPublicar e enviar
POST/api/v1/admin/whatsapp/meta-flows/{id}/sendEnvia um Flow a um telefonePublicar e enviar
POST/api/v1/admin/whatsapp/meta-flows/generateGera um rascunho de Flow a partir de uma descriçãoIA para Flows
POST/api/v1/admin/whatsapp/meta-flows/decideEscolhe (e opcionalmente envia) o Flow certo para uma mensagemIA para Flows
GET/api/v1/admin/whatsapp/native-flows/statusMostra a situação dos Flows nativos da lojaFlows nativos
POST/api/v1/admin/whatsapp/native-flows/activateLiga os Flows nativos da lojaFlows nativos
POST/api/v1/admin/whatsapp/native-flows/deactivateDesliga os Flows nativos da lojaFlows nativos
POST/api/v1/admin/whatsapp/native-flows/sendEnvia um Flow nativo a um telefoneFlows nativos
POST/api/v1/admin/whatsapp/flow-keys/registerGera um par de chaves de Flow para um númeroChaves de Flow

Erros comuns

  • Esperar que POST /meta-flows publique: ele só grava no painel. Publique com /publish.
  • Usar PUT só para trocar o nome: ele regrava tudo e devolve o Flow para draft.
  • Tratar o id como UUID: o id do Flow da loja é um inteiro.
  • Enviar um Flow ainda em rascunho: sem meta_flow_id a resposta é 422 (a menos que passe flow_id).
  • Esperar que DELETE apague na Meta: ele só apaga o registro da loja.
  • Chamar POST /flow-keys/register à toa: cada chamada troca a chave ativa e pode quebrar Flows com troca de dados.
  • Ativar os Flows nativos sem número cadastrado: a resposta é 422 e blockers lista o que falta.
  • Esquecer a janela de 24 horas ao enviar: fora dela a Meta recusa.

Próximos passos

Flows da loja
Cadastrar o desenho.
Publicar e enviar
Levar o Flow até o cliente.
Flows nativos
O pacote pronto da plataforma.
IA para Flows
Gerar rascunhos e escolher o Flow.
Anterior
Pacotes de experiência
Próxima
Flows da loja
Nesta página
  • Como funciona
  • Conceitos-chave
  • O formato do flowjson
  • Flow da loja e Flow nativo
  • Quem fala com a Meta
  • Endpoints
  • Erros comuns
  • Próximos passos