import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function getBroadcastStatus() {
  const response = await client.queue.getBroadcastStatus({
    broadcast_id: '22b2a2a4-3c61-4b94-807c-fa431e71a8e5'
  });

  console.log(response);
}

getBroadcastStatus();
{
  "broadcast_id": "22b2a2a4-3c61-4b94-807c-fa431e71a8e5",
  "org_id": "5fb0d69a-d789-4429-970e-66d48e381c9b",
  "message_payload": {
    "body": "#generalteam#",
    "message_type": "chat",
    "performed_by": "api"
  },
  "created_at": "2025-03-10T11:11:20.049901+00:00",
  "total_chats": 2,
  "sent_chats": 0,
  "failed_chats": 0,
  "pending_chats": 0,
  "total_delivered_count": 123,
  "total_read_count": 123,
  "performed_by": "5fb0d69a-d789-4429-970e-66d48e381c9b",
  "performed_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2025-03-10T12:11:19.52+00:00",
  "broadcast_status": "<string>",
  "total_member_count": 0,
  "delivered_percentage": 0,
  "read_percentage": 0,
  "logs": []
}

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:

"{{orgPhone}}"

Query Parameters

​
broadcast_id
string
required

The unique identifier of the broadcast

Example:

"22b2a2a4-3c61-4b94-807c-fa431e71a8e5"

Response

200 - application/json
Successful operation

The response is of type object.