Server
| Variable | Valor | Ejemplo |
|---|---|---|
| SERVER_TYPE | El tipo de servidor (http o https) | http |
| SERVER_PORT | Puerto en el que se ejecutará el servidor | 8080 |
| SERVER_URL | La dirección de su servidor en ejecución. Esta dirección se utiliza para devolver datos de solicitudes internas, como enlaces de webhook. | https://ejemplo.evolution-api.com |
Telemetría
| Variable | Valor | Ejemplo |
|---|---|---|
| TELEMETRY | Habilita o deshabilita la telemetría (true o false) | true |
| TELEMETRY_URL | URL del servidor de telemetría | https://telemetry.example.com |
CORS
| Variable | Valor | Ejemplo |
|---|---|---|
| CORS_ORIGIN | Los orígenes permitidos por la API separados por coma (utilice ”*” para aceptar solicitudes de cualquier origen) | * |
| CORS_METHODS | Métodos HTTP permitidos separados por coma | GET,POST,PUT,DELETE |
| CORS_CREDENTIALS | Permiso de cookies en solicitudes (true o false) | true |
Logs
| Variable | Valor | Ejemplo |
|---|---|---|
| LOG_LEVEL | Logs que se mostrarán entre: ERROR, WARN, DEBUG, INFO, LOG, VERBOSE, DARK, WEBHOOKS | ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS |
| LOG_COLOR | Mostrar o no colores en los Logs (true o false) | true |
| LOG_BAILEYS | Qué logs de Baileys se mostrarán entre: “fatal”, “error”, “warn”, “info”, “debug”, “trace” | error |
Instancias
| Variable | Valor | Ejemplo |
|---|---|---|
| DEL_INSTANCE | En cuántos minutos se eliminará una instancia si no está conectada. Use “false” para nunca eliminar | false |
Almacenamiento Persistente
| Variable | Valor | Ejemplo |
|---|---|---|
| DATABASE_ENABLED | Si el almacenamiento persistente está habilitado (true o false) | true |
| DATABASE_PROVIDER | Proveedor de base de datos (postgresql o mysql) | postgresql |
| DATABASE_CONNECTION_URI | La URI de conexión de la base de datos | postgresql://user:pass@localhost:5432/evolution?schema=public |
| DATABASE_CONNECTION_CLIENT_NAME | Nombre del cliente para la conexión con la base de datos, usado para separar una instalación de la API de otra que usa la misma base de datos | evolution_exchange |
Qué datos se guardarán (true o false)
| Variable | Valor |
|---|---|
| DATABASE_SAVE_DATA_INSTANCE | Guarda datos de instancias |
| DATABASE_SAVE_DATA_NEW_MESSAGE | Guarda nuevos mensajes |
| DATABASE_SAVE_MESSAGE_UPDATE | Guarda actualizaciones de mensajes |
| DATABASE_SAVE_DATA_CONTACTS | Guarda contactos |
| DATABASE_SAVE_DATA_CHATS | Guarda conversaciones |
| DATABASE_SAVE_DATA_LABELS | Guarda etiquetas |
| DATABASE_SAVE_DATA_HISTORIC | Guarda historial de eventos |
RabbitMQ
| Variable | Valor | Ejemplo |
|---|---|---|
| RABBITMQ_ENABLED | Habilita RabbitMQ (true o false) | false |
| RABBITMQ_URI | URI de conexión de RabbitMQ | amqp://localhost |
| RABBITMQ_EXCHANGE_NAME | Nombre del exchange | evolution |
| RABBITMQ_GLOBAL_ENABLED | Habilita RabbitMQ de forma global (true o false) | false |
Elija los eventos que desea enviar a RabbitMQ
| Variable | Valor | Ejemplo |
|---|---|---|
| RABBITMQ_EVENTS_APPLICATION_STARTUP | Envía un evento al iniciar la aplicación (true o false) | false |
| RABBITMQ_EVENTS_INSTANCE_CREATE | Envía eventos de creación de instancia (true o false) | false |
| RABBITMQ_EVENTS_INSTANCE_DELETE | Envía eventos de eliminación de instancia (true o false) | false |
| RABBITMQ_EVENTS_QRCODE_UPDATED | Envía eventos de actualización del QR Code (true o false) | false |
| RABBITMQ_EVENTS_MESSAGES_SET | Envía eventos de creación de mensajes (recuperación de mensajes) (true o false) | false |
| RABBITMQ_EVENTS_MESSAGES_UPSERT | Envía eventos de recepción de mensajes (true o false) | false |
| RABBITMQ_EVENTS_MESSAGES_EDITED | Envía eventos de edición de mensajes (true o false) | false |
| RABBITMQ_EVENTS_MESSAGES_UPDATE | Envía eventos de actualización de mensajes (true o false) | false |
| RABBITMQ_EVENTS_MESSAGES_DELETE | Envía eventos de eliminación de mensajes (true o false) | false |
| RABBITMQ_EVENTS_SEND_MESSAGE | Envía eventos de envío de mensajes (true o false) | false |
| RABBITMQ_EVENTS_CONTACTS_SET | Envía eventos de creación de contactos (true o false) | false |
| RABBITMQ_EVENTS_CONTACTS_UPSERT | Envía eventos de recuperación de contactos (true o false) | false |
| RABBITMQ_EVENTS_CONTACTS_UPDATE | Envía eventos de actualización de contactos (true o false) | false |
| RABBITMQ_EVENTS_PRESENCE_UPDATE | Envía eventos de actualización de presencia (“escribiendo…” o “grabando…”) (true o false) | false |
| RABBITMQ_EVENTS_CHATS_SET | Envía eventos de creación de conversaciones (recuperación de conversaciones) (true o false) | false |
| RABBITMQ_EVENTS_CHATS_UPSERT | Envía eventos de creación de conversaciones (recepción o envío de mensajes en nuevos chats) (true o false) | false |
| RABBITMQ_EVENTS_CHATS_UPDATE | Envía eventos de actualización de conversaciones (true o false) | false |
| RABBITMQ_EVENTS_CHATS_DELETE | Envía eventos de eliminación de conversaciones (true o false) | false |
| RABBITMQ_EVENTS_GROUPS_UPSERT | Envía eventos de creación de grupos (true o false) | false |
| RABBITMQ_EVENTS_GROUP_UPDATE | Envía eventos de actualización de grupos (true o false) | false |
| RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE | Envía eventos de actualización en los participantes de grupos (true o false) | false |
| RABBITMQ_EVENTS_CONNECTION_UPDATE | Envía eventos de actualización de conexión (true o false) | false |
| RABBITMQ_EVENTS_CALL | Envía eventos de llamadas (true o false) | false |
| RABBITMQ_EVENTS_TYPEBOT_START | Envía eventos de inicio de flujo de Typebot (true o false) | false |
| RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS | Envía eventos de actualización en el estado de Typebot (true o false) | false |
SQS
| Variable | Valor | Ejemplo |
|---|---|---|
| SQS_ENABLED | Si SQS está habilitado (true o false) | false |
| SQS_ACCESS_KEY_ID | El ID de clave de SQS | - |
| SQS_SECRET_ACCESS_KEY | Clave de acceso | - |
| SQS_ACCOUNT_ID | ID de la cuenta | - |
| SQS_REGION | Región de SQS | - |
WebSocket
| Variable | Valor | Ejemplo |
|---|---|---|
| WEBSOCKET_ENABLED | Habilita WebSocket (true o false) | false |
| WEBSOCKET_GLOBAL_EVENTS | Habilita eventos globales en WebSocket (true o false) | false |
WhatsApp Business API
| Variable | Valor | Ejemplo |
|---|---|---|
| WA_BUSINESS_TOKEN_WEBHOOK | Token usado para validar el webhook en Facebook APP | evolution |
| WA_BUSINESS_URL | URL de la API de WhatsApp Business | https://graph.facebook.com |
| WA_BUSINESS_VERSION | Versión de la API de WhatsApp Business | v20.0 |
| WA_BUSINESS_LANGUAGE | Idioma de la API de WhatsApp Business | en_US |
Webhook Global
| Variable | Valor | Ejemplo |
|---|---|---|
| WEBHOOK_GLOBAL_ENABLED | Si los webhooks están habilitados globalmente (true o false) | false |
| WEBHOOK_GLOBAL_URL | URL que recibirá las solicitudes de webhook | https://webhook.example.com |
| WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS | Activa webhook por evento, respetando la URL global y el nombre de cada evento (true o false) | false |
Eventos de webhook con valor true o false
| Variable |
|---|
| WEBHOOK_EVENTS_APPLICATION_STARTUP |
| WEBHOOK_EVENTS_QRCODE_UPDATED |
| WEBHOOK_EVENTS_MESSAGES_SET |
| WEBHOOK_EVENTS_MESSAGES_UPSERT |
| WEBHOOK_EVENTS_MESSAGES_EDITED |
| WEBHOOK_EVENTS_MESSAGES_UPDATE |
| WEBHOOK_EVENTS_MESSAGES_DELETE |
| WEBHOOK_EVENTS_SEND_MESSAGE |
| WEBHOOK_EVENTS_CONTACTS_SET |
| WEBHOOK_EVENTS_CONTACTS_UPSERT |
| WEBHOOK_EVENTS_CONTACTS_UPDATE |
| WEBHOOK_EVENTS_PRESENCE_UPDATE |
| WEBHOOK_EVENTS_CHATS_SET |
| WEBHOOK_EVENTS_CHATS_UPSERT |
| WEBHOOK_EVENTS_CHATS_UPDATE |
| WEBHOOK_EVENTS_CHATS_DELETE |
| WEBHOOK_EVENTS_GROUPS_UPSERT |
| WEBHOOK_EVENTS_GROUPS_UPDATE |
| WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE |
| WEBHOOK_EVENTS_CONNECTION_UPDATE |
| WEBHOOK_EVENTS_LABELS_EDIT |
| WEBHOOK_EVENTS_LABELS_ASSOCIATION |
| WEBHOOK_EVENTS_CALL |
| WEBHOOK_EVENTS_TYPEBOT_START |
| WEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS |
| WEBHOOK_EVENTS_ERRORS |
| WEBHOOK_EVENTS_ERRORS_WEBHOOK |
Configuraciones de Sesión
| Variable | Valor | Ejemplo |
|---|---|---|
| CONFIG_SESSION_PHONE_CLIENT | Nombre que se mostrará en la conexión del smartphone | Evolution API |
| CONFIG_SESSION_PHONE_NAME | Nombre del navegador (Chrome, Firefox, Edge, Opera, Safari) | Chrome |
QR Code
| Variable | Valor | Ejemplo |
|---|---|---|
| QRCODE_LIMIT | Por cuánto tiempo durará el QR code | 30 |
| QRCODE_COLOR | Color del QR code generado | #175197 |
Typebot
| Variable | Valor | Ejemplo |
|---|---|---|
| TYPEBOT_API_VERSION | Versión de la API (versión fija o latest) | latest |
Chatwoot
| Variable | Valor | Ejemplo |
|---|---|---|
| CHATWOOT_ENABLED | Habilita la integración con Chatwoot (true o false) | false |
| CHATWOOT_MESSAGE_READ | Marca como leído el último mensaje del cliente en WhatsApp al enviar un mensaje en Chatwoot (true o false) | true |
| CHATWOOT_MESSAGE_DELETE | Elimina el mensaje en Chatwoot cuando se elimina en WhatsApp (true o false) | true |
| CHATWOOT_IMPORT_DATABASE_CONNECTION_URI | URI de conexión con la base de datos de Chatwoot para importar mensajes | postgresql://user:password@host:5432/chatwoot?sslmode=disable |
| CHATWOOT_IMPORT_PLACEHOLDER_MEDIA_MESSAGE | Importa los mensajes de medios como placeholder en Chatwoot (true o false) | true |
OpenAI
| Variable | Valor | Ejemplo |
|---|---|---|
| OPENAI_ENABLED | Habilita la integración con OpenAI (true o false) | false |
Dify
| Variable | Valor | Ejemplo |
|---|---|---|
| DIFY_ENABLED | Habilita la integración con Dify (true o false) | false |
Caché
| Variable | Valor | Ejemplo |
|---|---|---|
| CACHE_REDIS_ENABLED | Habilita la caché Redis (true o false) | true |
| CACHE_REDIS_URI | La URI de conexión de Redis | redis://localhost:6379/6 |
| CACHE_REDIS_PREFIX_KEY | Prefijo para diferenciar datos de una instalación a otra usando el mismo Redis | evolution |
| CACHE_REDIS_SAVE_INSTANCES | Guarda las credenciales de conexión de WhatsApp en Redis (true o false) | false |
| CACHE_LOCAL_ENABLED | Habilita la caché local en memoria como alternativa a Redis (true o false) | false |
Amazon S3 / MinIO
| Variable | Valor | Ejemplo |
|---|---|---|
| S3_ENABLED | Habilita el almacenamiento en S3 (true o false) | false |
| S3_ACCESS_KEY | Clave de acceso de S3 | - |
| S3_SECRET_KEY | Clave secreta de S3 | - |
| S3_BUCKET | Nombre del bucket en S3 | evolution |
| S3_PORT | Puerto de conexión a S3 | 443 |
| S3_ENDPOINT | Endpoint de S3 (o MinIO) | s3.amazonaws.com |
| S3_USE_SSL | Usa SSL para conexión a S3 (true o false) | true |
Autenticación
| Variable | Valor | Ejemplo |
|---|---|---|
| AUTHENTICATION_API_KEY | Clave de la API usada para autenticación global | 429683C4C977415CAAFCCE10F7D57E11 |
| AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES | Muestra las instancias en el endpoint de fetch (true o false) | true |
Idioma
| Variable | Valor | Ejemplo |
|---|---|---|
| LANGUAGE | Idioma de la API | en |