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ältnamn | Beskrivning | Required | Typ | Exempel |
| brand | Namnet på ditt brand | Ja | String | "Min-Butik-AB" |
| agent | Namnet på din agent | Ja | String | ”Kundservice |
| recipients | Din mottagarlista | Ja | Object | ”46700123456”: { ”name”: ”Kalle” } |
| content | Själva meddelandets innehåll | Ja (Bortsett när man använder Cards) | String | ”Hej {name}! Din order är nu skickad.” |
| reference | Intern referens för bundle | Nej | String | ”INTERN-REF-001” |
| tags | En lista med sökbara taggar för att gruppera utskicket | Nej | Array | [”frakt”, ”viktigt”] |
| card | Innehåller bild, rubrik och text (Rich Card). | Nej | Object | (Se tabell nedan) |
| suggestions | En lista med interaktiva knappar. | Nej | Array | (Se tabell nedan) |
| uniqueId | Unikt ID för att undvika dubbletter. | Nej | String | ”order-12345-id” |
Detaljer för fältet card #
| Fältnamn | Beskrivning | Required | Typ | Exempel |
|---|---|---|---|---|
| title | Rubriken som visas överst på kortet. | Ja | String | ”Vår-REA!” |
| content | Den beskrivande texten på kortet. | Ja | String | ”Nu tömmer vi lagret.” |
| type | Typ av kort (1 för standard Rich Card). | Ja | Integer | 1 |
| mediaUrl | URL till bild eller video (publik länk). | Nej | URI | ”https://site.se/bild.jpg” |
Detaljer för fältet suggestions #
| Fältnamn | Beskrivning | Required | Typ | Exempel |
|---|---|---|---|---|
| text | Texten som står på knappen. | Ja | String | ”Shoppa nu” |
| type | Typ av handling (1=URL, 4=Ring, 5=Plats). | Ja | Integer | 1 |
| postbackData | Den data du får tillbaka vid ett klick. | Ja | String | ”track_sale_click” |
| url | Mål-URL (krävs för typ 1). | Nej | URI | ”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ältnamn | Beskrivning | Typ | Exempel |
| id | Bundlens unika id. | String | |
| brand | Det använda varumärket. | String | ”Min-Butik-AB” |
| agent | Namnet på din agent | String | ”Kundservice” |
| type | Meddelandetyp (t.ex. 1=Text). | Integer | 1 |
| content | Textinnehållet som skickades ut. | String | ”Hej {name}! Din order är nu skickad.” |
| sendDate | Tidpunkt för utskick. | DateTime | ”2026-03-04T15:05:00Z” |
| reference | Din valfria fritextreferens. | String | ”INTERN-REF-001” |
| uniqueId | Ditt egna ID för dubblettkontroll. | String | ”order-12345-id” |
| created | Tidpunkt när posten skapades i systemet. | DateTime | ”2026-03-04T15:03:02Z” |
| tags | Array med taggar kopplade till utskicket. | Array | [”frakt”, ”viktigt”] |
| card | Innehåller detaljer för det skickade kortet (om tillämpligt). | Object | {…} |
| suggestions | Lista med knappar som skickades med. | Array | […] |