Skip to main content
GET
Get campaign progress

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string
required

Campaign ID. The same ID works as broadcastId on /v1.

Response

Progress.

status
enum<string>
required

Current status of the campaign. 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 campaign on an approved template goes. rejected: the review refused it; edit it and send again, or escalate. scheduled and sending follow approval.

Available options:
draft,
pending_review,
pending_admin_review,
approved,
rejected,
escalated,
rejected_final,
scheduled,
sending,
paused,
completed,
cancelled,
failed
total
integer
required

Total contacts in broadcast.

pending
integer
required

Not yet queued for sending.

sending
integer
required

Currently being sent.

delivered
integer
required

Confirmed delivered to the device.

failed
integer
required

Failed to deliver.

skipped
integer
required

Skipped (broadcast cancelled).

percentComplete
number
required

Percentage complete (0-100).

campaignId
string
required
sent
integer

Accepted by the provider, delivery not confirmed yet.

estimatedCost
number | null

Estimated total cost in USD.

reservedAmount
number | null

Amount reserved from balance in USD.

actualCost
number | null

Actual cost so far in USD.

startedAt
string<date-time>
estimatedCompletionAt
string<date-time>