Results of a batch

GET /v1/batches/{id}/results

What happened after the queue: attempted = delivered + failed + pending. delivered and failed come from carrier delivery receipts; pending was accepted by the carrier with no final receipt (no_receipt of those never got one). replies are inbound messages from recipients to the sending number within reply_window_hours of the batch finishing (opt-out keywords are not counted); stops are recipients who opted out in that time and are still opted out. spent_usd sums the recorded price of each message. failures groups failed recipients by reason. Derived from stored messages and cached for up to a minute while numbers can still move; partial: true means a read bound was hit and delivered / replies are floors.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Responses

Status	Meaning	Body
200	Results	`BatchResults`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: `BatchResults` fields

Field	Type	Description
`object`	`batch_results`
`batch_id`	string
`recipients`	integer
`attempted`	integer
`delivered`	integer
`failed`	integer
`pending`	integer
`no_receipt`	integer
`skipped`	object
`skipped.opted_out`	integer
`skipped.topic_unsubscribed`	integer
`canceled`	integer
`queued`	integer
`replies`	integer
`repliers`	integer
`stops`	integer
`spent_usd`	number
`failures`	array of object
`failures[].code`	string
`failures[].title`	string
`failures[].explanation`	string
`failures[].action`	string
`failures[].count`	integer
`reply_window_hours`	integer
`window_open`	boolean
`partial`	boolean
`test`	boolean
`computed_at`	string (date-time)

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404	Not found
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/batches/bc_a1B2c3D4e5F6/results" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

The Node.js SDK does not wrap this endpoint yet; call it with fetch.

javascript

const res = await fetch('https://api.joinsimplesms.com/v1/batches/bc_a1B2c3D4e5F6/results', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

python

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/batches/bc_a1B2c3D4e5F6/results",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)