Chamada API Externa no fluxo de voz
O node Chamada API Externa executa uma operação de uma plataforma de integração já configurada. Ele monta os dados de entrada, guarda o retorno e avalia se a resposta deve seguir por sucesso, falha ou limite de tentativas.
Quando usar
- consultar cliente, pedido, disponibilidade ou situação financeira;
- executar uma operação externa padronizada e reutilizável;
- decidir a jornada com base em um campo retornado pela integração.
Onde configurar
Acesse Fluxos Avançados na plataforma. Pela interface, abra o módulo Voz, selecione Configurações e, na árvore Telefonia e Voz, escolha Fluxos Avançados.
Abra ou crie um fluxo. No editor, localize Chamada API Externa no grupo Dados e integrações, arraste o item para o canvas e abra sua configuração.
Visão da configuração
Campos de configuração
| Campo | Como usar |
|---|---|
| Descrição | Nome opcional para identificar a finalidade da chamada. |
| Plataforma | Selecione a integração cadastrada. |
| Método | Escolha a operação disponível na plataforma. |
| Máx. tentativas | Quantidade de falhas que aciona a saída de limite, de 0 a 10. Com 0, essa saída não é acionada pela contagem. |
| Variável de saída | Nome usado para armazenar o retorno da integração. |
| Dados de entrada | Preencha cada campo com uma variável do fluxo ou um valor fixo. |
| Avaliação do resultado | Use a regra padrão do método ou verifique existência, lista com itens ou igualdade de um campo. |
Entradas e saídas
| Conexão | Comportamento |
|---|---|
| Máx. tentativas | Usada quando uma falha alcança a quantidade configurada. |
| Falha/sem retorno | Usada quando a integração falha ou o retorno não atende à avaliação antes do limite. |
| Sucesso | Usada quando a resposta atende à regra configurada. |
Exemplo prático
- Selecione a plataforma de ERP e o método de consulta de pedido.
- Mapeie
numeroPedidocoletado anteriormente para o campo exigido. - Salve a resposta em
pedidoe avalie sepedido.statusexiste. - Conecte as três saídas a mensagens adequadas.
Boas práticas e cuidados
- Quando um campo tem variável e valor fixo, a variável é priorizada.
- Use nomes claros para a variável de saída e confira o caminho do campo avaliado.
- Para uma requisição configurada diretamente no fluxo, use Requisição HTTP Personalizada.
- Para apenas notificar uma URL sem aguardar, use Envio de Webhook HTTP.
Como testar
- Use dados controlados que produzam sucesso.
- Teste retorno vazio ou fora da regra.
- Force repetições suficientes para validar a saída de limite.
- Confirme o uso da variável de saída em um node posterior.
Faça os testes em uma chamada controlada antes de vincular ou publicar o fluxo em um número de produção.