WhatsApp Gateway
API referenceChats

Get chat presence

GET
/api/v1/sessions/{session}/chats/{cid}/presence

Subscribe to a contact's live WhatsApp presence and return the current presence snapshot.

WhatsApp presence is event-driven: this endpoint may return state: unknown immediately, then a later presence.update event updates the same chat/contact as available or unavailable. Requires read capability and a live connected session.

Errors: validation_error for a bad JID, not_found if the session is missing, not_implemented if the session is not connected, forbidden if missing read.

Authorization

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. Must belong to the caller organization.

Example"01HF..."
cid*string

Chat JID (for example 628...@s.whatsapp.net or 120...@g.us).

Example"6281234567890@s.whatsapp.net"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/sessions/01HF.../chats/6281234567890@s.whatsapp.net/presence"
{  "chatJid": "6281234567890@s.whatsapp.net",  "from": "6281234567890@s.whatsapp.net",  "lastSeen": 1719662400000,  "media": "text",  "state": "available",  "unavailable": false}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}