Pular para as operações

Mensageria

Z-API em um fluxo de decisão.

5 Z-API operations a decision flow can call directly, with the credentials your own contract issued. The response is data the rest of the flow reads, branches on, and keeps in the trace.

Categoria
Mensageria
Tipo
Integração
Autenticação
Cabeçalhos de chave de API
Ambiente de teste
Somente host de produção

Quem são

API não oficial de WhatsApp para pequenas empresas brasileiras.

Z-API connects to WhatsApp by driving a real logged-in session rather than through Meta's Business Platform, which means no template approval and no messaging window — and no guarantee, since Meta may block the number. It is popular with Brazilian small businesses for its price and the speed of getting started. Each connected phone is an instance with its own id and token.

O que um fluxo pode chamar

5 operações, cada uma um passo que você coloca no editor.

  1. POST/instances/{instance}/token/{instance_token}/send-text

    Enviar uma mensagem

    Envia uma mensagem de WhatsApp. phone é o número em formato internacional, sem sinal de mais e sem pontuação — 5511999999999.

  2. POST/instances/{instance}/token/{instance_token}/send-link

    Enviar uma mensagem com prévia de link

    A message whose link renders as a preview card. Worth the separate call when the decision ends in "here is your contract to sign" — a bare URL in a text message gets read as spam more often than a card does.

  3. POST/instances/{instance}/token/{instance_token}/send-button-list

    Enviar uma mensagem com botões

    Oferece ao solicitante um pequeno conjunto de respostas para tocar.

  4. GET/instances/{instance}/token/{instance_token}/status

    Conferir se a instância está conectada

    Se a instância continua pareada com um telefone.

  5. GET/instances/{instance}/token/{instance_token}/device

    Ler o aparelho pareado

    Qual telefone e qual conta de WhatsApp a instância está vinculada.

Onde isso entra na decisão

Messaging calls have a natural place in a flow.

Avisar uma pessoa faz parte da decisão, e não é um detalhe posterior: a mensagem sai do próprio fluxo, no ponto em que o fluxo decidiu que ela se justificava, carregando a mesma versão e a mesma trilha do resultado que a disparou.

Whatever Z-API returns is part of the run, so it is part of the record. When someone asks months later why an applicant was declined, the answer cites what came back at the time rather than re-fetching from a service whose answer has since changed.

  • 01Add Z-API as a connection authenticating with API key headers.
  • 02A Z-API tem um host só para os dois ambientes, então proteja as execuções de teste com credenciais e limites seus.
  • 03Coloque um nó de Conexão e escolha uma operação — “Enviar uma mensagem” costuma ser a primeira de que um fluxo precisa.
  • 04Mapeie a resposta nos campos que suas regras leem e depois teste o caminho inteiro antes de ele receber tráfego de produção.

Perguntas frequentes

Usando a Z-API em um fluxo.

Como conecto a Z-API a um fluxo de decisão?

Adicione a Z-API como uma conexão no seu workspace, autenticando com cabeçalhos de chave de API, com as credenciais que o seu próprio contrato emitiu — a ArboRule chama o provedor no seu lugar e nunca assume um contrato por você. Depois que a conexão existe, qualquer fluxo do workspace pode colocar um nó de Conexão e escolher uma das operações dela. As credenciais ficam na conexão, não no fluxo, então quem cuida da política usa a Z-API em uma decisão sem nunca ver o segredo.

Dá para testar a Z-API sem tocar em produção?

A Z-API expõe um host só para os dois ambientes, então não existe um sandbox separado para apontar. As execuções de teste continuam rodando no Sandbox e ficam registradas à parte no histórico de decisões, mas a chamada vai para o mesmo lugar que a de produção — então proteja isso com credenciais de teste, limites de taxa ou dados seus.

O que um fluxo pode chamar na Z-API?

5 operações, incluindo “Enviar uma mensagem”, “Enviar uma mensagem com prévia de link”, “Enviar uma mensagem com botões”. Cada uma é um passo que você coloca no editor e mapeia nos campos que suas regras leem, e a maioria dos fluxos começa por “Enviar uma mensagem”. A lista vem do mesmo manifesto que o motor usa para fazer a chamada, então esta página não consegue descrever uma operação que o produto não tem.

Em que ponto de uma decisão a Z-API deve ser chamada?

Avisar uma pessoa faz parte da decisão, e não é um detalhe posterior: a mensagem sai do próprio fluxo, no ponto em que o fluxo decidiu que ela se justificava, carregando a mesma versão e a mesma trilha do resultado que a disparou.

Quando você quiser

Wire Z-API into a real decision.

Monte o fluxo no Sandbox, conecte sua conta e veja a decisão buscar o que precisa antes de responder.

Leia a documentação