Batcher

Quick start

Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen.

curl -X GET "https://api.ip1sms.com/v2/batches/" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \

Anrop

Lista en samling av batcher

Endpoint: /v2/batches

Metod: GET

Lista en enskild Batch

Endpoint: /v2/batches/{batchId}

Metod: GET

Exempel på anrop

 https://api.ip1sms.com/v2/batches/5bc86b6e85c7209830f96936

Fält för anropsdata

Fältnamn Typ Beskrivning Exempel
batchId String Batchens ID. 

5bc86b6e85c7209830f96936

Respons

Exempel på responsdata

Nedan hittar du ett exempel på svar vid lyckad request mot batches endpoint. Se under rubriken Fält för responsdata för en detaljerad beskrivning av samtliga fält i responsen.

{
    "id": "5bc86b6e85c7209830f96936",
    "sender": "46101606060",
    "body": "Hi my name is {name}",
    "owner": "ip1-XXXXX",
    "direction": "MT",
    "type": "flash",
    "datacoding": "GSM",
    "priority": 1,
    "templated": true,
    "priceSummary": {
        "total": 0.125,
        "currency": "EUR",
        "average": 0.0416
    },
    "messageSummary": {
        "101": {
          "messages": 43,
          "sms": 86
        },
        "102": {
          "messages": 3,
          "sms": 6
        },
        "201": {
          "messages": 142,
          "sms": 284
        }
    },
    "deliveryWindows": [
        {
            "opens": "2025-11-12T17:00:19Z",
            "closes": "2025-11-18T17:00:19Z"
        },
        {
            "opens": "2025-11-20T17:00:19Z",
            "closes": "2025-11-26T17:00:19Z"
        }
    ],
    "status": 112,
    "deliveryReportUrl": "https://api.example.com/sms/deliveryreport",
    "reference": "A client reference",
    "tags": ["marketing", "auth", "etc"],
}

Fält för responsdata

Fältnamn Typ Beskrivning Exempel
id String Batchens ID. 

"id": "5bc86b6e85c7209830f96936"
sender String Avsändaren som används för ett eller flera meddelanden. 

"sender": "46101606060"
body String Den ursprungliga bodyn, alltså meddelandetexten, som skickas, före mallar har tillämpats, enligt den ursprungliga requesten. 

"body": "A very nice message"
owner String Kontonumret för SMS-kontot som står som ägare batchen 

"owner": "ip1-xxxxx"
direction String Talar om ifall meddelandet skickades eller togs emot av vårt system.
  • MT En akronym för Mobile Terminated, ett meddelande som skickades till en mobil enhet.
  • MO En akronym för Mobile Originated, ett meddelande som skickades från en mobil enhet.
 

 "direction": "MT"
type String Beskriver meddelandets typ.
  • sms är ett vanligt SMS.
  • flash är ett meddelande som visas en gång på enheten och sedan raderas. 

"type": "sms"
datacoding String Talar om vilken teckenuppsättning som används för batchen.
  • gsm: 7-bitars teckenuppsättning (160 tecken/SMS), begränsat antal tecken.
  • ucs: 2-byte teckenuppsättning (70 tecken/SMS), tillåter alla tecken (t.ex. emoji). 

"datacoding": "GSM"
priority Integer Beskriver vilken prioritet som används för batchen. 

"priority": 1
templated boolean Talar om ifall batchens body (Meddelandetxt) innehåller templating. 
          
"templated": true
priceSummary array Ger en summering av batchens kostnad samt vilken valuta som debiterat kontot. 
          
"priceSummary": {
    "total": 0.125,
    "currency": "EUR",
    "average": 0.0416
}
messageSummary array Ger en summering av antalet meddelande i batchen uppdelat i statusgrupper. 
          
"messageSummary": {
    "101": {
      "messages": 43,
      "sms": 86
    },
    "102": {
      "messages": 3,
      "sms": 6
    },
    "201": {
      "messages": 142,
      "sms": 284
    }
}
deliveryWindows Array Visar batchens tidsfönster 

"deliveryWindows": [
        {
            "opens": "2025-11-12T17:00:19Z",
            "closes": "2025-11-18T17:00:19Z"
        },
        {
            "opens": "2025-11-20T17:00:19Z",
            "closes": "2025-11-26T17:00:19Z"
        }
],
status Integer Aktuell status för batchen. Härleds från riktningen och den senaste statusen för batchens meddelanden. Tillgängliga statusar är följande:
Namn statuskod Kommentar
Planned 101 Batchen är schemalagd att skickas i framtiden.
Ongoing 111 Batchen håller på att bearbetas och skickas ut
Sent 112 Batchen har skickats ut
Incoming 201 Batchen innehåller inkommande meddelanden
Canceled 203 Batchen har avbrutits och kommer inte att skickas 

"status": 112
deliveryReportUrl String Visar eventuell callback-url för mottagande av leveransrapporter till extern mjukvara. 

"deliveryReportUrl": "https://ip1.net"
reference String Visar batchens referens om sådan finns. 

"reference": "custom-id-123"
tags string Visar eventuella taggar i batchen. 

"tags": ["marketing", "auth", "admin"],