Batcher

En batch är behållaren för ett eller flera meddelanden som skapats i samma anrop. Meddelanden kan inte existera utan en överliggande batch.

Endpoints

Metod	Sökväg	Beskrivning
GET	/v2/batches	Lista batcher. Resultatet är paginerat.
GET	/v2/batches/{batchId}	Läs en enskild batch.
DELETE	/v2/batches/{batchId}	Radera en batch eller avbryt en framtida batch.

Lista batcher

curl "https://api.ip1sms.com/v2/batches?start=0&limit=50&order=DESC" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

Använd start, limit och order samt länkarna i svarets Link-header. Batcher kan även filtreras utifrån de taggar som sattes vid skapandet.

Läs en batch

curl "https://api.ip1sms.com/v2/batches/{batchId}" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

batchId är det ID som returnerades när batchen skapades.

Radera eller avbryt

curl -X DELETE "https://api.ip1sms.com/v2/batches/{batchId}" \
  -H "Authorization: Bearer $IP1_TOKEN"

Behandla operationen som destruktiv. För en schemalagd batch innebär den att framtida leverans avbryts. Kontrollera svaret innan den lokala posten markeras som avbruten.

Batchdokument

{
  "id": "batch_abc123",
  "sender": "DittForetag",
  "body": "Din bokning är bekräftad.",
  "owner": "ip1-XXXXX",
  "direction": "MT",
  "type": "sms",
  "datacoding": "GSM",
  "priority": 1,
  "templated": false,
  "priceSummary": {
    "total": 0.125,
    "currency": "SEK",
    "average": 0.0416
  },
  "messageSummary": {
    "201": { "messages": 3, "sms": 3 }
  },
  "deliveryWindows": [
    {
      "opens": "2026-10-05T08:00:00Z",
      "closes": "2026-10-05T10:00:00Z"
    }
  ],
  "status": 112,
  "deliveryReportUrl": "https://example.com/webhooks/ip1/delivery",
  "reference": "order-123",
  "tags": ["transactional"]
}

Fält

Fält	Typ	Beskrivning
id	string	Batchens ID.
sender	string	Avsändaren som används för meddelandena.
body	string	Ursprunglig meddelandetext före mallning.
owner	string	Ägande SMS-konto.
direction	string	MT för utgående eller MO för inkommande.
type	string	sms eller flash.
datacoding	string	gsm eller ucs.
priority	integer	1 eller 2.
templated	boolean	Om texten innehåller mottagarspecifik mallning.
priceSummary	object	total, currency och average.
messageSummary	object	Antal meddelanden och SMS-segment grupperade per statuskod.
deliveryWindows	object[]	Tidsfönster med opens och closes.
status	integer	Batchens sammanvägda status.
deliveryReportUrl	string | null	URL för statuscallbacks.
reference	string | null	Egen referens.
tags	string[]	Egna kategorier.

Batchstatus

Namn	Kod	Betydelse
Planned	101	Batchen är schemalagd för framtiden.
Ongoing	111	Batchen bearbetas och skickas.
Sent	112	Batchen har skickats.
Incoming	201	Batchen innehåller inkommande meddelanden.
Canceled	203	Batchen har avbrutits.

Batchstatus ska inte ersätta statusen för ett enskilt meddelande. Läs meddelanden eller använd leveransrapporter när varje mottagares utfall behöver hanteras.