Search…
Functions
Realize integrações dos bots com os sistemas dos clientes diminuindo o tempo de programação.
Com a Functions você consegue processar os dados mais pesados do seu bot, como uma lista de endereços, e exibi-lo no seu chatbot sem a necessidade de utilizar uma API externa.
Ao criar uma ação ou nó no Builder, é possível personalizar uma lista dinâmica e tratar o seu retorno, diminuindo o tempo de programação e melhorando a agilidade no fluxo.

Para acessar a Functions, clique em BUILD no menu lateral da esquerda e, em seguida, em Functions.

A partir de agora, conheça toda a estrutura da Functions que possibilitará você realizar as integrações que deseja.

Para criar uma nova function, basta localizar o sinal de + e criar um Novo arquivo. O nome que você escolher não pode conter caracteres especiais nem números.
Feito isso, clique em Criar novo arquivo e a function estará na lista lateral à esquerda.
Veja o gif de exemplo:

No menu lateral à esquerda, selecione uma function para visualizá-la e, em seguida, a tela de edição será exibida.
Se você clicar em mais de uma Functions na edição, elas ficarão separadas por abas, como mostra a imagem abaixo:

Para salvar a sua edição, basta clicar na opção Salvar alterações. Caso queira desfazê-la, clique na opção Desfazer:
Lembre-se sempre de salvar, pois as alterações não serão salvas automaticamente.

Os parâmetros setados para o teste poderão ser utilizados pela função através da variável "params".
  • Parâmetros de teste: editor onde os parâmetros devem ser setados no formato JSON;
  • Resultado do teste: campo de leitura contendo o resultado da ação programada utilizando os parâmetros de teste.
A área de teste fica logo ao lado da opção Publicar. Para utilizá-la, clique no botão Exibir Área de Testes e, em seguida, em Testar. Para retirar a visualização, clique em Ocultar Área de Testes.
Caso você visualize, no momento da sua edição, que existe outro usuário também editando, você não poderá fazer nada além de visualizar.

Todas as alterações feitas nas Functions só terão reflexos em versões de produção caso a respectiva function seja publicada.
Dessa forma, temos um ambiente de homologação melhor definido para testar bastante as suas functions.
No ambiente de desenvolvimento, as Functions serão executadas com todas as mudanças feitas antes mesmo de publicar.
Caso deseje publicar a sua Function, clique na opção Publicar.
Ao publicar uma versão no builder, não publicará as functions, elas devem ser publicadas separadamente.

A estrutura do retorno de uma ação é a seguinte:
{
"code":"200/404/500",
"result":"retorno programado da ação"
}
Atributos de um evento:
Atributo
descrição
code
Código de execução da ação:
  • 200 - Em caso de sucesso
  • 404 - Caso a ação não seja encontrada (por erro de escrita ou por não estar publicada, por exemplo)
  • 500 - Caso ocorra erros inesperados de execução.
result
Retorno da função criada. retornará exatamente o que foi programado pelo ser criador no altu
Para uso no builder, acessar através da result_variable da ação (result_variable.code ou result_variable.result), como no exemplo abaixo:

Para aplicar a Function no seu assistente, siga as instruções abaixo dentro da plataforma do Zenvia NLU:
  1. 1.
    Clique no nó que deseja adicionar a functions ou crie um novo;
  2. 2.
    Escolha o componente de Ações </>;
  3. 3.
    Acesse o Helper;
  4. 4.
    Busque por Functions;
  5. 5.
    Mantenha o prefixo "custom" e a partir dele haverá um autocomplete para selecionar a function que deseja utilizar.
Copy link
On this page
Acesso
Estrutura
Atributos
Aplicar no Assistente