A Evolution API permite integrar bots do Typebot para automatizar interações e responder a mensagens do WhatsApp com base em triggers configurados. A seguir, você encontrará as instruções detalhadas sobre como configurar, gerenciar sessões, inicializar bots manualmente e utilizar variáveis predefinidas.
Você pode configurar diversos bots no Typebot utilizando triggers para iniciar as interações. A configuração do bot pode ser feita através do endpoint /typebot/create/{{instance}}
.
Aqui está um exemplo de corpo JSON para configurar um bot:
enabled
: Ativa (true
) ou desativa (false
) o bot.url
: URL da API do Typebot (sem a /
no final).typebot
: Nome público do bot no Typebot.triggerType
: Tipo de trigger para iniciar o bot (keyword
, all
, none
).triggerOperator
: Operador utilizado para avaliar o trigger (contains
, equals
, startsWith
, endsWith
, regex
).triggerValue
: Valor utilizado no trigger (por exemplo, uma palavra-chave ou regex).expire
: Tempo em minutos após o qual o bot expira, reiniciando se a sessão expirou.keywordFinish
: Palavra-chave que, quando recebida, encerra a sessão do bot.delayMessage
: Delay (em milissegundos) para simular a digitação antes de enviar uma mensagem.unknownMessage
: Mensagem enviada quando a entrada do usuário não é reconhecida.listeningFromMe
: Define se o bot deve escutar as mensagens enviadas pelo próprio usuário (true
ou false
).stopBotFromMe
: Define se o bot deve parar quando o próprio usuário envia uma mensagem (true
ou false
).keepOpen
: Mantém a sessão aberta, evitando que o bot seja reiniciado para o mesmo contato.debounceTime
: Tempo (em segundos) para juntar várias mensagens em uma só.Você pode gerenciar as sessões do Typebot para cada contato específico, alterando o status da sessão entre aberta, pausada ou fechada.
Aqui está um exemplo de como gerenciar o status da sessão:
remoteJid
: JID (identificador) do contato no WhatsApp.status
: Status da sessão (opened
, paused
, closed
).Você pode definir configurações padrão que serão aplicadas caso os parâmetros não sejam passados durante a criação do bot.
Aqui está um exemplo de configuração padrão:
expire
: Tempo em minutos após o qual o bot expira.keywordFinish
: Palavra-chave que encerra a sessão do bot.delayMessage
: Delay para simular a digitação antes de enviar uma mensagem.unknownMessage
: Mensagem enviada quando a entrada do usuário não é reconhecida.listeningFromMe
: Define se o bot deve escutar as mensagens enviadas pelo próprio usuário.stopBotFromMe
: Define se o bot deve parar quando o próprio usuário envia uma mensagem.keepOpen
: Mantém a sessão aberta, evitando que o bot seja reiniciado para o mesmo contato.debounceTime
: Tempo para juntar várias mensagens em uma só.ignoreJids
: Lista de JIDs de contatos que não ativarão o bot.typebotIdFallback
: ID do bot de fallback que será utilizado caso nenhum trigger seja ativado.Além de usar triggers, você pode inicializar um bot de forma ativa para um contato específico usando o endpoint /typebot/start/{{instance}}
.
Aqui está um exemplo de como iniciar um bot de forma ativa:
url
: URL da API do Typebot (sem a /
no final).typebot
: Nome público do bot no Typebot.remoteJid
: JID (identificador) do contato no WhatsApp.startSession
: Define se a sessão deve ser iniciada com o bot (true
ou false
).variables
: Variáveis personalizadas que podem ser passadas ao bot (por exemplo, nome do usuário).Quando uma sessão do Typebot é iniciada, algumas variáveis predefinidas são automaticamente enviadas:
remoteJid
: JID do contato com quem o bot está interagindo.pushName
: Nome do contato no WhatsApp.instanceName
: Nome da instância que está executando o bot.serverUrl
: URL do servidor onde a Evolution API está hospedada.apiKey
: Chave de API usada para autenticar as requisições.ownerJid
: JID do número de telefone conectado à instância.startTypebot
Quando você utiliza o endpoint startTypebot
, as variáveis passadas no corpo da requisição são combinadas com as variáveis predefinidas. Isso permite que você adicione ou sobrescreva informações específicas para personalizar ainda mais a interação do bot.
A integração da Evolution API com o Typebot oferece uma maneira poderosa e flexível de automatizar interações no WhatsApp. Com variáveis predefinidas e a capacidade de iniciar bots de forma ativa, você pode personalizar a experiência do usuário final e otimizar o fluxo de atendimento.
A Evolution API permite integrar bots do Typebot para automatizar interações e responder a mensagens do WhatsApp com base em triggers configurados. A seguir, você encontrará as instruções detalhadas sobre como configurar, gerenciar sessões, inicializar bots manualmente e utilizar variáveis predefinidas.
Você pode configurar diversos bots no Typebot utilizando triggers para iniciar as interações. A configuração do bot pode ser feita através do endpoint /typebot/create/{{instance}}
.
Aqui está um exemplo de corpo JSON para configurar um bot:
enabled
: Ativa (true
) ou desativa (false
) o bot.url
: URL da API do Typebot (sem a /
no final).typebot
: Nome público do bot no Typebot.triggerType
: Tipo de trigger para iniciar o bot (keyword
, all
, none
).triggerOperator
: Operador utilizado para avaliar o trigger (contains
, equals
, startsWith
, endsWith
, regex
).triggerValue
: Valor utilizado no trigger (por exemplo, uma palavra-chave ou regex).expire
: Tempo em minutos após o qual o bot expira, reiniciando se a sessão expirou.keywordFinish
: Palavra-chave que, quando recebida, encerra a sessão do bot.delayMessage
: Delay (em milissegundos) para simular a digitação antes de enviar uma mensagem.unknownMessage
: Mensagem enviada quando a entrada do usuário não é reconhecida.listeningFromMe
: Define se o bot deve escutar as mensagens enviadas pelo próprio usuário (true
ou false
).stopBotFromMe
: Define se o bot deve parar quando o próprio usuário envia uma mensagem (true
ou false
).keepOpen
: Mantém a sessão aberta, evitando que o bot seja reiniciado para o mesmo contato.debounceTime
: Tempo (em segundos) para juntar várias mensagens em uma só.Você pode gerenciar as sessões do Typebot para cada contato específico, alterando o status da sessão entre aberta, pausada ou fechada.
Aqui está um exemplo de como gerenciar o status da sessão:
remoteJid
: JID (identificador) do contato no WhatsApp.status
: Status da sessão (opened
, paused
, closed
).Você pode definir configurações padrão que serão aplicadas caso os parâmetros não sejam passados durante a criação do bot.
Aqui está um exemplo de configuração padrão:
expire
: Tempo em minutos após o qual o bot expira.keywordFinish
: Palavra-chave que encerra a sessão do bot.delayMessage
: Delay para simular a digitação antes de enviar uma mensagem.unknownMessage
: Mensagem enviada quando a entrada do usuário não é reconhecida.listeningFromMe
: Define se o bot deve escutar as mensagens enviadas pelo próprio usuário.stopBotFromMe
: Define se o bot deve parar quando o próprio usuário envia uma mensagem.keepOpen
: Mantém a sessão aberta, evitando que o bot seja reiniciado para o mesmo contato.debounceTime
: Tempo para juntar várias mensagens em uma só.ignoreJids
: Lista de JIDs de contatos que não ativarão o bot.typebotIdFallback
: ID do bot de fallback que será utilizado caso nenhum trigger seja ativado.Além de usar triggers, você pode inicializar um bot de forma ativa para um contato específico usando o endpoint /typebot/start/{{instance}}
.
Aqui está um exemplo de como iniciar um bot de forma ativa:
url
: URL da API do Typebot (sem a /
no final).typebot
: Nome público do bot no Typebot.remoteJid
: JID (identificador) do contato no WhatsApp.startSession
: Define se a sessão deve ser iniciada com o bot (true
ou false
).variables
: Variáveis personalizadas que podem ser passadas ao bot (por exemplo, nome do usuário).Quando uma sessão do Typebot é iniciada, algumas variáveis predefinidas são automaticamente enviadas:
remoteJid
: JID do contato com quem o bot está interagindo.pushName
: Nome do contato no WhatsApp.instanceName
: Nome da instância que está executando o bot.serverUrl
: URL do servidor onde a Evolution API está hospedada.apiKey
: Chave de API usada para autenticar as requisições.ownerJid
: JID do número de telefone conectado à instância.startTypebot
Quando você utiliza o endpoint startTypebot
, as variáveis passadas no corpo da requisição são combinadas com as variáveis predefinidas. Isso permite que você adicione ou sobrescreva informações específicas para personalizar ainda mais a interação do bot.
A integração da Evolution API com o Typebot oferece uma maneira poderosa e flexível de automatizar interações no WhatsApp. Com variáveis predefinidas e a capacidade de iniciar bots de forma ativa, você pode personalizar a experiência do usuário final e otimizar o fluxo de atendimento.