Bundles används för att skicka meddelanden till en eller flera mottagare samtidigt, vilket är idealiskt för aviseringar eller marknadsföringskampanjer. En Bundle innehåller information om avsändande Agent, innehåll i form av text eller kort, samt en lista över mottagare. Detta är det mest effektiva sättet att nå ut till en större grupp användare med ett och samma interaktiva budskap.


Quickstart #

💻
Quick Start (cURL)
Kopiera till urklipp
curl -X POST https://api.ip1.net/v3/bundles \
  -H "Authorization: Bearer API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "brand": "Min-Butik-AB",
    "agent": "Kundservice",
    "recipients": {"46700123456": {}},
    "reference": "INTERN-REF-001",
    "tags": ["frakt", "viktigt"],
    "card": {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": 1
    },
    "suggestions": [
      { 
        "text": "Se utbud", 
        "type": 1, 
        "url": "https://site.se/shop", 
        "postbackData": "shop_click" 
      },
      { 
        "text": "Ring butik", 
        "type": 4, 
        "phoneNumber": "468123456", 
        "postbackData": "call_click" 
      }
    ]
  }'

Anrop #

Endpoint: /bundles

Metod: POST

Exempel på anropsdata #

📋
Anropsdata (JSON)
Kopiera till urklipp
{
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "recipients": {
    "46700123456": { "name": "Kalle" }
  },
  "reference": "INTERN-REF-001",
  "tags": ["frakt", "viktigt"],
  "content": "Hej {name}! Här är ett exklusivt erbjudande till dig.",
  "uniqueId": "order-12345-id",
  "card": {
    "title": "Vår-REA!",
    "content": "Nu tömmer vi lagret inför sommaren.",
    "mediaUrl": "https://cdn.site.se/spring-sale.jpg",
    "type": 1
  },
  "suggestions": [
    {
      "text": "Shoppa nu",
      "type": 1,
      "url": "https://site.se/shop",
      "postbackData": "track_sale_click"
    }
  ]
}

Fält för anropsdata #

FältnamnBeskrivningRequiredTypExempel
brandNamnet på ditt brand JaString"Min-Butik-AB"
agentNamnet på din agentJaString”Kundservice
recipientsDin mottagarlistaJaObject”46700123456”: { ”name”: ”Kalle” }
contentSjälva meddelandets innehållJa (Bortsett när man använder Cards)String”Hej {name}! Din order är nu skickad.”
referenceIntern referens för bundleNejString”INTERN-REF-001”
tagsEn lista med sökbara taggar för att gruppera utskicketNejArray[”frakt”, ”viktigt”]
cardInnehåller bild, rubrik och text (Rich Card).NejObject(Se tabell nedan)
suggestionsEn lista med interaktiva knappar.NejArray(Se tabell nedan)
uniqueIdUnikt ID för att undvika dubbletter.NejString”order-12345-id”

Detaljer för fältet card #

FältnamnBeskrivningRequiredTypExempel
titleRubriken som visas överst på kortet.JaString”Vår-REA!”
contentDen beskrivande texten på kortet.JaString”Nu tömmer vi lagret.”
typeTyp av kort (1 för standard Rich Card).JaInteger1
mediaUrlURL till bild eller video (publik länk).NejURI”https://site.se/bild.jpg”

Detaljer för fältet suggestions #

FältnamnBeskrivningRequiredTypExempel
textTexten som står på knappen.JaString”Shoppa nu”
typeTyp av handling (1=URL, 4=Ring, 5=Plats).JaInteger1
postbackDataDen data du får tillbaka vid ett klick.JaString”track_sale_click”
urlMål-URL (krävs för typ 1).NejURI”https://site.se/shop”

Respons #

Exempel på responsdata #

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "id": "65eb3d14f1234567890abcdef",
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "type": 1,
  "content": "Hej! Din order är nu skickad.",
  "card": {
    "title": "Order #12345",
    "content": "Paketet beräknas anlända imorgon.",
    "mediaUrl": "https://cdn.site.se/package.jpg",
    "type": 1,
    "height": 2
  },
  "suggestions": [
    {
      "text": "Spåra paket",
      "type": 1,
      "url": "https://frakt.se/track/123",
      "postbackData": "track_click",
      "order": 0
    }
  ],
  "sendDate": "2026-03-04T15:05:00Z",
  "uniqueId": "order-12345-id",
  "reference": "INTERN-REF-001",
  "created": "2026-03-04T15:03:02Z",
  "tags": ["frakt", "viktigt"]
}

Fält för responsdata #

FältnamnBeskrivningTypExempel
idBundlens unika id.String"65eb3d14f1234567890abcdef"
brandDet använda varumärket.String”Min-Butik-AB”
agentNamnet på din agentString”Kundservice”
typeMeddelandetyp (t.ex. 1=Text).Integer1
contentTextinnehållet som skickades ut.String”Hej {name}! Din order är nu skickad.”
sendDateTidpunkt för utskick.DateTime”2026-03-04T15:05:00Z”
referenceDin valfria fritextreferens.String”INTERN-REF-001”
uniqueIdDitt egna ID för dubblettkontroll.String”order-12345-id”
createdTidpunkt när posten skapades i systemet.DateTime”2026-03-04T15:03:02Z”
tagsArray med taggar kopplade till utskicket.Array[”frakt”, ”viktigt”]
cardInnehåller detaljer för det skickade kortet (om tillämpligt).Object{…}
suggestionsLista med knappar som skickades med.Array[…]