string
Unique id of the phone (phone-xxxxxxxxxxxxxxxx). Accepted as the x-phone header value on phone-scoped endpoints.
string
Id of the organization the phone belongs to
string
WhatsApp number connected to the phone, as country code + number suffixed with @c.us. null until a WhatsApp account has been connected by scanning the QR.
string
Display name of the phone
string
URL of the profile image of the phone
string
WhatsApp connection state — ‘CONNECTED’ when the session is live, ‘UNPAIRED’/‘UNPAIRED_IDLE’ while awaiting a QR scan, other transient states include ‘OPENING’, ‘PAIRING’, ‘TIMEOUT’ and ‘CONFLICT’. null before the phone has ever connected.
boolean
Whether the phone instance is booted and ready to send and receive messages
string
Raw QR payload while the phone is awaiting a QR scan; null once connected. Use GET /phones/qr to render it as a scannable image.
object
Labels assigned to the phone, keyed by label_id (true = assigned)
string[]
Names of the labels assigned to the phone, resolved from label_ids
boolean
Whether the phone’s WhatsApp Web browser session is currently open
object
Details of the most recent disconnect event, if any. null when the phone has never disconnected.
object
Status of the phone’s outgoing message queue, if any messages are queued
string
When a WhatsApp account was first connected to the phone, as an ISO 8601 timestamp. null if never connected.
string
When the phone was created, as an ISO 8601 timestamp
string
When the phone was last updated, as an ISO 8601 timestamp