Versenden von Rich Cards und Karussells

In diesem Leitfaden wird erläutert, wie Sie mit der Vonage Messages API Rich Cards und Karussells versenden können. Weitere Einzelheiten zu den verschiedenen Nachrichtentypen und ihren Komponenten finden Sie unter Reichhaltige Karten und Karussell-Typen.

Reichhaltige Karte senden

Mit einer Rich Card können Sie visuell ansprechende Nachrichten an RCS-Nutzer senden. Karten können einen Titel, Text, Medien (z. B. ein Bild oder Video) und bis zu vier Antwort- oder Aktionsvorschläge enthalten.

Voraussetzungen

Definieren Sie die Rich Card-Elemente

Jede card Objekt enthalten muss:

  • title - Der Titel der Karte (max. 200 Zeichen)
  • text - Eine Textbeschreibung (max. 2000 Zeichen)
  • media_url - Eine öffentliche URL des Bildes oder Videos

Sie können auch optional hinzufügen:

  • media_height - SHORT, MEDIUM, oder TALL
  • media_description - für Barrierefreiheit
  • thumbnail_url - Platzhalterbild beim Laden der Medien
  • suggestions - interaktive Antwort- oder Aktionsvorschläge

Hinzufügen der RCS-Parameter

Eine RCS-Kartennachricht muss eine rcs Objekt spezifizieren:

  • card_orientation: VERTICAL oder HORIZONTAL
  • image_alignment: LEFT oder RIGHT (nur für horizontale Karten)

Senden Sie die Nachricht

Verwendung der Messages API POST Endpunkt und nehmen Sie die Rich Card in den Anfragekörper auf.

Hier ist ein Beispiel für eine eigenständige Rich-Card-Nachricht:

{
  "to": "447700900000",
  "from": "Vonage",
  "channel": "rcs",
  "message_type": "card",
  "card": {
    "title": "Hello, world!",
    "text": "This is some text to display on the card.",
    "media_url": "https://example.com/image.jpg",
    "media_description": "Image description for accessibility purposes.",
    "media_height": "TALL",
    "thumbnail_url": "https://example.com/thumbnail.jpg",
    "media_force_refresh": false,
    "suggestions": [
      {
        "type": "suggested_reply",
        "text": "Suggestion #1",
        "postback_data": "suggestion_1"
      },
      {
        "type": "suggested_reply",
        "text": "Suggestion #2",
        "postback_data": "suggestion_2"
      }
    ]
  },
  "rcs": {
    "image_alignment": "RIGHT",
    "card_orientation": "VERTICAL"
  }
}

Ein Karussell senden

Mit einem reichhaltigen Kartenkarussell können Sie 2-10 Karten zu einer einzigen Nachricht kombinieren. Jede Karte kann ihre eigenen Medien und Vorschläge haben.

Jede Karte muss enthalten:

  • title - Der Titel der Karte (max. 200 Zeichen)
  • text - Textbeschreibung (max. 2000 Zeichen)
  • media_url - Eine öffentliche URL für ein Bild oder Video

Optionale Parameter (pro Karte):

  • media_height - SHORT, MEDIUM, oder TALL
  • media_description - für Barrierefreiheit
  • thumbnail_url - wird angezeigt, während die Medien geladen werden
  • media_force_refresh - ob die Aktualisierung erzwungen werden soll
  • suggestions - bis zu 4 Antwort- oder Aktionsvorschläge
{
 "to": "447700900000",
 "from": "Vonage",
 "channel": "rcs",
 "message_type": "carousel",
 "carousel": {
   "cards": [
     {
       "title": "Card 1",
       "text": "Description for card 1",
       "media_url": "https://example.com/image1.jpg",
       "media_height": "TALL",
       "suggestions": [
         {
           "type": "reply",
           "text": "Yes",
           "postback_data": "suggestion_1"
         }
       ]
     },
     {
       "title": "Card 2",
       "text": "Description for card 2",
       "media_url": "https://example.com/image2.jpg",
       "media_height": "TALL",
       "suggestions": [
         {
           "type": "reply",
           "text": "No",
           "postback_data": "suggestion_2"
         }
       ]
     }
   ]
 },
 "rcs": {
   "card_width": "MEDIUM"
 }
}

Weitere Informationen