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 custom 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 custom message type see RCS Custom Messages

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:

curl -X POST $MESSAGES_API_URL \
     -H 'Authorization: Bearer '$JWT \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
  "message_type": "custom",
  "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": "'$TO_NUMBER'",
  "from": "'$RCS_SENDER_ID'",
  "channel": "rcs"
}'

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.

npm install @vonage/server-sdk

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

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

const vonage = new Vonage({
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_PRIVATE_KEY,
});

View full source

Write the code

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

vonage.messages.send(
  new RCSCustom({
    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: 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:

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

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

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

View full source

Write the code

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

val messageId = client.messages.send(
    rcsCustom {
        to(TO_NUMBER)
        from(RCS_SENDER_ID)
        custom(mapOf(
            "contentMessage" to mapOf(
                "text" to "Product Launch: Save the date!",
                "suggestions" to listOf(
                    mapOf(
                        "action" to mapOf(
                            "text" to "Save to calendar",
                            "postbackData" to "postback_data_1234",
                            "fallbackUrl" to "https://www.google.com/calendar",
                            "createCalendarEventAction" to mapOf(
                                "startTime" to "2024-06-28T19:00:00Z",
                                "endTime" to "2024-06-28T20:00:00Z",
                                "title" to "Vonage API Product Launch",
                                "description" to "Event to demo Vonage's new and exciting API product"
                            )
                        )
                    )
                )
            )
        ))
    }
)

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 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:

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

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)

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(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:

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 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.

Install-Package Vonage

Write the code

Add the following to SendRcsSuggestedActionCreateCalendarMessage.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(appId, privateKeyPath);
var vonageClient = new VonageClient(credentials);
var request = new RcsCustomRequest
{
    To = to,
    From = rcsSenderId,
    Custom =
        new
        {
            ContentMessage = new
            {
                Text = "Product Launch: Save the date!",
                Suggestions = new[]
                {
                    new
                    {
                        Action = new
                        {
                            Text = "Save to calendar",
                            PostbackData = "postback_data_1234",
                            FallbackUrl = "https://www.google.com/calendar",
                            CreateCalendarEventAction = new
                            {
                                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",
                            }
                        }
                    }
                }
            }
        }
};
var response = await vonageClient.MessagesClient.SendAsync(request);
Console.WriteLine($"Message UUID: {response.MessageUuid}");

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-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.

pip install vonage

Write the code

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

from vonage import Auth, Vonage
from vonage_messages.models import RcsCustom

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

custom_dict = {
    "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",
                    },
                }
            }
        ],
    }
}
message = RcsCustom(
    to=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 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.

gem install vonage

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

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: File.read(VONAGE_APPLICATION_PRIVATE_KEY_PATH)
)

View full source

Write the code

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

message = client.messaging.rcs(
  type: 'custom',
  message: {
    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-08-24T20:00:00Z",
              endTime: "2024-08-24T22:00:00Z",
              title: "Vonage API Product Launch",
              description: "Join us for the launch of our latest product!"
            }
          }
        }
      ]
    }
  }
)

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

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.