{"id":414,"date":"2023-11-23T11:17:20","date_gmt":"2023-11-23T10:17:20","guid":{"rendered":"http:\/\/localhost\/wordpress\/?page_id=414"},"modified":"2026-01-08T12:19:19","modified_gmt":"2026-01-08T12:19:19","slug":"batches","status":"publish","type":"page","link":"https:\/\/ip1sms.com\/en\/developer\/batches\/","title":{"rendered":"Batches"},"content":{"rendered":"\n
\n
\n
\n\n\n\n

Batcher<\/h1>\n\n\n\n

Quick start<\/h2>\n\n\n\n

Anv\u00e4nd exemplet nedan och byt ut \u201cAPI_NYCKEL\u201d mot en bearer token som du skapar i anv\u00e4ndarportalen.<\/p>\n\n\n

\ncurl -X GET "https:\/\/api.ip1sms.com\/v2\/batches\/" \\\n-H "Authorization: Bearer API_NYCKEL" \\\n-H "Content-Type: application\/json" \\\n<\/pre><\/div>\n\n\n
\n\n\n\n
Anrop<\/h2>\n\n\n\n
Lista en samling av batcher<\/h3>\n\n\n\n
Endpoint: \/v2\/batches<\/p>\n\n\n\n
Metod: GET<\/code><\/p>\n\n\n\n
Lista en enskild Batch<\/h3>\n\n\n\n
Endpoint: \/v2\/batches\/{batchId}<\/p>\n\n\n\n
Metod: GET<\/code><\/p>\n\n\n\n
Radera batch eller avbryt framtida batch<\/h3>\n\n\n\n
Metod: DELETE<\/code><\/p>\n\n\n\n
Exempel p\u00e5 anrop<\/h3>\n\n\n
\n https:\/\/api.ip1sms.com\/v2\/batches\/5bc86b6e85c7209830f96936\n\n<\/pre><\/div>\n\n\n
F\u00e4lt f\u00f6r anropsdata<\/h3>\n\n\n\n
\n\n  \n    \n      \n    \n      
F\u00e4ltnamn<\/th>\n      Typ<\/th>\n      Beskrivning<\/th>\n      Exempel<\/th>\n    <\/tr>\n  <\/thead>\n  
batchId<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Batchens ID.\n      <\/td>\n      
\n5bc86b6e85c7209830f96936\n      <\/code><\/pre><\/td>\n    <\/tr>\n  <\/tbody>\n<\/table>\n<\/div>\n\n\n\n
\n\n\n\n
Respons<\/h2>\n\n\n\n
Exempel p\u00e5 responsdata<\/h3>\n\n\n\n
Nedan hittar du ett exempel p\u00e5 svar vid lyckad request mot batches endpoint. Se under rubriken F\u00e4lt f\u00f6r responsdata<\/a> f\u00f6r en detaljerad beskrivning av samtliga f\u00e4lt i responsen.<\/p>\n\n\n
\n{\n    "id": "5bc86b6e85c7209830f96936",\n    "sender": "46101606060",\n    "body": "Hi my name is {name}",\n    "owner": "ip1-XXXXX",\n    "direction": "MT",\n    "type": "flash",\n    "datacoding": "GSM",\n    "priority": 1,\n    "templated": true,\n    "priceSummary": {\n        "total": 0.125,\n        "currency": "EUR",\n        "average": 0.0416\n    },\n    "messageSummary": {\n        "101": {\n          "messages": 43,\n          "sms": 86\n        },\n        "102": {\n          "messages": 3,\n          "sms": 6\n        },\n        "201": {\n          "messages": 142,\n          "sms": 284\n        }\n    },\n    "deliveryWindows": [\n        {\n            "opens": "2025-11-12T17:00:19Z",\n            "closes": "2025-11-18T17:00:19Z"\n        },\n        {\n            "opens": "2025-11-20T17:00:19Z",\n            "closes": "2025-11-26T17:00:19Z"\n        }\n    ],\n    "status": 112,\n    "deliveryReportUrl": "https:\/\/api.example.com\/sms\/deliveryreport",\n    "reference": "A client reference",\n    "tags": ["marketing", "auth", "etc"],\n}\n<\/pre><\/div>\n\n\n
F\u00e4lt f\u00f6r responsdata<\/h3>\n\n\n\n
\n\n  \n    \n      \n    \n      \n      \n      \n      \n      \n      \n      \n      \n      \n      \n      \n      \n      
F\u00e4ltnamn<\/th>\n      Typ<\/th>\n      Beskrivning<\/th>\n      Exempel<\/th>\n    <\/tr>\n  <\/thead>\n  
id<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Batchens ID.\n      <\/td>\n      
\n\"id\": \"5bc86b6e85c7209830f96936\"\n      <\/code><\/pre><\/td>\n    <\/tr>\n    
sender<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Avs\u00e4ndaren som anv\u00e4nds f\u00f6r ett eller flera meddelanden.\n      <\/td>\n      
\n\"sender\": \"46101606060\"\n      <\/code><\/pre><\/td>\n    <\/tr>\n    
body<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Den ursprungliga bodyn, allts\u00e5 meddelandetexten, som skickas, f\u00f6re mallar har till\u00e4mpats, enligt den ursprungliga requesten.\n      <\/td>\n      
\n\"body\": \"A very nice message\"\n<\/code>\n<\/pre>\n<\/td>\n    <\/tr>\n    
owner<\/td>\n      String<\/code><\/td>\n      Kontonumret f\u00f6r SMS-kontot som st\u00e5r som \u00e4gare batchen<\/td>\n      
\n\"owner\": \"ip1-xxxxx\"\n      <\/code><\/pre><\/td>\n    <\/tr>\n    
direction<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Talar om ifall meddelandet skickades<\/strong> eller togs emot<\/strong> av v\u00e5rt system.\n        
    \n          
  • MT<\/code> En akronym f\u00f6r Mobile Terminated, ett meddelande som skickades till en mobil enhet.<\/li>\n          
  • MO<\/code> En akronym f\u00f6r Mobile Originated, ett meddelande som skickades fr\u00e5n en mobil enhet.<\/li>\n        <\/ul>\n      <\/td>\n      
\n \"direction\": \"MT\"\n      <\/code><\/pre><\/td>\n    <\/tr>\n    
type<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Beskriver meddelandets typ.\n        
    \n          
  • sms<\/code> \u00e4r ett vanligt SMS.<\/li>\n          
  • \n            flash<\/code> \u00e4r ett meddelande som visas en g\u00e5ng p\u00e5 enheten\n            och sedan raderas.\n          <\/li>\n        <\/ul>\n      <\/td>\n      
\n      
\n\"type\": \"sms\"\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n    
datacoding<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Talar om vilken teckenupps\u00e4ttning som anv\u00e4nds f\u00f6r batchen.\n        
    \n          
  • \n            gsm<\/code>: 7-bitars teckenupps\u00e4ttning (160 tecken\/SMS),\n            begr\u00e4nsat antal tecken.\n          <\/li>\n          
  • \n            ucs<\/code>: 2-byte teckenupps\u00e4ttning (70 tecken\/SMS),\n            till\u00e5ter alla tecken (t.ex. emoji).\n          <\/li>\n        <\/ul>\n      <\/td>\n      
\n      
\n\"datacoding\": \"GSM\"\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n    
priority<\/strong><\/td>\n      Integer<\/code><\/td>\n      \n        Beskriver vilken prioritet som anv\u00e4nds f\u00f6r batchen.\n      <\/td>\n      \n      
\n\"priority\": 1\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n    
templated<\/strong><\/td>\n      boolean<\/code><\/td>\n      Talar om ifall batchens body (Meddelandetxt) inneh\u00e5ller templating.<\/td>\n      \n        
\n          \n\"templated\": true\n          <\/code>\n        <\/pre>\n      <\/td>\n    <\/tr>\n    
priceSummary<\/strong><\/td>\n      array<\/code><\/td>\n      Ger en summering av batchens kostnad samt vilken valuta som debiterat kontot.<\/td>\n      \n        
\n          \n\"priceSummary\": {\n    \"total\": 0.125,\n    \"currency\": \"EUR\",\n    \"average\": 0.0416\n}\n          <\/code>\n        <\/pre>\n      <\/td>\n    <\/tr>\n    
messageSummary<\/strong><\/td>\n      array<\/code><\/td>\n      Ger en summering av antalet meddelande i batchen uppdelat i statusgrupper.<\/td>\n      \n        
\n          \n\"messageSummary\": {\n    \"101\": {\n      \"messages\": 43,\n      \"sms\": 86\n    },\n    \"102\": {\n      \"messages\": 3,\n      \"sms\": 6\n    },\n    \"201\": {\n      \"messages\": 142,\n      \"sms\": 284\n    }\n}\n          <\/code>\n        <\/pre>\n      <\/td>\n    <\/tr>\n    
deliveryWindows<\/strong><\/td>\n      Array<\/code><\/td>\n      \n        Visar batchens tidsf\u00f6nster\n      <\/td>\n      
\n\"deliveryWindows\": [\n        {\n            \"opens\": \"2025-11-12T17:00:19Z\",\n            \"closes\": \"2025-11-18T17:00:19Z\"\n        },\n        {\n            \"opens\": \"2025-11-20T17:00:19Z\",\n            \"closes\": \"2025-11-26T17:00:19Z\"\n        }\n],\n      <\/code><\/pre><\/td>\n    <\/tr>\n    
status<\/strong><\/td>\n      Integer<\/td>\n      Aktuell status f\u00f6r batchen. H\u00e4rleds fr\u00e5n riktningen och den senaste statusen f\u00f6r batchens meddelanden. Tillg\u00e4ngliga statusar \u00e4r f\u00f6ljande:\n        \n          \n            \n            \n            \n              \n              \n              \n              \n              \n      \n      \n      
Namn<\/th>\n            statuskod<\/th>\n            Kommentar<\/th>\n            <\/tr>\n          <\/thead>\n          
Planned<\/td>\n              101<\/td>\n              Batchen \u00e4r schemalagd att skickas i framtiden.<\/td>\n            <\/tr>\n            
Ongoing<\/td>\n              111<\/td>\n              Batchen h\u00e5ller p\u00e5 att bearbetas och skickas ut<\/td>\n            <\/tr>\n            
Sent<\/td>\n              112<\/td>\n              Batchen har skickats ut<\/td>\n            <\/tr>\n            
Incoming<\/td>\n              201<\/td>\n              Batchen inneh\u00e5ller inkommande meddelanden<\/td>\n            <\/tr>\n            
Canceled<\/td>\n              203<\/td>\n              Batchen har avbrutits och kommer inte att skickas<\/td>\n            <\/tr>\n          <\/tbody>\n        <\/table>\n      <\/td>\n      \n      
\n\"status\": 112\n      <\/pre><\/code>\n    <\/td>\n    <\/tr>\n    
deliveryReportUrl<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Visar eventuell callback-url f\u00f6r mottagande av leveransrapporter till extern mjukvara.\n      <\/td>\n      \n      
\n\"deliveryReportUrl\": \"https:\/\/ip1.net\"\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n    
reference<\/strong><\/td>\n      String<\/code><\/td>\n      \n        Visar batchens referens om s\u00e5dan finns.\n      <\/td>\n      \n      
\n\"reference\": \"custom-id-123\"\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n    
tags<\/strong><\/td>\n      string<\/code><\/td>\n      \n        Visar eventuella taggar i batchen.\n      <\/td>\n      \n      
\n\"tags\": [\"marketing\", \"auth\", \"admin\"],\n      <\/pre><\/code>\n      <\/td>\n    <\/tr>\n  <\/tbody>\n<\/table>\n<\/div>\n\n\n\n<\/div>\n\n\n\n