Skip to main content
TypeScript
Deprecated. Use GET /message/queues/health instead

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 status of the message queue

Live status of the message send queue of a phone. Every outgoing message and broadcast is queued on the phone instance and submitted to WhatsApp one job at a time.

is_running
boolean

Whether the message queue of the phone is currently running. Reverts to false while the phone connection is DISCONNECTED — queued jobs wait until the phone reconnects.

Example:

true

active
integer

Number of jobs currently being processed (submitted to WhatsApp) by the queue

Example:

0

completed
integer

Number of jobs that completed successfully in the last 24 hours

Example:

16

failed
integer

Number of jobs that failed in the last 24 hours

Example:

10

pending
integer

Number of jobs currently waiting in the queue to be processed

Example:

0