Send an image message
POST/api/sessions/:sessionId/messages/send-image
Send an image message
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 413
- 422
- 501
- 503
Image sent
Session not active, invalid request, or a url that answers non-2xx, times out or cannot be reached
The API key is missing, unknown, revoked, or expired
The API key's role, session or chat scope, or IP allow-list does not allow this operation
The quotedMessageId could not be resolved: the whatsapp-web.js page does not hold it, or the Baileys store does not (it was never received or sent by this session, or it was evicted or deleted). On whatsapp-web.js a message that resolves but cannot be replied to is sent without the quote.
The session is not connected: an engine exists for it but is not ready, meaning disconnected, reconnecting, or still initializing, so the request never reached WhatsApp. Wait for ready and retry. A send whose first attempt had already run when the session left ready (or WhatsApp Web reloaded its page) is the exception: it answers a 409 with no code that says the message may or may not have been sent, so check the chat before sending it again (a retry with the same Idempotency-Key answers IDEMPOTENCY_OUTCOME_UNKNOWN). A session that was never started answers 400 instead, and the session lifecycle routes answer 409 for a conflicting state rather than this. One window answers this while the session still reads ready: WhatsApp Web periodically reloads its own page and the engine re-injects into it, and until it has the answer is a 409 naming the reload, with code ENGINE_PAGE_RELOADING and retryAfterSeconds. That takes seconds on most reloads and can take a few minutes, and no event marks its end: ask again at that interval.
The decoded base64 media, or the media downloaded from url, exceeds the media byte cap (MEDIA_DOWNLOAD_MAX_BYTES, 50 MiB by default). A whole request is separately bounded by BODY_SIZE_LIMIT (25 mb by default), and base64 inflates by about a third, so a large send usually meets that coarser limit first: the body parser rejects the request before this check runs.
IDEMPOTENCY_KEY_REUSED: the Idempotency-Key was already used with a different route or body.
Sending media to a channel (<id>@newsletter) is not supported by the whatsapp-web.js engine — the page method it needs was removed by a WhatsApp Web update. Text to a channel still works. whatsapp-web.js also refuses a send with quotedMessageId to a channel (<id>@newsletter) or a status or broadcast list (@broadcast); nothing is sent.
The session routes its url fetches through an egress proxy, and the fetch failed or timed out before any response arrived, so the request was not carried out. The proxy or the target behind it may be at fault; the gateway cannot tell which. Retryable, but a 503 that persists while the proxy works points at the url. Without a session proxy the same failure answers 400. Baileys could not complete the recipient lookup within the request budget. On send routes, no message was handed to WhatsApp for this lookup failure. On Baileys, also when WhatsApp rate-limits the request (code 429: nothing was sent, and a keyed send frees its Idempotency-Key), times out a query it awaits (code 408: the outcome is not proven, and a keyed send keeps its Idempotency-Key taken), or the connection closes before the message is written (nothing was sent, and a keyed send frees its Idempotency-Key).