{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us",
    "created_at": "2024-12-15T11:47:26.668505+00:00",
    "updated_at": "2025-01-20T07:51:48.209+00:00",
    "wa_state": "CONNECTED",
    "phone_id": "phone-bqzvyibhmwkaergr",
    "qr_code": null,
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
    "phone_name": "Support",
    "first_connected_at": "2024-12-15T11:47:49.649+00:00",
    "is_ready": true,
    "label_ids": {
        "label-bflirzqiodgianfh": true,
        "label-rbdshklasmlbfczf": true
    },
    "labels": [
        "test1",
        "test2"
    ]
}

{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us",
    "created_at": "2024-12-15T11:47:26.668505+00:00",
    "updated_at": "2025-01-20T07:51:48.209+00:00",
    "wa_state": "CONNECTED",
    "phone_id": "phone-bqzvyibhmwkaergr",
    "qr_code": null,
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
    "phone_name": "Support",
    "first_connected_at": "2024-12-15T11:47:49.649+00:00",
    "is_ready": true,
    "label_ids": {
        "label-bflirzqiodgianfh": true,
        "label-rbdshklasmlbfczf": true
    },
    "labels": [
        "test1",
        "test2"
    ]
}

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

{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us",
    "created_at": "2024-12-15T11:47:26.668505+00:00",
    "updated_at": "2025-01-20T07:51:48.209+00:00",
    "wa_state": "CONNECTED",
    "phone_id": "phone-bqzvyibhmwkaergr",
    "qr_code": null,
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
    "phone_name": "Support",
    "first_connected_at": "2024-12-15T11:47:49.649+00:00",
    "is_ready": true,
    "label_ids": {
        "label-bflirzqiodgianfh": true,
        "label-rbdshklasmlbfczf": true
    },
    "labels": [
        "test1",
        "test2"
    ]
}

{
    "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
    "org_phone": "918527184400@c.us",
    "created_at": "2024-12-15T11:47:26.668505+00:00",
    "updated_at": "2025-01-20T07:51:48.209+00:00",
    "wa_state": "CONNECTED",
    "phone_id": "phone-bqzvyibhmwkaergr",
    "qr_code": null,
    "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
    "phone_name": "Support",
    "first_connected_at": "2024-12-15T11:47:49.649+00:00",
    "is_ready": true,
    "label_ids": {
        "label-bflirzqiodgianfh": true,
        "label-rbdshklasmlbfczf": true
    },
    "labels": [
        "test1",
        "test2"
    ]
}

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