RCS API Logotyp

Skicka RCS (Enskild mottagare)

Skapa utvecklingskonto

Används för att inleda en ny dialog med en kund genom att skicka det första meddelandet. Observera: Om du vill skicka RCS till flera mottagare samtidigt, använd endpointen Bundles.

Starta en ny konversation #

Quick start #

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

Anrop #

Endpoint: /conversations

Metod: POST

Exempel på anropsdata #

📋
filename.js
Kopiera till urklipp
{
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "recipient": "46700123456",
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": 1,
      "order": 0
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": 1,
      "order": 2
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": 1,
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": 4,
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}

Fält för anropsdata #

FältnamnBeskrivningRequiredTypExempel
brandNamnet på ditt brand JaString"Min-Butik-AB"
agentNamnet på din agentJaString”Kundservice”
recipientMottagarens nummerJaObject”46700123456”: { ”name”: ”Kalle” }
contentSjälva meddelandets innehållJa (Bortsett när man använder Cards)String”Hej {name}! Din order är nu skickad.”
typeMeddelandet i konversationens typJaString”Carousell”
carouselEn lista av flera kort som skapar en KarusellKrävs om typen är ”Carousel”Array(Se tabell nedan)
cardInnehåller bild, rubrik och text (Rich Card).Krävs om typen är ”Card”Object(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 (2 för Rich Card i karusell).JaInteger2
orderOrdning som korten visasKrävs om typen ”Carousel” användsInteger1
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 (2=URL, 5=Dela Plats, 6=Ring).JaInteger2
orderBestämmer vilken ordning suggestions visas.Ja, vid fler än ett suggestionsInteger”2”
postbackDataDen data du får tillbaka vid ett klick.JaString”track_sale_click”
urlMål-URL (krävs för typ 2).NejString”https://site.se/shop”
TitleTiteln för Visa plats på karta samt Kalenderhändelse.Krävs vid typ 5 och 3String”Vår butik”
DescriptionBeskrivning av en kalenderhändelse.Krävs vid typ 3String”Välkommen på klippning!”
StartTime
Starttiden för en kalenderhändelse.		Krävs vid typ 3String”2026-07-01T14:30”
EndTime
Sluttiden för en kalenderhändelse.		Krävs vid typ 3String”2026-07-01T15:30”
LatitudeLatituden för att visa en plats på en karta.Krävs vid typ 5String”58.3944347”
LongitudeLongituden för att visa en plats på en karta.Krävs vid typ 5String”13.8601547,18”
PhoneNumberTelefonnumret som rings upp vid knapptryckKrävs vid typ 6String”46101606060”

Respons #

Returnerar första meddelandet i den skapade konversationen.

Exempel på responsdata #

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "id": "65eb3d14f1234567890abcdef",
  "conversationId": "65e15d14f1234547890ghijkl",
  "brand": "min-butik-ab",
  "agent": "kundservice"
  "recipient": "46700123456",
  "type": "Carousell",
  "content": "Hej! Hur kan vi hjälpa dig idag?",
    "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
    }
  ]
  "modified": "2026-03-09T08:00:05Z",
  "uniqueId": "conversation-12345-id"
}

Fält för responsdata #

FältnamnBeskrivningTypExempel
idMeddelande ID som den aktuella konversationen hör tillString"65eb3d14f1234567890abcdef"
brandVarumärkets interna namn.String”min-butik-ab”
agentAgenten som hanterar konversationen.String”kundservice”
conversationIdDen aktuella konversationens IDString”65e15d14f1234547890ghijkl”
recipientMottagarens nummerObject”46700123456”: { ”name”: ”Kalle” }
contentDet första meddelandet i konversationens innehållString”Hej! Hur kan vi hjälpa dig idag?”
typeDet första meddelandet i konversationens typString”Carousell”
modifiedDatumstämpel för senaste ändringen (Statusuppdatering, svar etc.)DateTime”2026-03-09T08:00:05Z”
uniqueIdUnikt ID för att undvika dubbletter.String”conversation-12345-id”

Fortsätt konversation #

Används för att skicka ytterligare meddelanden i en redan pågående konversation.

Quick start #

💻
Quick start (cURL)
Kopiera till urklipp
curl -X POST https://api.ip1.net/v3/conversations/65e15d14f1234547890ghijkl \
  -H "Authorization: Bearer API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content": "Här kommer informationen du bad om."}'

Anrop #

Endpoint: /conversations/{conversation}

Metod: GET

Exempel på anropsdata #

🔷
Anrop (URL)
Kopiera till urklipp
https://api.ip1.net/v3/conversations/65e15d14f1234547890ghijkl

Fält för anrop #

FältnamnBeskrivningRequiredTypExempel
idID för konversationen du vill fortsätta.JaQuery Param65e15d14f1234547890ghijkl

Respons #

Returnerar detaljer om det nya meddelandet i konversationen.

Exempel på responsdata #

📋
Responsdata (JSON)
Kopiera till urklipp
{
"id": "65eb3d14f1234567890abcdef",
"conversationId": "65e15d14f1234547890ghijkl",
"brand": "min-butik-ab",
"agent": "kundservice"
"recipient": "46700123456",
"content": "Hej! Hur kan vi hjälpa dig idag?",
"type": "Carousell"
"modified": "2026-03-09T08:00:05Z",
"uniqueId": "conversation-12345-id"
}

Exempel på responsdata #

FältnamnBeskrivningTypExempel
idDet nya meddelandets IDString"65eb3d14f1234567890abcdef"
brandVarumärkets interna namn.String”min-butik-ab”
agentAgenten som hanterar konversationen.String”kundservice”
conversationIdDen aktuella konversationens IDString”65e15d14f1234547890ghijkl”
recipientMottagarens nummerObject”46700123456”: { ”name”: ”Kalle” }
contentDet nya meddelandets innehållString”Hej! Hur kan vi hjälpa dig idag?”
typeDet nya meddelandets TypString”Carousell”
modifiedDatumstämpel för senaste ändringenDateTime”2026-03-09T08:00:05Z”
uniqueIdUnikt ID för att undvika dubbletter.String”conversation-12345-id”
Innehåll