FireFlo OMNI

One broadcast, with how far it has got.

Needs the broadcasts:read scope.

Path parameters

Field	Type	Required	Notes
`broadcast_id`	string	Yes	The broadcast’s id.

Request

curl "https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/broadcasts/7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33", {
  headers: { Authorization: `Bearer ${process.env.OMNI_API_KEY}` },
});
console.log(response.status, await response.json());

Response

200 OK — the broadcast. recipients is everyone its audience named; counts say how many were skipped (not a valid number, or not to be messaged), sent (handed to the channel), delivered, failed, and are still waiting; percent is how far through it is. status is one of:

Status	Meaning
`preparing`	Its audience is being read and checked.
`queued`	Ready, waiting for a free turn to send.
`scheduled`	Ready, waiting for `scheduled_for`.
`sending`	Being sent.
`paused`	Paused; nothing is sent until it’s resumed.
`sent`	Every message it could send has been handed to the channel.
`failed`	It couldn’t be sent: `error` says why.
`canceled`	Canceled before every message was sent.

{
  "id": "7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33",
  "name": "Diwali offer",
  "channel": "whatsapp",
  "status": "sending",
  "purpose": "marketing",
  "recipients": 1840,
  "counts": {
    "skipped": 12,
    "sent": 1204,
    "delivered": 1179,
    "failed": 9,
    "waiting": 624
  },
  "percent": 66,
  "error": "",
  "scheduled_for": null,
  "created": "2026-10-06T09:12:04+05:30",
  "started": "2026-10-06T09:12:31+05:30",
  "finished": null
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
404	`not_found`	No broadcast of this account’s has that id.
403	`scope_missing`	The key doesn’t have the `broadcasts:read` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.

Overview

Account

Messages

Broadcasts

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Reports

Webhooks

WhatsApp

SMS

Try it

GET /v1/broadcasts/{broadcast_id}

Path parameters

Request

Response

Errors

​Path parameters

​Request

​Response

​Errors

Path parameters

Request

Response

Errors