Broadcasts

Retrieve a Broadcast

Fetch a broadcast by the id you got when you sent it, and watch its counts move as delivery drains.
GET/v1/broadcast/:id

Request

curl https://api.transmitinfra.com/v1/broadcast/5b1e7c2a-9f04-4c3e-8a61-2d7f0e9b4c18 \
  -H "Authorization: Bearer $TRANSMIT_API_KEY"
{
  "data": {
    "id": "5b1e7c2a-9f04-4c3e-8a61-2d7f0e9b4c18",
    "channel": "SMS",
    "message": "Our offices are closed on Monday for Tobaski.",
    "status": "PROCESSING",
    "totalCount": 12480,
    "acceptedCount": 5120,
    "deliveredCount": 2192,
    "failedCount": 184,
    "scheduledAt": null,
    "createdAt": "2026-09-26T09:14:02.000Z",
    "completedAt": null
  }
}

A broadcast that belongs to another workspace answers 404, exactly like one that does not exist.

Statuses

  • PROCESSING: Accepted and sending, or waiting for its scheduledAt time.
  • COMPLETED: Every recipient has been accepted by a provider or has failed. completedAt is set. Delivery reports can still move counts afterwards.
  • FAILED: Nothing could be sent at all — every valid number was in a country we do not deliver to, so totalCount is 0.
COMPLETED means finished, not successful. A broadcast where every message failed is still COMPLETED — check failedCount.

Reading the counts

  • totalCount: Recipients accepted after cleaning the list.
  • acceptedCount: Messages a carrier or email provider accepted that have no delivery report yet.
  • deliveredCount: Messages the provider confirmed reached the handset or mailbox.
  • failedCount: Messages the provider refused, or later reported as undelivered or bounced.
  • In flight: totalCount − acceptedCount − deliveredCount − failedCount is still being sent.

Polling

Poll with a delay between calls and stop once the status is COMPLETED or FAILED. This route shares a budget of 100 requests per minute across your workspace.

Delivery reports keep arriving after COMPLETED, moving recipients from acceptedCount into deliveredCount or failedCount. Not every carrier reports, so some messages stay accepted for good. A failure whose reason starts with uncertain: means the provider stopped answering mid-request; the message may still have been sent, and it moves to delivered if a report later proves it.