Look up the LID of a phone number
GET/api/sessions/:sessionId/contacts/:number/lid
Returns the <lid>@lid WhatsApp holds for a phone number, the reverse of GET /contacts/{contactId}/phone, without sending a message. A number WhatsApp holds no LID for answers lid: null, as does an unregistered one; use check/{number} to tell them apart. The gateway stores nothing from the lookup. Both engines may send a query to WhatsApp, so bulk lookups put the linked account at risk. Requires an OPERATOR key.
Request
Responses
- 200
- 400
- 401
- 403
- 409
- 503
The number and its LID, or null
Session is not started, or number is an id of another kind (a privacy id, a group or a channel) rather than a phone number
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 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.
WhatsApp did not answer the lookup. Deliberately not reported as lid: null, which says WhatsApp holds no LID for the number. Retry once the session is ready again.