Batch status
Sent once per batch created with webhook_mode: BATCH, when every number has a send result (usually about 1 minute after the request). If a number is still pending after 30 minutes, the webhook is sent anyway with that number as QUEUED_PROVIDER.
After this webhook, only later changes of a number (a DELIVERED, a READ or a late FAILED) are notified individually with batch_id; a status already included here is not repeated. A batch that could not be processed is notified with status: FAILED, an error and the unprocessed list, in any webhook_mode.
Payload
The payload of this webhook request is an object.
type
Always BATCH. Distinguishes this webhook from the individual ones.
batch_id
status
Allowed values:
datetime
total
summary
Number of recipients per status (COMPLETED only).
messages
Status of each number, in the order of the request.
error
Reason of the failure (FAILED only).
unprocessed
message_id that were never sent (FAILED only).
Response
200
Event received and processed by the client.