Create a WhatsApp Session (QR / Pairing Login)
View All WhatsApp Messaging API APIs →Start logging in to your WhatsApp account and get a sessionId used by every other endpoint. Choose mode=qr to scan a QR code (recommended) or mode=pairing to enter a pairing code on your phone (requires phoneNumber). The response includes the session status and, for QR sessions, a scannable qrImage plus a qrPageUrl — a ready-to-open page that shows the live QR code and login status. Poll Get Session Status until it reads CONNECTED, then start sending messages. deviceName sets the label shown under WhatsApp's Linked Devices.
API Features
QR or pairing login Link your account by scanning a QR code or entering a pairing code on your phone — no lengthy approval process
Live QR page Open the returned qrPageUrl to watch the QR code and login status update in real time until connected
Reusable sessionId One sessionId authorizes every messaging, contact, group, and profile endpoint for that connection
Named linked device Set deviceName to control the label shown under WhatsApp's Linked Devices for auditing
Live API Demo
🔒 Sign in to try it live
Log in to call this API with your own API key. New accounts get 1000 free credits — no card required.
Log in / Sign upNo active API key found. Create one in your Dashboard, then reload this page.Dashboard →
API Response (JSON)
{} Query Result
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Use Cases
- Bootstrap a WhatsApp bot or automation by linking an authorized account
- Onboard users into a support channel with a scan-to-connect flow
- Re-link a dropped connection to resume sending and receiving messages