API referenceContacts
Check whether a phone number is on WhatsApp
Runs a live WhatsApp lookup for one phone number and returns JID if present.
Requires read and a connected session.
Errors: validation_error for bad phone, not_found for session ownership, not_implemented for disconnected session.
AuthorizationBearer <token>
Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.
In: header
Path Parameters
session*string
WhatsApp session id used for live lookup. Must be connected.
Example
"sess_01HZX"Query Parameters
phone?string
Phone number in digits, optionally with +.
Example
"+14155550123"Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sessions/sess_01HZX/contacts/check"{ "isOnWhatsApp": true, "jid": "string", "query": "string"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}