Node.js
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});
async function getPhone() {
const response = await client.phone.info();
console.log(response);
}
getPhone();curl -X GET \
https://api.periskope.app/v1/phones \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-H 'x-phone: YOUR_PHONE_NUMBER' \
{
"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-20T07:51:48.209+00:00",
"wa_state": "CONNECTED"
}{
"code": "VALIDATION_ERROR",
"fields": {
"x-phone": {
"message": "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."
}
},
"message": "Missing Header: {x-phone}",
"name": "Validation Error",
"status": 422
}Phone APIs
Get phone
This endpoint retrieves information about the phone (specified in the x-phone header)
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});
async function getPhone() {
const response = await client.phone.info();
console.log(response);
}
getPhone();curl -X GET \
https://api.periskope.app/v1/phones \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-H 'x-phone: YOUR_PHONE_NUMBER' \
{
"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-20T07:51:48.209+00:00",
"wa_state": "CONNECTED"
}{
"code": "VALIDATION_ERROR",
"fields": {
"x-phone": {
"message": "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."
}
},
"message": "Missing Header: {x-phone}",
"name": "Validation Error",
"status": 422
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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:
"918527184400"
Response
200 OK
The response is a JSON object about the phone . Refer to the phone object here
Was this page helpful?