Skip to content
DashboardGet API key

Get broadcast progress

View .md
GET

Get real-time progress of a broadcast including delivery counts and estimated completion time.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • broadcastIdstringrequired

Responses

200Broadcast progress.
  • broadcastIdstringrequired
  • statusstringrequired

    Current status of the broadcast. pending_review: in the automated content review. pending_admin_review: the automated review passed and it waits for a person, which is where every channel but a WhatsApp broadcast on an approved template goes. rejected: the review refused it; edit it and retry the review, or escalate. scheduled and sending follow approval.

    One ofdraftpending_reviewpending_admin_reviewapprovedrejectedescalatedrejected_finalscheduledsendingpausedcompletedcancelledfailed
  • totalintegerrequired

    Total contacts in broadcast.

  • pendingintegerrequired

    Not yet queued for sending.

  • sendingintegerrequired

    Currently being sent.

  • sentinteger

    Accepted by the provider, delivery not confirmed yet.

  • deliveredintegerrequired

    Confirmed delivered to the device.

  • failedintegerrequired

    Failed to deliver.

  • skippedintegerrequired

    Skipped (broadcast cancelled).

  • percentCompletenumberrequired

    Percentage complete (0-100).

  • estimatedCostnumbernullable

    Estimated total cost in USD.

  • reservedAmountnumbernullable

    Amount reserved from balance in USD.

  • actualCostnumbernullable

    Actual cost so far in USD.

  • startedAtstring<date-time>
  • estimatedCompletionAtstring<date-time>
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Broadcast not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject