Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Headers

x-phone
string
required

Phone to act with: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone must be connected to the org and accessible by the API token.

Minimum string length: 1
Example:

"919876543210"

Response

The current queue counters of the phone

Live counters of the message send queue of a phone

is_running
boolean

Whether the send queue of the phone is currently processing jobs

Example:

true

active
number

Number of jobs currently being processed

Example:

0

pending
number

Number of jobs waiting to be processed

Example:

2

completed
number

Number of completed jobs still retained in the queue

Example:

40

failed
number

Number of failed jobs retained in the queue

Example:

1