Developer documentation

Build with the InboxIQ API

SMS

Check a batch

Get the latest counts for a bulk send: how many messages were delivered, failed or are still on their way.

GET/api/v1/batches?batchReference=B00042

Request

batchReferencequery stringRequired

The batchReference returned when you sent the bulk SMS, for example B00042.

curl -X GET "https://api.inboxiq.co.zw/api/v1/batches?batchReference=B00042" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)" \
-H "key: YOUR_API_KEY"

Response

Response · 200 OK
{
"batchReference": "B00042",
"batchStatus": "SENT",
"numberOfSms": 2480,
"delivered": 2341,
"failed": 12,
"unknownDelivery": 0
}

The fields are the same as the bulk SMS response. The counts are recalculated each time you call this endpoint.

Batch statuses

StatusMeaning
PENDINGThe batch has been created and no messages have been counted yet.
SENDINGSome messages are still queued and being sent.
SENTAll messages have been sent and some are waiting for a delivery report.
COMPLETEDEvery message has a final status.
FAILEDEvery message in the batch failed.

How often to check

  • Most messages are delivered within a minute, but some networks report delivery later.
  • Checking every few minutes is plenty. Stop once the batch is COMPLETED or FAILED.
  • You can only check batches sent from your own account. Other references return 403 Forbidden.