ZAzavudev

Get broadcast progress

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

get/v1/broadcasts/{broadcastId}/progress

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/broadcasts/{broadcastId}/progress
  • Auth
    HTTP bearer

Path parameters

broadcastIdstring required

Response

Broadcast progress.

broadcastIdstring required
status'draft' | 'pending_review' | 'pending_admin_review' | 'approved' | 'rejected' | 'escalated' | 'rejected_final' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'cancelled' | 'failed' required

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.

totalinteger required

Total contacts in broadcast.

pendinginteger required

Not yet queued for sending.

sendinginteger required

Currently being sent.

sentinteger

Accepted by the provider, delivery not confirmed yet.

deliveredinteger required

Confirmed delivered to the device.

failedinteger required

Failed to deliver.

skippedinteger required

Skipped (broadcast cancelled).

percentCompletenumber required

Percentage complete (0-100).

estimatedCostnumber nullable

Estimated total cost in USD.

reservedAmountnumber nullable

Amount reserved from balance in USD.

actualCostnumber nullable

Actual cost so far in USD.

startedAtstring date-time
estimatedCompletionAtstring date-time

Changes

No operation changes recorded.