Preview a group from its invite code, without joining
GET/api/sessions/:sessionId/groups/join-info
Read-only: nothing about the account changes, which is what makes it safe to call on a code from an untrusted source. Supported on both engines.
There is no participant LIST — the account is not a member — only a count, and only when WhatsApp discloses one. Fields the engine does not report are omitted rather than defaulted, because whatsapp-web.js returns an untyped object with no guaranteed shape.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 501
- 503
What the invite discloses about the group
Session not started, or no code supplied
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
No such invite — invalid, expired or revoked
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.
On whatsapp-web.js, answered when the WhatsApp Web build the session runs has no job to preview an invite with. Nothing was asked of WhatsApp: the invite code is not judged.
WhatsApp did not answer within the request budget. Deliberately not folded into the 404 above — a query that never came back is not the same claim as a group that does not exist. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause. On whatsapp-web.js, also when WhatsApp answers the preview with a rate limit, a timeout or a server error (408, 423, 429 or 5xx): no group was returned, so retry after a pause. A 500 that carries no text, which the job in the page makes up when its query returns no group and no error, answers 404.