latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-23440258.8 KB

5299037901a9

Connections

Send-side health for this connection

Whether this connection is actually able to send, 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.

get/connections/{phoneNumber}/health

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Response

Send-side health snapshot

Example response

{
  "data": {
    "sendState": "ok"
  }
}