Send a RCS Suggested Action (Create Calendar Event) Message

In this code snippet you learn how to send a RCS Suggested Action message using the text message type of the Messages API RCS channel. This message will prompt the recipient to create a calendar event via their device's calendar app.

For more information on RCS Messaging see Understanding RCS messaging
For a detailed guide on the suggestions chips see RCS Suggestions Chips

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.
`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-suggested-action-create-calendar-event.sh:

View full source

Run your code

Save this file to your machine and run it:

bash send-suggested-action-create-calendar-event.sh

Prerequisites

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

Create a file named send-suggested-action-create-calendar-event.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-suggested-action-create-calendar-event.js:

vonage.messages.send({
  messageType: 'custom',
  channel: Channels.RCS,
  custom: {
    contentMessage: {
      text: 'Product Launch: Save the date!',
      suggestions: [
        {
          action: {
            text: 'Save to calendar',
            postbackData: 'postback_data_1234',
            fallbackUrl: 'https://www.google.com/calendar',
            createCalendarEventAction: {
              startTime: '2024-06-28T19:00:00Z',
              endTime: '2024-06-28T20:00:00Z',
              title: 'Vonage API Product Launch',
              description: 'Event to demo Vonage\'s new and exciting API product',
            },
          },
        },
      ],
    },
  },
  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-suggested-action-create-calendar-event.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:

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

View full source

Write the code

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

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:

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

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

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:

Create a file named SendRcsSuggestedCalendarEvent 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 SendRcsSuggestedCalendarEvent file:

var response = client.getMessagesClient().sendMessage(
	RcsCustomRequest.builder()
		.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of("contentMessage", Map.of(
				"text", "Product Launch: Save the date!",
				"suggestions", List.of(
					Map.of(
						"action", Map.of(
							"text", "Save to calendar",
							"postbackData", "postback_data_1234",
							"fallbackUrl", "https://www.google.com/calendar",
							"createCalendarEventAction", Map.of(
								"startTime", Instant.ofEpochSecond(1719604800),
								"endTime", Instant.ofEpochSecond(1719601200),
								"title", "Vonage API Product Launch",
								"description", "Event to demo Vonage's new and exciting API product"
							)
						)
					)
				)
			))
		).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:

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

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

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 SendRcsSuggestedActionCreateCalendarMessage.cs:

View full source

Prerequisites

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

Create a file named send-suggested-action-create-calendar-event.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-suggested-action-create-calendar-event.php:

$rcsCard = new Vonage\Messages\Channel\RCS\RcsCustom(
    '07778887777',
    '09997485156',
    [
        "contentMessage" => [
            "text" => "Product Launch: Save the date!",
            "suggestions" => [
                [
                    "action" => [
                        "text" => "Save to calendar",
                        "postbackData" => "postback_data_1234",
                        "fallbackUrl" => "https://www.google.com/calendar",
                        "createCalendarEventAction" => [
                            "startTime" => "2024-06-28T19:00:00Z",
                            "endTime" => "2024-06-28T20:00:00Z",
                            "title" => "Vonage API Product Launch",
                            "description" =>
                                "Event to demo Vonage\'s new and exciting API product",
                        ],
                    ],
                ],
            ],
        ],
    ]
);

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

View full source

Run your code

Save this file to your machine and run it:

php send-suggested-action-create-calendar-event.php

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-suggested-action-create-calendar-event.py:

View full source

Run your code

Save this file to your machine and run it:

python messages/rcs/send-suggested-action-create-calendar-event.py

Prerequisites

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

Create a file named send-suggested-action-create-calendar-event.rb and add the following code:

View full source

Write the code

Add the following to send-suggested-action-create-calendar-event.rb:

View full source

Run your code

Save this file to your machine and run it:

ruby send-suggested-action-create-calendar-event.rb

Try it out

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