Send a RCS Rich Card Carousel Message

In this code snippet you learn how to send a RCS Rich Card Carousel message using the carousel message type of the Messages API RCS channel

For more information on RCS Messaging see Understanding RCS messaging
For a detailed guide on the carousel message type see RCS Rich Cards Message Types

Example

Find the description for all variables used in each code snippet below:

Key	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: Don't use a leading + or 00 when entering a phone number, start with the country code, for example 447700900000.

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Write the code

Add the following to 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"
    }
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-rich-card-carousel.sh

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

npm install @vonage/server-sdk @vonage/messages

Create a file named send-rich-card-carousel.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');

/**
 * It is best to send messages using JWT instead of basic auth. If you leave out
 * apiKey and apiSecret, the messages SDK will send requests using JWT tokens
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

View full source

Write the code

Add the following to send-rich-card-carousel.js:

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      richCard: {
        carouselCard: {
          cardWidth: 'MEDIUM',
          cardContents: [
            {
              title: 'Option 1: Photo',
              description: 'Do you prefer this photo?',
              suggestions: [
                {
                  reply: {
                    text: 'Option 1',
                    postbackData: 'card_1',
                  },
                },
              ],
              media: {
                height: 'MEDIUM',
                contentInfo: {
                  fileUrl: MESSAGES_IMAGE_URL,
                  forceRefresh: 'false',
                },
              },
            },
            {
              title: 'Option 2: Video',
              description: 'Or this video?',
              suggestions: [
                {
                  reply: {
                    text: 'Option 2',
                    postbackData: 'card_2',
                  },
                },
              ],
              media: {
                height: 'MEDIUM',
                contentInfo: {
                  fileUrl: MESSAGES_VIDEO_URL,
                  forceRefresh: 'false',
                },
              },
            },
          ],
        },
      },
    },
  },
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node send-rich-card-carousel.js

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a file named SendRcsRichCardCarousel and add the following code to the main method:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

View full source

Write the code

Add the following to the main method of the SendRcsRichCardCarousel file:

val messageId = client.messages.send(
    rcsCustom {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "carouselCard" to mapOf(
                    "cardWidth" to "MEDIUM",
                    "cardContents" to listOf(
                        mapOf(
                            "title" to "Option 1: Photo",
                            "description" to "Do you prefer this photo?",
                            "suggestions" to listOf(
                                mapOf(
                                    "reply" to mapOf(
                                        "text" to "Option 1",
                                        "postbackData" to "card_1"
                                    )
                                )
                            ),
                            "media" to mapOf(
                                "height" to "MEDIUM",
                                "contentInfo" to mapOf(
                                    "fileUrl" to MESSAGES_IMAGE_URL,
                                    "forceRefresh" to "false"
                                )
                            )
                        ),
                        mapOf(
                            "title" to "Option 2: Video",
                            "description" to "Or this video?",
                            "suggestions" to listOf(
                                mapOf(
                                    "reply" to mapOf(
                                        "text" to "Option 2",
                                        "postbackData" to "card_2"
                                    )
                                )
                            ),
                            "media" to mapOf(
                                "height" to "MEDIUM",
                                "contentInfo" to mapOf(
                                    "fileUrl" to MESSAGES_VIDEO_URL,
                                    "forceRefresh" to "false"
                                )
                            )
                        )
                    )
                )
            )
        ))
    }
)

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.messages.rcs with the package containing SendRcsRichCardCarousel:

gradle run -Pmain=com.vonage.quickstart.kt.messages.rcs.SendRcsRichCardCarousel

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a file named SendRcsRichCardCarousel and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

View full source

Write the code

Add the following to the main method of the SendRcsRichCardCarousel file:

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"carouselCard", Map.of(
					"cardWidth", "MEDIUM",
					"cardContents", List.of(
						Map.of(
							"title", "Option 1: Photo",
							"description", "Do you prefer this photo?",
							"suggestions", List.of(
								Map.of(
									"reply", Map.of(
										"text", "Option 1",
										"postbackData", "card_1"
									)
								)
							),
							"media", Map.of(
								"height", "MEDIUM",
								"contentInfo", Map.of(
									"fileUrl", MESSAGES_IMAGE_URL,
									"forceRefresh", "false"
								)
							)
						),
						Map.of(
							"title", "Option 2: Video",
							"description", "Or this video?",
							"suggestions", List.of(
								Map.of(
									"reply", Map.of(
										"text", "Option 2",
										"postbackData", "card_2"
									)
								)
							),
							"media", Map.of(
								"height", "MEDIUM",
								"contentInfo", Map.of(
									"fileUrl", MESSAGES_VIDEO_URL,
									"forceRefresh", "false"
								)
							)
						)
					)
				)
			))
		).build()
);
System.out.println("Message sent successfully. ID: " + response.getMessageUuid());

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.messages.rcs with the package containing SendRcsRichCardCarousel:

gradle run -Pmain=com.vonage.quickstart.messages.rcs.SendRcsRichCardCarousel

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Install-Package Vonage

Write the code

Add the following to SendRcsCarouselRichCardMessage.cs:

var request = new RcsCarouselRequest()
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Carousel = new CarouselAttachment(
        new CardAttachment("Option 1: Photo", "Do you prefer this photo?", new Uri(MESSAGES_IMAGE_URL))
            .WithMediaDescription("Picture of a cat")
            .WithMediaHeight(CardAttachment.Height.Short)
            .WithThumbnailUrl(new Uri(MESSAGES_IMAGE_URL))
            .AppendSuggestion(new ReplySuggestion("Option 1", "card_1")),
        new CardAttachment("Option 2: Video", "Or this video?", new Uri(MESSAGES_VIDEO_URL))
            .WithMediaDescription("Video of a cat")
            .WithMediaHeight(CardAttachment.Height.Short)
            .WithThumbnailUrl(new Uri(MESSAGES_IMAGE_URL))
            .AppendSuggestion(new ReplySuggestion("Option 2", "card_2"))
        ),
    Rcs = new MessageRcs()
    {
      CardWidth  = RcsCardWidth.Small,
    },
};
var response = await vonageClient.MessagesClient.SendAsync(request);

View full source

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

composer require vonage/client

Create a file named send-rich-card-carousel.php and add the following code:

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

View full source

Write the code

Add the following to send-rich-card-carousel.php:

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "richCard" => [
                "carouselCard" => [
                    "cardWidth" => "MEDIUM",
                    "cardContents" => [
                        [
                            "title" => "Option 1: Photo",
                            "description" => "Do you prefer this photo?",
                            "suggestions" => [
                                [
                                    "reply" => [
                                        "text" => "Option 1",
                                        "postbackData" => "card_1"
                                    ]
                                ]
                            ],
                            "media" => [
                                "height" => "MEDIUM",
                                "contentInfo" => [
                                    "fileUrl" => "'\$IMAGE_URL'",
                                    "forceRefresh" => "false"
                                ]
                            ]
                        ],
                        [
                            "title" => "Option 2: Video",
                            "description" => "Or this video?",
                            "suggestions" => [
                                [
                                    "reply" => [
                                        "text" => "Option 2",
                                        "postbackData" => "card_2"
                                    ]
                                ]
                            ],
                            "media" => [
                                "height" => "MEDIUM",
                                "contentInfo" => [
                                    "fileUrl" => "'\$VIDEO_URL'",
                                    "forceRefresh" => "false"
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        ]
    ]
);

$client->messages()->send($rcsCard);

View full source

Run your code

Save this file to your machine and run it:

php send-rich-card-carousel.php

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

pip install vonage python-dotenv

Write the code

Add the following to send-rich-card-carousel.py:

from vonage import Auth, Vonage
from vonage_messages import RcsCustom

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

custom_dict = {
    "contentMessage": {
        "richCard": {
            "carouselCard": {
                "cardWidth": "MEDIUM",
                "cardContents": [
                    {
                        "title": "Option 1: Photo",
                        "description": "Do you prefer this photo?",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Option 1",
                                    "postbackData": "card_1",
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": MESSAGES_IMAGE_URL,
                                "forceRefresh": "false",
                            },
                        },
                    },
                    {
                        "title": "Option 2: Video",
                        "description": "Or this video?",
                        "suggestions": [
                            {
                                "reply": {
                                    "text": "Option 2",
                                    "postbackData": "card_2",
                                }
                            }
                        ],
                        "media": {
                            "height": "MEDIUM",
                            "contentInfo": {
                                "fileUrl": MESSAGES_VIDEO_URL,
                                "forceRefresh": "false",
                            },
                        },
                    },
                ],
            }
        }
    }
}

message = RcsCustom(
    to=MESSAGES_TO_NUMBER,
    from_=RCS_SENDER_ID,
    custom=custom_dict,
)

response = client.messages.send(message)
print(response)

View full source

Run your code

Save this file to your machine and run it:

python messages/rcs/send-rich-card-carousel.py

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

gem install vonage

Create a file named send-rich-card-carousel.rb and add the following code:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

View full source

Write the code

Add the following to send-rich-card-carousel.rb:

message = client.messaging.rcs(
  type: 'carousel',
  message: {
    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"
          }
        ]
      }
    ]
  },
  opts: {
    rcs: {
      card_width: "SMALL"
    }
  }
)

client.messaging.send(
  from: RCS_SENDER_ID,
  to: MESSAGES_TO_NUMBER,
  **message
)

View full source

Run your code

Save this file to your machine and run it:

ruby send-rich-card-carousel.rb

Try it out

When you run the code a message is sent to the destination number.