Cards | RCS-API.com

Observera att kort skapas som en del av ett meddelande via /bundles eller /conversations, men du kan hämta detaljer om dem efteråt via dessa endpoints.

Hämta samtliga cards för ett meddelande

⚡Quick start

curl -X GET https://api.ip1.net/v3/messages/msg-12345/cards \
  -H "Authorization: Bearer DIN_API_TOKEN"

Anrop

Endpoint: /messages/{messageId}/cards

Metod: GET

Exempel på anropsdata

Detta anrop kräver ingen body. Meddelandets ID skickas i URL:en

https://api.ip1.net/v3/messages/65eb3d14f1234567890abcdef/cards

Fält för anropsdata

Fältnamn	Beskrivning	Required	Typ	Exempel
messageId	ID för det meddelande som vars kort du vill lista	Ja	Query Param	`65eb3d14f1234567890abcdef`

Respons

Returnerar en lista med de kort som ingår i meddelandet (t.ex. ett enskilt kort eller flera i en karusell).

Exempel på responsdata

[
  {
    "id": "65eb3d14f1234567890a1b2c3d4",
    "messageId": "msg-12345",
    "type": "Standalone",
    "order": 0,
    "title": "Vår stora sommarrea!",
    "content": "Klicka nedan för att se alla fantastiska erbjudanden.",
    "mediaUrl": "https://cdn.site.se/summer-sale.jpg",
    "height": "Medium",
    "width": 1,
    "orientation": "Horizontal",
    "suggestions": [
      {
        "text": "Se rean",
        "type": "OpenUrlAction",
        "url": "https://site.se/rea"
      }
    ]
  }
]

Fält för responsdata

Fältnamn	Beskrivning	Typ	Exempel
id	Unikt ID för kortet.	String	`65eb3d14f1234567890a1b2c3d4`
messageId	ID för meddelandet som kortet tillhör.	String	`65eb3d14f784682890abc24f`
type	Typ av kort.	String (enum)	”Standalone”
order	Kortets position.	Integer	0
title	Rubriken på kortet (max 100 tecken).	String	”Vår stora sommarrea!”
content	Den beskrivande texten (max 2000 tecken).	String	”Klicka nedan…”
mediaUrl	URL till bild eller video.	URI	”https://cdn.se/bild.jpg”
height	Höjd (1=Small, 2=Medium, 3=Large).	String (enum)	”Medium”
width	Bredd (1=Small, 2=Large).	String (enum)	”Large”
orientation	Orientering (1=Horizontal, 2=Vertical).	String (enum)	”Horizontal”
suggestions	En lista med knappar kopplade direkt till kortet.	Array	[…]

Hämta förslag för ett specifikt kort

Om du vill hämta enbart de knappar (suggestions) som hör till ett specifikt kort i ett meddelande.

⚡Quick start

curl -X GET https://api.ip1.net/v3/messages/msg-123/cards/card-888/suggestions \
  -H "Authorization: Bearer DIN_API_TOKEN"

Anrop

Endpoint: /messages/{messageId}/cards/{cardId}/suggestions

Metod: GET

Exempel på anropsdata

Detta anrop kräver ingen body. Meddelandets ID skickas i URL:en

https://api.ip1.net/v3/messages/65eb3d14f784682890abc24f/cards/65eb3d14f1234567890a1b2c3d4/suggestions

Fält för anropsdata

Fältnamn	Beskrivning	Required	Typ	Exempel
messageId	Meddelande ID.	Ja	Query Param	`65eb3d14f1234567890abcdef`
cardId	Unikt ID för kortet.	Ja	Query Param	`65eb3d14f1234567890a1b2c3d4`

Respons

Returnerar ett listobjekt med samtliga suggestions/knappar för det valda kortet

Exempel på responsdata

[
  {
    "id": "65eb3d14f1234567890a1e2f3dg",
    "messageId": "65eb3d14f1234567890abcdef",
    "cardId": "65eb3d14f1234567890a1b2c3d4",
    "type": "DialAction",
    "order": 0,
    "text": "Ring oss nu",
    "postbackData": "call_clicked",
    "phoneNumber": "+468123456",
  }
]

Fält för responsdata

Fältnamn	Beskrivning	Typ	Exempel
id	Suggestion/knapp id.	String	`65eb3d14f1234567890abcdef`
messageId	Meddelande ID	String	65eb3d14f1234567890abcdef
cardId	Unikt ID för kortet som suggestion/knapp tillhör.	String	`65eb3d14f1234567890a1b2c3d4`
type	typen för suggestion/knapp	String	”DialAction”
order	Suggestion/Knappens ordning på kortet.	Integer	0
text	Texten som står på Suggestion/knappen.	String	”Ring oss”
postbackData	Den kod som skickas till din webhook vid klick.	String	”call_button_clicked”
phoneNumber	Telefonnummer (Knutet till typ 4)	String	”+46101606060”

Vill du veta mer?

Läs vår guide för Rich Cards för att ta dela av best practices och kodexempel.

RCS Rich Cards – Den kompletta guiden