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 purgeQueueJobs() {
  const result = await client.message.purgeQueueJobs({
    queue_ids: ['5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400']
  });

  console.log(result);
}

purgeQueueJobs();
{
  "purged": true,
  "mode": "queue_ids",
  "queue_ids": [
    "5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400"
  ]
}

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"

Body

application/json
​
queue_ids
string[]

Provide the queue_id of the message to purge only jobs in that queue (or an array of queue_id to purge multiple queues)

Example:
["5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400"]
​
broadcast_id
string

Provide the broadcast_id to purge all messages of that broadcast

Example:

"b25192d5-2370-4a69-b844-aae5e2bfae92"

Response

200 - application/json

200 OK

The response confirms the purge operation

​
purged
boolean

Whether the purge operation was successful

Example:

true

​
mode
enum<string>

The purge mode used, indicating the scope of the purge operation

Available options:
all,
queue_ids,
broadcast
Example:

"queue_ids"

​
queue_ids
string[]

The broadcast ID or queue IDs that were purged

Example:
["5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400"]