import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function createPhone() {
  const response = await client.phone.create();

  console.log(response);
}

createPhone();
{
  "created_at": "2024-12-15T11:47:26.668505+00:00",
  "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",
  "phone_id": "phone-bqzvyibhmwkaergr",
  "phone_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737141384215",
  "phone_name": "Support",
  "qr_code": null,
  "updated_at": "2025-01-20T11:48:40.055+00:00",
  "wa_state": "CONNECTED",
  "last_disconnect": null,
  "library": "",
  "phone_state": null,
  "queue_status": null,
  "server_image": "",
  "server_ip": "18.24.1.0",
  "server_name": "",
  "server_zone": "",
  "wa_version": ""
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Response

200 - application/json

200 OK

The response is a JSON object about the phone.