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"

Body

application/json
queue_id
string

Return only the job with this queue job id

Example:

"00000000-0000-0000-0000-000000000000"

broadcast_id
string

Return only the jobs belonging to this broadcast

Example:

"00000000-0000-0000-0000-000000000000"

Response

The matching queue jobs

queue_id
string

Id of the queue job

Example:

"00000000-0000-0000-0000-000000000000"

unique_id
string

unique_id of the queued message — the value returned by POST /message/send

Example:

"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"

message_id
string

WhatsApp message_id assigned once the message was submitted. null while the job has not completed.

Example:

"true_911111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"

chat_id
string

Chat the message is being sent to

Example:

"911111111111@c.us"

performed_by
string

Who queued the message: a member's email, or 'api' when queued via the API

Example:

"api"

status
string

Current state of the job: one of queued, scheduled, sending, sent, pending, delivered, read, played, failed. Queue states (queued, scheduled, sending, failed) come from the send queue; once the job completed, the state reflects the delivery acknowledgement (sent, delivered, read, played — or pending/failed).

Example:

"delivered"

status_description
string

Human-readable explanation of the status

Example:

"Delivered to recipient."

message
object

The content of the queued message

timeline
object

Timestamps of the job lifecycle

attempts
integer

Number of submission attempts made so far

Example:

1