Comment envoyer des cartes enrichies et des carrousels

Ce guide explique comment envoyer des cartes enrichies et des carrousels à l'aide de l'API Messages de Vonage. Pour plus de détails sur les différents types de messages et leurs composants, voir Types de cartes riches et de carrousels.

Envoyer une carte riche

Une carte riche vous permet d'envoyer des messages visuellement attrayants aux utilisateurs RCS. Les cartes peuvent inclure un titre, un texte, un média (tel qu'une image ou une vidéo), et jusqu'à quatre suggestions de réponses ou d'actions.

Conditions préalables

Définir les éléments de la carte riche

Chaque card doit inclure :

  • title - Le titre de la carte (200 caractères maximum)
  • text - Une description textuelle (max 2000 caractères)
  • media_url - URL publique de l'image ou de la vidéo

Vous pouvez également ajouter en option :

  • media_height - SHORT, MEDIUMou TALL
  • media_description - pour l'accessibilité
  • thumbnail_url - image de remplacement pendant le chargement des médias
  • suggestions - des suggestions de réponses ou d'actions interactives

Ajouter les paramètres RCS

Un message de carte RCS doit inclure un rcs spécifiant l'objet :

  • card_orientation: VERTICAL ou HORIZONTAL
  • image_alignment: LEFT ou RIGHT (uniquement pour les cartes horizontales)

Envoyer le message

Utiliser l'API Messages POST et inclure la carte riche dans le corps de la demande.

Voici un exemple de message de carte riche autonome :

{
  "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"
  }
}

Envoyer un carrousel

Un carrousel de cartes enrichi vous permet de combiner 2 à 10 cartes en un seul message. Chaque carte peut avoir son propre support et ses propres suggestions.

Chaque carte doit comprendre

  • title - Titre de la carte (200 caractères maximum)
  • text - Texte de description (max 2000 caractères)
  • media_url - URL publique d'une image ou d'une vidéo

Paramètres optionnels (par carte) :

  • media_height - SHORT, MEDIUMou TALL
  • media_description - pour l'accessibilité
  • thumbnail_url - s'affiche pendant le chargement des médias
  • media_force_refresh - forcer ou non le rafraîchissement
  • suggestions - jusqu'à 4 suggestions de réponses ou d'actions
{
 "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"
 }
}

Plus d'informations