FAfazer-ai
Connections

Send- and receive-side health for this connection

Changed on

Whether this connection is actually able to send and to receive, which POST /connections cannot tell you: that path only does a presence update, which does not touch the keystore and therefore passes while sends are wedged. sendState is unknown when no send has been observed yet — a connection nobody writes to can be stalled and still look perfect, so this never claims health it has not seen. receiveState is stalled when the socket has been open for 2 minutes and WhatsApp has not finished delivering the queue it held for this device: the socket sends, but no messages or receipts arrive. The API does not recreate the socket on its own for that state.

get/connections/{phoneNumber}/health

Request

  • Base URL
    http://localhost:3025
  • Auth
    API key in header x-api-key

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Response

Send- and receive-side health snapshot

Example response

{
  "data": {
    "sendState": "ok",
    "receiveState": "ok"
  }
}

Changes