Envoyer un message RCS (Rich Card Carousel)

Dans cet extrait de code, vous apprendrez comment envoyer un message RCS Rich Card Carousel à l'aide de la fonction carousel type de message du canal RCS de l'API Messages

Exemple

Vous trouverez ci-dessous la description de toutes les variables utilisées dans chaque extrait de code :

CléDescription
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_PRIVATE_KEY_PATH

Private key path.

MESSAGES_API_URL

There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was https://api.nexmo.com/v0.1/messages, the new one is https://api.nexmo.com/v1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages or https://messages-sandbox.nexmo.com/v1/messages, depending on which version you have set in the sandbox dashboard.

JWT

Used to authenticate your request. See Authentication for more information, including how to generate a JWT.

IMAGE_URL

The link to the image file to send.

VIDEO_URL

The link to the video to send. RCS supports .mp4 .m4v .h263 .mpeg .webm file formats.

TO_NUMBER

The number you are sending the RCS message to in E.164 format. For example 447700900000.

RCS_SENDER_ID

The sender ID for the RCS message.

NOTE : N'utilisez pas de point de départ + ou 00 lorsque vous saisissez un numéro de téléphone, commencez par l'indicatif du pays, par exemple 447700900000.

Conditions préalables

Si vous n'avez pas de demande, vous pouvez créer un. Veillez également à configurer vos webhooks.

Rédiger le code

Ajouter ce qui suit à send-rich-card-carousel.sh:

curl -X POST "${MESSAGES_API_URL}" \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${RCS_SENDER_ID}'",
    "channel": "rcs",
    "message_type": "carousel",
    "carousel": {
      "cards": [
        {
          "title": "Option 1: Photo",
          "text": "Do you prefer this photo?",
          "media_url": "'${MESSAGES_IMAGE_URL}'",
          "media_height": "SHORT",
          "media_description": "Picture of a cat",
          "thumbnail_url": "'${MESSAGES_IMAGE_URL}'",
          "media_force_refresh": false,
          "suggestions": [
            {
              "type": "reply",
              "text": "Option 1",
              "postback_data": "card_1"
            }
          ]
        },
        {
          "title": "Option 2: Video",
          "text": "Or this video?",
          "media_url": "'${MESSAGES_VIDEO_URL}'",
          "media_height": "SHORT",
          "media_description": "Video of a cat",
          "thumbnail_url": "'${MESSAGES_IMAGE_URL}'",
          "media_force_refresh": false,
          "suggestions": [
            {
              "type": "reply",
              "text": "Option 2",
              "postback_data": "card_2"
            }
          ]
        }
      ]
    },
    "rcs": {
      "card_width": "SMALL"
    }
  }'

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

bash send-rich-card-carousel.sh

Essayez-le

Lorsque vous exécutez le code, un message est envoyé au numéro de destination.