No Zenvia Customer Cloud, a funcionalidade Chamada de API permite integrar sistemas externos ao seu chatbot. Com ela, você pode:
Consultar dados de clientes em um CRM.
Enviar informações para sistemas externos.
Automatizar ações com base em dados dinâmicos.
Uma API (Interface de Programação de Aplicativos) é o meio pelo qual diferentes sistemas se comunicam.
Como acessar
No Construtor do bot, clique nos três pontinhos do bloco (ou em qualquer área dele)
Clique em Adicionar conteúdo
Selecione Chamada de API
Como configurar a Chamada de API
Preencha os seguintes campos:
Método: GET, POST, PUT, DELETE ou PATCH.
URL: endpoint da API.
Cabeçalho: (ex: Authorization, Content-Type).
Corpo: conforme o formato esperado (ex: JSON).
Por que usar outro bloco?
A execução dos blocos segue esta ordem:
Envia a mensagem;
Recebe mensagens;
Salva variáveis;
Executa ações (incluindo API);
Define o próximo fluxo.
Isso significa que o retorno da API só estará disponível depois que o bloco terminar. Você precisa de um novo bloco para usar os dados retornados.
Como mostrar uma variável específica no fluxo
O ponto principal é deixar mais visual como navegar no JSON retornado pela API e como usar o valor dentro da mensagem do chatbot. Abaixo estão exemplos mais claros, progressivos e práticos para substituir ou complementar a seção atual da documentação.
Como acessar uma variável específica da API
Toda resposta da API fica disponível na variável padrão:<? $resposta_api.body ?>Ela contém todo o JSON retornado pela chamada de API.
Exemplo 1 — Mostrar apenas o nome do cliente
Resposta da API
Para acessar apenas o nome do cliente, use:<? $resposta_api.body.cliente.nome ?>
Mensagem no bloco do fluxo
Resultado exibido ao usuário:
Olá, Carlos Silva!
Use este padrão quando quiser exibir apenas um campo específico da resposta da API.
Exemplo 2 — Mostrar mais de uma informação do cliente
Resposta da API, Mensagem no bloco do fluxo e Resultado exibido:
Olá, Carlos Silva!
Seu plano atual é Premium. E-mail cadastrado: [email protected].
Aqui o usuário entende que cada campo do JSON pode ser acessado separadamente.
Exemplo 3 — Mostrar um valor dentro de um array
Resposta da API
Para acessar o primeiro pedido, use o índice [0]:<? $resposta_api.body.pedidos[0].numero ?>Para acessar o status do primeiro pedido:<? $resposta_api.body.pedidos[0].status ?>
Mensagem no bloco do fluxo
Resultado exibido
Seu pedido 12345 está com status "Em transporte".
Use [0] para o primeiro item do array, [1] para o segundo e assim por diante.
Exemplo 4 — Entendendo o caminho da variável
Resposta da API
O caminho até a cidade é:
Logo, a variável correta será:<? $resposta_api.body.cliente.endereco.cidade ?>
Mensagem no fluxo
Resultado:
Cidade do cliente: São Paulo
A regra é simples: siga a estrutura do JSON usando ponto (.) para objetos e [n] para listas.
Exemplo visual do fluxo correto
Fluxo recomendado
⚠️ Importante: os dados retornados pela API só ficam disponíveis após o término do bloco de API. Por isso, a exibição deve acontecer em um bloco seguinte.