Evolution API V1 (NicoApp)
Integração da Evolution API como Administrador. Gerenciador de instâncias. Apenas para versão até 1.8.3.
A Evolution API é um projeto open source que expõe o WhatsApp como API a partir de uma sessão conectada por QR Code, normalmente instalado no seu próprio servidor. Este MiniApp fala com ela em modo administrador: em vez de operar um número só, ele gerencia as instâncias do servidor — cria, conecta, reinicia e apaga — além de enviar mensagens por qualquer uma delas.
Site oficial: doc.evolution-api.com.
Nota
Você precisa de uma instalação própria da Evolution API e da API Key global do servidor (a mesma de
src/env.yml), não da chave de uma instância. Se você não administra o servidor, provavelmente quer outro MiniApp.Ao instalar o app no canal, preencha os campos abaixo. Eles valem para todas as ações.
Campo
Obrigatório
Observação
URL base
Sim
O endereço da sua instalação, por exemplo https://evolution.seudominio.com.br.
Api Key Global
Sim
A chave global do servidor, presente em src/env.yml. Não é a chave de uma instância.
Cada ação é um bloco que você usa dentro do fluxo. As entradas listadas são as obrigatórias; as saídas viram variáveis para as etapas seguintes.
Ação
O que faz
Entradas obrigatórias
Saídas
Criar Instância
Cria uma instância nova e devolve o QR Code para conectar o número.
Nome da Instância, Numero do Telefone a Conectar
JSON QR Code, API-KEY
Conectar Instância
Gera o QR Code de conexão de uma instância existente.
Nome da Instância, Numero do Telefone a Conectar
JSON QR Code
Obter Instâncias
Lista as instâncias do servidor.
—
Instâncias
Reiniciar Instância
Reinicia a instância.
Nome da Instância
—
Desconectar Instância
Encerra a sessão do número, sem apagar a instância.
Nome da Instância
—
Apagar Instância
Remove a instância do servidor.
Nome da Instância
—
Definir Webhook de CONNECTION_UPDATE
Aponta para onde a Evolution avisa mudanças de conexão da instância.
Nome da Instância, URL do Webhook
—
Enviar Mensagem
Envia texto por uma das instâncias.
Remetente, Destinatario, Mensagem
id, remoteJid
Enviar Mensagem como Resposta
Envia texto citando a mensagem anterior do contato.
Remetente, Destinatario, Mensagem
id, remoteJid
Enviar Imagem
Envia imagem a partir de uma URL, com legenda opcional.
Remetente, Destinatario, URL
id, remoteJid
Enviar Video
Envia vídeo a partir de uma URL, com legenda opcional.
Remetente, Destinatario, URL
id, remoteJid
Enviar Documento
Envia arquivo a partir de uma URL.
Remetente, Destinatario, URL
id, remoteJid
Enviar Sticker
Envia figurinha a partir de uma URL.
Remetente, Destinatario, URL
id, remoteJid
Enviar Contato
Envia um cartão de contato.
Remetente, Destinatario, Nome do Contato, Telefone do Contato
id, remoteJid
Enviar Menção Fantasma
Envia texto num grupo mencionando todos sem exibir as menções.
Remetente, Destinatário (grupo)
id, remoteJid
Editar Foto de Perfil
Troca a foto do número conectado.
Nome da Instância, URL da Foto de Perfil
—
Remover Foto de Perfil
Apaga a foto do número conectado.
Nome da Instância
—
Editar Status do Perfil
Troca o recado do perfil (até 139 caracteres).
Nome da Instância, Status do Perfil
—
Obter Configurações de Privacidade
Lê as preferências de privacidade do número.
Nome da Instância
readreceipts, profile, online, last, groupadd
Editar Configurações de Privacidade
Altera confirmação de leitura, visibilidade de perfil, online, visto por último e quem pode adicionar em grupo.
Nome da Instância, readreceipts, profile, online, last, groupadd
—
Obter Dados do Anúncio Recebido
Lê os dados do anúncio que originou a conversa.
—
Título do Anúncio, Corpo do Anúncio, ID de Origem (sourceId), ID do Clique (ctwaClid), URL de Origem, URL da Thumbnail, Tipo de Midia
- Só funciona na Evolution API até a versão 1.8.3. Instalações em versão mais nova falam outro dialeto e precisam de outro MiniApp.
- Este app usa a chave global, que manda no servidor inteiro — inclusive apagar instância. Trate-a como credencial de administrador e não a compartilhe com quem só precisa enviar mensagem.
- No envio, o Remetente é a instância que dispara: dá para atender vários números do mesmo servidor a partir de um único fluxo.
- O campo Delay, em milissegundos, espaça os envios — útil para não disparar tudo no mesmo instante.
- Obter Dados do Anúncio Recebido não pede parâmetro: coloque o bloco no fluxo de quem chegou por anúncio e ele lê a mensagem de origem, desde que ela esteja entre as últimas 100 trocadas.
- Como toda conexão por QR Code, isto não é a API Oficial do WhatsApp — vale o mesmo cuidado com volume e mensagem não solicitada.
- NicoApps (MiniApps) Nativos — a lista completa de integrações prontas