Skicka RCS (Enskild mottagare)

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

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",
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure, FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation": "Horizontal"
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}'

Anrop

Endpoint: /conversations

Metod: POST

Exempel på anropsdata

{
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "recipient": "46700123456",
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure,FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation":
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1,
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_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”
recipient	Mottagarens nummer	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.”
fallbackPolicy	Typ av SMS-fallback-policy (NoFallback, FallbackOnNoCapability, FallbackOnFailure, FallbackAfterTimeout, CustomerControlledFallback).	Nej (Default är NoFallback)	String	”FallbackOnNoCapability,FallbackOnFailure, FallbackAfterTimeout”
fallbackMessage	Specifikt meddelande som skickas ut som fallback	Ja, vid användande av Carousel. Autogenereras card eller content om inget anges.	String	”Detta är ett fallbackmeddelande”
fallbackTimeoutSeconds	Tid i sekunder innan fallback-policyn aktiverar (Om FallbackAfterTimeOut är vald)	Ja, om fallBackAfterTimout är vald.	Integer	500
type	Meddelandet i konversationens typ	Ja	String	”Carousel”
carousel	En lista av flera kort som skapar en Karusell	Krävs om typen är ”Carousel”	Array	(Se tabell nedan)
card	Innehåller bild, rubrik och text (Rich Card).	Krävs om typen är ”Card”	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 (Carousel för Rich Card i karusell).	Nej	Integer	”Carousel”
order	Ordning som korten visas	Nej	Integer	1
height	Kortets höjd	Nej	String (enum)	”Medium”
width	Kortets bredd	Nej	String (enum(	”Medium”
orientation	Kortets läge	Nej	String (enum)	”Horizontal”
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 (”OpenUrlAction”= URL, ”ShareLocationAction”= Dela Plats, ”ViewLocationAction”= Visa plats ”DialAction”=Ring), ”CreateCalendarEventAction” = Skapa kalenderhändelse.	Ja	Integer	”OpenUrlAction”
order	Bestämmer vilken ordning suggestions visas.	Nej	Integer	2
postbackData	Den data du får tillbaka vid ett klick.	Ja	String	”track_sale_click”
url	Mål-URL (krävs för typ 2).	Nej	String	”https://site.se/shop”
Title	Titeln för Visa plats på karta samt Kalenderhändelse.	Krävs vid typ ShareLocationAction och ViewLocationAction	String	”Vår butik”
Description	Beskrivning av en kalenderhändelse.	Krävs vid typ CreateCalendarEventAction	String	”Välkommen på klippning!”
StartTime	Starttiden för en kalenderhändelse.	Krävs vid typ CreateCalendarEventAction	String	”2026-07-01T14:30”
EndTime	Sluttiden för en kalenderhändelse.	Krävs vid typ CreateCalendarEventAction	String	”2026-07-01T15:30”
Latitude	Latituden för att visa en plats på en karta.	Krävs vid typ ViewLocationAction	String	”58.3944347”
Longitude	Longituden för att visa en plats på en karta.	Krävs vid typ ViewLocationAction	String	”13.8601547,18”
PhoneNumber	Telefonnumret som rings upp vid knapptryck	Krävs vid typ DialAction	String	”46101606060”

Respons

Returnerar första meddelandet i den skapade konversationen.

Exempel på responsdata

{
  "id": "65eb3d14f1234567890abcdef",
  "conversationId": "65e15d14f1234547890ghijkl",
  "owner": "ip1-xxxx",
  "brand": "min-butik-ab",
  "agent": "kundservice"
  "recipient": "46700123456",
  "direction": "MT",
  "type": "Carousell",
  "content": "Hej! Hur kan vi hjälpa dig idag?",
  "modified": "2026-03-09T08:00:05Z",
  "fallback": {
    "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure",
    "fallbackMessage": "Detta är ett fallback-meddelande",
    "fallbackStatus": "Unknown"
  },
  "statuses": [
      {
      "code": 101,
      "duration": 0,
      "created": "2026-10-02T11:20:21.4129735Z"
      }
    ]
}

Fält för responsdata

Fältnamn	Beskrivning	Typ	Exempel
id	Meddelande ID som den aktuella konversationen hör till	String	`"65eb3d14f1234567890abcdef"`
brand	Varumärkets interna namn.	String	”min-butik-ab”
agent	Agenten som hanterar konversationen.	String	”kundservice”
conversationId	Den aktuella konversationens ID	String	”65e15d14f1234547890ghijkl”
owner	Kontot som startade konversationen	String	”ip1-xxxx”
recipient	Mottagarens nummer	Object	”46700123456”: { ”name”: ”Kalle” }
direction	Om meddelandet i konversation är ett inkommande (MO) eller utgående (MT).	String	”MT”
content	Det första meddelandet i konversationens innehåll (Om det content knutet är knutet till ett kort)	String	”Hej! Hur kan vi hjälpa dig idag?”
type	Det första meddelandet i konversationens typ	String	”Carousell”
fallback	Ett objekt för att samla information kring Fallback.	Object	Se tabell nedan för detaljer
modified	Datumstämpel för senaste ändringen (Statusuppdatering, svar etc.)	DateTime	”2026-03-09T08:00:05Z”
uniqueId	Unikt ID för att undvika dubbletter.	String	”conversation-12345-id”

Responsdata för Fallback-objektet

Fältnamn	Beskrivning	Typ	Exempel
fallbackPolicy	Typ av SMS-fallback-policy (NoFallback, FallbackOnNoCapability, FallbackOnFailure, FallbackAfterTimeout, CustomerControlledFallback). En del av Falback-objektet.	String	”FallbackOnFailure, FallbackOnNoCapability”
fallbackMessage	Specifikt meddelande som skickas ut vid aktiverad fallback	String	”Detta är ett fallbackmeddelande”
fallbackStatus	Status för fallback (Unknown, Pending, Sent, Completed, Failed,)	String (enum)	”Pending”
fallbackTimeout	Visar hur lång tid som går innan fallback-policy . Inträder vid policy ”FallbackAfterTimeout”	Time	00:05:00
fallbackReason	Anledning till fallback triggats.	String	”FallbackOnNoCapability”
fallbackMessageId	ID för själva fallbackmeddelandet	String	”65eg3d14s1234667890obcdhf”

Fortsätt konversation

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

Quick start

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: POST

Exempel på anropsdata

{
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure,FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation":
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1,
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}

Fält för anrop

Se tabell för Starta konversation

Respons

Returnerar detaljer om det nya meddelandet i konversationen.

Exempel på responsdata

Se respons-data för att starta en ny konversation

Skicka RCS (Enskild mottagare)

Starta en ny konversation

Quick start

Anrop

Exempel på anropsdata

Fält för anropsdata

Detaljer för fältet card

Detaljer för fältet suggestions

Respons

Exempel på responsdata

Fält för responsdata

Responsdata för Fallback-objektet

Fortsätt konversation

Quick start

Anrop

Exempel på anropsdata

Fält för anrop

Respons

Exempel på responsdata

Detaljer för fältet `card`

Detaljer för fältet `suggestions`