OpenWA API
Open Source WhatsApp API Gateway - Free, Self-Hosted HTTP API
Gateway-wide responses. Three statuses are returned by middleware before routing, so any operation can emit them:
415 Unsupported Media Type— the request body carries aContent-Encodingother thanidentity. The aggregate in-flight body cap counts wire bytes, so a compressed body would be admitted on its compressed size and then inflated past the memory it is meant to bound. Send the body uncompressed.413 Payload Too Large: the declaredContent-Lengthis more than the gateway could hold in flight for this caller even when idle. The body is not read; retrying it unchanged cannot succeed.503 Service UnavailablewithRetry-After— the gateway already has too much request body data in flight (the body is not read; retry after the given delay), or, withoutRetry-After, shutdown teardown has begun: every route except/api/healthand/api/health/*then answers it withConnection: close.
Every operation that takes an API key can also answer 429 Too Many Requests (the per-IP rate-limit windows; with send pacing on, a send can also be refused with code: SEND_PACING_LIMITED and retryAfterSeconds) and 500 Internal Server Error (an unexpected failure, or code: ENGINE_PAGE_ERROR when WhatsApp Web threw inside the page during a whatsapp-web.js send or status post). Error bodies follow the ErrorResponse schema.
Authentication
- API Key: X-API-Key
- HTTP: Bearer Auth
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
METRICS_TOKEN for the GET /api/metrics scrape endpoint
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | opaque |
Contact OpenWA: yudhi@rmyndharis.com