A broadcast's status and the result per number
https://api.app2email.com/v1/{number}/broadcasts/{code} Counts and the result for each number, live while a background send runs.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
broadcast.code from the send answer, or from GET /broadcasts.
e.g.k3XbQ9rTzP2mWv7a1c9e
Responses
Fields
- success boolean
- request_id string
- broadcast object
9 fields
- code string
- name string
- created string (date-time)
- status string
scheduledinprogresscompletedcancelledmissedinterruptedpendingunknown - status_notes string
- scheduled_for string (date-time)
- sent_by string
apidashboard - template object
- report_url string
-
Live from the messages: numbers, skipped_do_not_call, skipped_monthly_limit, posted, accepted, sent, delivered, read, failed, replied, opted_out.
- results object[]
One per number: a MessageInfo, or {to, status: skipped|not_sent|pending, reason}.
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.