Get Session Status
View All WhatsApp Messaging API APIs →Return the current state of a session: its status (CREATED, WAITING_FOR_SCAN, CONNECTING, CONNECTED, DISCONNECTED, LOGGED_OUT, or FAILED), the login mode, the linked phone number, and — while waiting for login — the qrImage (base64 data-URI) or pairingCode plus a qrPageUrl. If the account has saved credentials but is offline, this call lazily reloads it and triggers a reconnect. Poll it after Create Session until status is CONNECTED.
API Features
Real-time status Reports the exact lifecycle state so you know when the session is ready to send
QR & pairing payload While logging in, returns the qrImage or pairingCode plus a qrPageUrl to display to the user
Lazy reconnect Automatically reloads and reconnects an offline account that still has saved credentials
Live API Demo
🔒 Sign in to try it live
Log in to call this API with your own API key. New accounts get 100 free credits — no card required.
Log in / Sign upNo active API key found. Create one in your Dashboard, then reload this page. Dashboard →
GET
/api/project/whatsapp-messaging/get-session API Response (JSON)
{} Query Result
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Use Cases
- Drive a scan-to-login UI by polling until CONNECTED
- Health-check a session before sending a batch of messages
- Surface disconnect reasons in an operations dashboard