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

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: '919876543210', // the phone to act with (x-phone)
});

async function main() {
  const response = await client.queue.getBroadcastStatus({
    broadcast_id: '00000000-0000-0000-0000-000000000000',
  });
  console.log(response);
}

main();

curl -X GET 'https://api.periskope.app/v1/queue/broadcast?broadcast_id=00000000-0000-0000-0000-000000000000' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'x-phone: 919876543210'

{
  "broadcast_id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "message_payload": {
    "body": "Hello from Periskope!",
    "message_type": "chat"
  },
  "created_at": "2026-01-15T09:30:00.000Z",
  "broadcast_status": "completed",
  "total_chats": 25,
  "sent_chats": 22,
  "failed_chats": 1,
  "pending_chats": 2,
  "total_delivered_count": 180,
  "total_read_count": 120,
  "total_member_count": 200,
  "delivered_percentage": 90,
  "read_percentage": 60,
  "performed_by": "api",
  "performed_at": "2026-01-15T09:31:00.000Z",
  "scheduled_at": null,
  "due_at": "2026-01-15T09:31:00.000Z",
  "retry_count": 0,
  "previous_retries": null,
  "parent_broadcast_id": null,
  "repeat_config": null,
  "is_active": null,
  "next_occurrence_at": null,
  "occurrence_count": null,
  "logs": [
    {
      "broadcast_id": "00000000-0000-0000-0000-000000000000",
      "org_id": "00000000-0000-0000-0000-000000000000",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "is_success": true,
      "remarks": null,
      "member_count": 12,
      "delivered_count": 10,
      "read_count": 7,
      "delivery_info": null,
      "poll_results": null,
      "created_at": "2026-01-15T09:30:00.000Z",
      "completed_at": "2026-01-15T09:31:00.000Z"
    }
  ]
}

{
  "code": "ERROR",
  "message": "Broadcast not found — no broadcast with the given broadcast_id exists in the workspace",
  "status": 400
}

{
  "code": "UNAUTHORIZED_ERROR",
  "message": "Invalid bearer auth token",
  "status": 401
}

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "status": 422,
  "fields": {
    "body.chat_id": {
      "message": "chat_id is required"
    }
  }
}

{
  "code": "RATE_LIMIT_ERROR",
  "message": "You can only make 100 requests per second",
  "status": 429
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Internal server error",
  "status": 500
}