Send a RCS Suggested Action (Dial a Number) 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 dial a specified number.

Example

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

KeyDescription
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 for the to number (i.e. the number to which to send the RCS message), start with the country code, for example 447700900000.

For the value of phoneNumber in the dialAction, however, a + should be used to prepend the country code, e.g +447900000000.

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-dial.sh:

View full source

Run your code

Save this file to your machine and run it:

bash send-suggested-action-dial.sh

Try it out

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