Skip to content

Latest commit

 

History

History
191 lines (144 loc) · 6.2 KB

README.md

File metadata and controls

191 lines (144 loc) · 6.2 KB
Evolution API


Este Community Nodes é uma solução 100% gratuita, criada com o intuito de simplificar e auxiliar toda a comunidade a integrar e utilizar ao máximo os principais recursos oferecidos pela Evolution API v2 em seus projetos. Desenvolvido por OrionDesign.

🚨 Obs: Ainda em desenvolvimento🚨

📌 Recurso: Instancia

Este recurso oferece acesso a todas as principais funcionalidades relacionadas às instâncias da Evolution API. Com ele, você pode realizar diversas operações essenciais, como criar uma nova instância, conectar-se a ela, buscar informações, definir comportamentos personalizados, monitorar presença, reiniciar e até mesmo excluir instâncias de maneira simples e eficiente.

Segue a lista das funções relacionadas:

Criar Instancia

O nó "Criar Instância", assim como proprio nome já diz, cria uma nova instância na Evolution API. Você pode configurar o Nome da Instância, escolher a API Key e o Número para geração do "pairingCode", e ainda ajustar diversas opções adicionais, como Comportamento, Proxy, Webhook, RabbitMQ, e a integração com Chatwoot. Essa flexibilidade permite que à criação da instância seja adaptada a diferentes cenários e necessidades.

Obs: Esta função funciona apenas se estiver usando a Global API Key nas credenciais da Evolution API. ApiKey de instancia não tem poder para criar novas instancias.

Campo Descrição Obrigatório
Nome Da Instância Nome que será atribuido a instancia
Apikey Para Instancia ApiKey (token) que será utilizado para consumir api desta instancia
Número Do WhatsApp Numero que será utilizado para se conectar na instancia, usado para gerar o "pairingCode"
Opções Configurações e Integrações que podem ser adicionadas a instancia no momento de sua crição

Como já descrito, existe o campo de Opções, do qual você pode adicionar novas integrações a sua instancia, veja abaixo mais detalhes sobre cada opção:

👉🏽 Comportamento Aqui você pode definir como vai ser o comportamento da instancia:
Campo Descrição Obrigatório
Rejeitar Ligações Rejeitar automaticamente todas as ligações recebidas no Whatsapp
Mensagem Ao Rejeitar Mensagem que será enviada automaticamente após rejeitar uma ligação
Ignorar Grupos Não receber as mensagens de grupos na API
Sempre Online Deixar o Status sempre como Online
Ler Mensagens Todas as mensagens serão marcadas como lidas automaticamente, assim que recebidas
Ler Status Os Status dos contatos salvos irão chegar na API
Sincronizar Histórico Sincronizar todo o histórico de mensagens na API
👉🏽 Proxy Defina um Proxy para ser usado na instancia:
Campo Descrição Obrigatório
Host do Proxy Endereço ip/url do Proxy
Porta Do Proxy Porta do seu Proxy
Protocolo Do Proxy Protocolo Http (para IP ou URL sem SSL) ou Https (para URL com SSL)
Usuário Do Proxy Usuario do Proxy
Senha Do Proxy Senha do Proxy
👉🏽 Webhook Ative um endereço para consumir o Webhook a partir de eventos da Evolution API
Campo Descrição Obrigatório
Url Do Webhook Url que será enviado os eventos da Evolution API
Webhook Por Eventos Cria uma rota para cada evento adicionando o nome do evento no final da URL
Base64 No Webhook Envie os dados do base64 das mídias no webhook
Eventos Eventos que vai disparar o webhook
👉🏽 RabbitMQ Sem informações ainda.
👉🏽 Chatwoot Sem informações ainda.

Conectar Instancia
Buscar Instancia
Definir Comportamento
Definir Presença
Reiniciar Instancia
Desconectar Instancia
Deletar Instancia

📌 Recurso: Mensagem

Enviar Texto
Enviar Imagem
Enviar Video
Enviar Audio
Enviar Documento
Enviar Enquete
Enviar Status

📌 Recurso: Evento

Webhook
RabbitMQ

📌 Recurso: Integração

Proxy
Evolution Bot
Chatwoot
Typebot
Flowise
Dify
OpenAI
S3

🚨 Obs: Estas opções podem ser adicionadas ou removidas da versão final deste Node.🚨