Skip to main content
Attributes
org_id
string
The unique identifier of the organization that owns this WhatsApp phone.
org_phone
string
The WhatsApp ID of the phone (format: {phone_number}@c.us).
created_at
string
The ISO 8601 formatted timestamp when the phone was first created.
updated_at
string
The ISO 8601 formatted timestamp when the phone was last updated.
wa_state
string
The current connection state of the WhatsApp account. Possible values are CONNECTED, DISCONNECTED.
phone_id
string
A unique identifier for this phone instance.
qr_code
string | null
The QR code string for WhatsApp Web authentication. Null when already connected.
phone_image
string
The URL of the WhatsApp profile image for this phone.
phone_name
string
The display name configured for this WhatsApp account.
first_connected_at
string
The ISO 8601 formatted timestamp when the phone first connected to WhatsApp.
is_ready
boolean
Indicates if the phone is fully configured and ready to send/receive messages.
label_ids
object
A mapping of label IDs to boolean values indicating which labels are assigned to this phone.
labels
array
An array of label names assigned to this phone.
is_browser_open
boolean
Indicates if the phone session on the server is currently open. If false, then please use the restart phone API to start the session