Saturn Studio – Evolution API WhatsApp
Evolution API es una API gratuita y de código abierto para integrar WhatsApp en aplicaciones, permitiendo enviar y recibir mensajes, gestionar instancias y más funcionalidades avanzadas.
Descripción de los comandos
Crear instancia
Crear una nueva instancia de WhatsApp en Evolution API
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para crear instancias | credencial |
| Nombre de la instancia | Nombre único para identificar la instancia de WhatsApp | mi_instancia_whatsapp |
| Token (opcional) | Token opcional para autenticación adicional | token_secreto |
| URL del Webhook (opcional) | URL del webhook para recibir eventos | https://mi-servidor.com/webhook |
| Asignar resultado a variable | Variable donde se almacenará el resultado | {var} |
Conectar a WhatsApp
Conectar la instancia a WhatsApp y generar código QR
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para conectar | credencial |
| Nombre de la instancia | Nombre de la instancia creada previamente | mi_instancia_whatsapp |
| Asignar resultado a variable | Variable donde se almacenará el resultado | {var} |
Obtener código QR
Obtener el código QR para escanear con WhatsApp
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para obtener el QR | credencial |
| Nombre de la instancia | Nombre de la instancia para obtener el QR | mi_instancia_whatsapp |
| Asignar resultado a variable | Variable donde se almacenará el código QR | {var} |
Enviar mensaje
Enviar un mensaje de texto a un número de WhatsApp
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para enviar mensajes | credencial |
| Nombre de la instancia | Nombre de la instancia conectada a WhatsApp | mi_instancia_whatsapp |
| Número de teléfono | Número de WhatsApp al que enviar el mensaje (con código de país) | 5491123456789 |
| Mensaje | Mensaje de texto a enviar | Hola, ¿cómo estás? |
| Asignar resultado a variable | Variable donde se almacenará el resultado | {var} |
Esperar mensaje
Esperar un mensaje del usuario vía webhook
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para recibir mensajes | credencial |
| Asignar resultado a variable | Variable donde se almacenará el mensaje recibido | {var} |
Descargar media
Descargar archivos multimedia de mensajes
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para descargar media | credencial |
| Nombre de la instancia | Nombre de la instancia conectada a WhatsApp | mi_instancia_whatsapp |
| Clave del mensaje | Clave del mensaje que contiene el archivo multimedia | mensaje_key_123 |
| Asignar resultado a variable | Variable donde se almacenará el archivo descargado | {var} |
Enviar media
Enviar archivos multimedia (imágenes, videos, documentos)
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para enviar media | credencial |
| Nombre de la instancia | Nombre de la instancia conectada a WhatsApp | mi_instancia_whatsapp |
| Número de teléfono | Número de WhatsApp al que enviar el archivo | 5491123456789 |
| Variable del archivo | Variable que contiene el archivo a enviar | archivo_variable |
| Leyenda (opcional) | Texto que acompañará al archivo multimedia | Descripción del archivo |
| Asignar resultado a variable | Variable donde se almacenará el resultado | {var} |
Información de instancia
Obtener información y estado de una instancia
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para obtener información | credencial |
| Nombre de la instancia | Nombre de la instancia para consultar información | mi_instancia_whatsapp |
| Asignar resultado a variable | Variable donde se almacenará la información | {var} |
Eliminar instancia
Eliminar una instancia de WhatsApp
| Parámetros | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de Evolution API necesaria para eliminar instancias | credencial |
| Nombre de la instancia | Nombre de la instancia a eliminar | mi_instancia_whatsapp |
| Asignar resultado a variable | Variable donde se almacenará el resultado | {var} |
Configuración de credenciales
Para usar este módulo, necesita configurar una credencial de tipo “Evolution API” con los siguientes campos:
- URL Base de la API: URL completa de su servidor Evolution API (ej: https://api.evolution-api.com)
- API Key: Clave de API proporcionada por Evolution API para autenticación
Instalación de Evolution API
Para instalar Evolution API en su servidor, puede seguir la documentación oficial en: https://doc.evolution-api.com/
Instalación rápida con Docker
docker run -d \
--name evolution_api \
-p 8080:8080 \
-e AUTHENTICATION_API_KEY=su-api-key-aqui \
atendai/evolution-api:latest
Ejemplos de uso
1. Crear y conectar una instancia
- Usar el comando “Crear instancia” con el nombre “mi_bot”
- Usar el comando “Conectar a WhatsApp” para generar el QR
- Usar el comando “Obtener código QR” para mostrar el QR al usuario
- Escanear el QR con WhatsApp
2. Enviar un mensaje
Una vez conectada la instancia, usar el comando “Enviar mensaje” con:
- Nombre de instancia: “mi_bot”
- Número: “5491123456789”
- Mensaje: “¡Hola! Este es un mensaje desde Evolution API”
3. Recibir mensajes
Usar el comando “Esperar mensaje” para recibir mensajes entrantes a través de webhooks.
Notas importantes
- Cada instancia debe tener un nombre único
- Los números de teléfono deben incluir el código de país sin el signo +
- Los webhooks requieren una URL accesible públicamente
- Evolution API maneja automáticamente la conexión de WhatsApp Web
- El módulo es compatible con todas las funcionalidades principales de WhatsApp