URL base
http://localhost:3000. Con APP_BASE_PATH=/gowa, cada ruta se mueve bajo /gowa excepto /health.
Autenticación
Cuando se estableceAPP_BASIC_AUTH, cada ruta requiere HTTP Basic Auth, excepto /health, /statics/*, el webhook de Chatwoot y los extremos de MCP OAuth. Ver Authentication.
Selección de dispositivo
La mayoría de las rutas actúan en un dispositivo WhatsApp. Elija con la cabeceraX-Device-Id (slot ID o JID), o el parámetro de consulta device_id. Cuando el servidor tiene exactamente un dispositivo que se puede omitir; con más, se necesita.
Ver Multi-device.
Grupos de punto final
Las páginas finales de esta pestaña se generan a partir de la especificación OpenAPI de GOWA. El contrato autorizado es
docs/openapi.yaml en el repositorio del servidor. Este sitio utiliza una copia sincronizada en openapi.yml, incluyendo /send/interactive. La guía interactiva registra sus límites actuales.
Solicitudes
- Cuerpos JSON:
Content-Type: application/json. - Subidas de archivos:
multipart/form-data. - Números de teléfono: dígitos con código de país (
628123456789) o un JID completo (...@s.whatsapp.net,...@g.us).
Respuestas
code es SUCCESS o un código de error; results contiene los datos. Ver Errors.
Ejemplo
Nombres de contacto
GET /user/my/contacts devuelve un nombre preferido para cada contacto. En GOWA main después de la v9.9. , llame a GET /user/my/contacts/detailed para obtener el full_name, first_name, push_name y business_name almacenados como campos separados. GOWA omite nombres vacíos e incluye lid en un número de teléfono JID cuando el dispositivo tiene un mapeo. Los resultados contienen contactos personales del dispositivo seleccionado, ordenados por jid.
Otras interfaces
- WebSocket en
/wspara eventos de panel en vivo. - MCP en
/mcppara agentes de IA (servidor MCP). - Webhooks hizo push a tus URLs (Webhooks).
