> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Referencia API

> URL base, autenticación, selección de dispositivos, formatos de solicitud y el sobre de respuesta para la API GOWA REST.

## URL base

```text theme={null}
http://<host>:3000<APP_BASE_PATH>
```

El valor por defecto es `http://localhost:3000`. Con `APP_BASE_PATH=/gowa`, cada ruta se mueve bajo `/gowa` excepto `/health`.

## Autenticación

Cuando se establece `APP_BASIC_AUTH`, cada ruta requiere HTTP Basic Auth, excepto `/health`, `/statics/*`, el webhook de Chatwoot y los extremos de MCP OAuth. Ver [Authentication](https://gowa-docs.mintlify.site/es/api-reference/authentication.md).

## Selección de dispositivo

La mayoría de las rutas actúan en un dispositivo WhatsApp. Elija con la cabecera `X-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.

| Dispositivo con alcance | Sin ámbito de dispositivo |
| - | - |
| `/app/*` (excepto `/app/info` y `/app/metrics`), `/send/*`, `/message/*`, `/chat/*`, `/chats`, `/user/*`, `/group/*`, `/newsletter/*`, `/call/*` | `/devices*`, `/app/info`, `/app/metrics`, `/health`, `/mcp`, `/chatwoot/*` |

Ver [Multi-device](https://gowa-docs.mintlify.site/es/concepts/multidevice.md).

## Grupos de punto final

| Grupo | Propósito |
| - | - |
| Dispositivos | Crear, listar, iniciar sesión, cerrar sesión y eliminar ranuras de dispositivos; webhooks por dispositivo y configuraciones de Chatwoot. |
| App | Inicio de sesión (QR, código de emparejamiento, clave de acceso), salida, reconecta, estado, información y proceso del servidor, métricas de memoria, disco y dispositivos. |
| Enviar | Texto, medios, contacto, ubicación, enlace, encuesta, presencia; programación; envío inmediato interactivo experimental. |
| Mensaje | Reacto, editar, revocar, eliminar, leer, estar, avanzar, descargar medios. |
| Chatear | Lista de chats y mensajes; pin, archivo, temporizador desaparecido, petición de historial. |
| Usuario | Información del perfil, avatar, nombre push, privacidad, contactos, grupos, verificación de números. |
| Grupo | Crear, participantes, administradores, unirse a peticiones, configuración, enlaces de invitación. |
| Boletín | Seguir, dejar de seguir, información de canal, directorio, mensajes, contadores, actualizaciones en vivo y descarga de medios. |
| Llamar | Rechazar llamadas entrantes. |

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`](https://github.com/aldinokemal/go-whatsapp-web-multidevice/blob/main/docs/openapi.yaml) en el repositorio del servidor. Este sitio utiliza una copia sincronizada en `openapi.yml`, incluyendo `/send/interactive`. La [guía interactiva](https://gowa-docs.mintlify.site/es/examples/interactive-messages.md) 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

```json theme={null}
{
  "code": "SUCCESS",
  "message": "Success",
  "results": {}
}
```

`code` es `SUCCESS` o un código de error; `results` contiene los datos. Ver [Errors](https://gowa-docs.mintlify.site/es/api-reference/errors.md).

## Ejemplo

```bash theme={null}
curl -u admin:changeme -X POST http://localhost:3000/send/message \
  -H "Content-Type: application/json" \
  -H "X-Device-Id: my-device" \
  -d '{"phone": "628123456789", "message": "Hello from GOWA"}'
```

## 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`.

```bash theme={null}
curl -u admin:changeme -H "X-Device-Id: my-device" \
  http://localhost:3000/user/my/contacts/detailed
```

## Otras interfaces

* **[WebSocket](https://gowa-docs.mintlify.site/es/api-reference/websocket.md)** en `/ws` para eventos de panel en vivo.
* **MCP** en `/mcp` para agentes de IA ([servidor MCP](https://gowa-docs.mintlify.site/es/integrations/mcp.md)).
* **Webhooks** hizo push a tus URLs ([Webhooks](https://gowa-docs.mintlify.site/es/concepts/webhooks.md)).


## Related topics

- [Inicio rápido](https://gowa-docs.mintlify.site/es/quickstart.md)
- [Autenticación de API](https://gowa-docs.mintlify.site/es/api-reference/authentication.md)
- [Referencia de configuración](https://gowa-docs.mintlify.site/es/configuration.md)
- [Errores](https://gowa-docs.mintlify.site/es/api-reference/errors.md)
- [Python](https://gowa-docs.mintlify.site/es/api-reference/sdks/python.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.