Skip to main content
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 getQueueHealth() {
  const health = await client.message.getQueueHealth();
  console.log(health);
}

getQueueHealth();
{
  "waiting": 0,
  "active": 1,
  "completed": 142,
  "failed": 3,
  "delayed": 5,
  "paused": 0
}

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:

"918527184400"

Response

200 - application/json

200 OK

The response is a JSON object with a count of jobs per state in the message queue

​
waiting
integer

Number of message jobs waiting to be processed

Example:

0

​
active
integer

Number of message jobs currently being processed

Example:

1

​
completed
integer

Number of message jobs completed successfully

Example:

142

​
failed
integer

Number of message jobs that failed after all retry attempts

Example:

3

​
delayed
integer

Number of message jobs scheduled for a future time

Example:

5

​
paused
integer

Number of message jobs currently paused

Example:

0