Send a Message with Failover

If a message sent with the Vonage Messages API is rejected, failover messages can be defined to be sent in its place. Failover can be done from any channel or message type to any other channel or message type, however the following example shows failover from RCS to SMS.

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.
`TO_NUMBER`	The number you are sending the to in E.164 format. For example `447700900000`.
`RCS_SENDER_ID`	The sender ID for the RCS message.
`JWT`	Used to authenticate your request. See Authentication for more information, including how to generate a JWT.
`SMS_SENDER_ID`	The alphanumeric string that represents the name or number of the organization sending the message.
`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.

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-message-with-failover.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": "text",
    "text": "This is an RCS text message sent via the Vonage Messages API",
    "failover": [
      {
        "to": "'${MESSAGES_TO_NUMBER}'",
        "from": "'${SMS_SENDER_ID}'",
        "channel": "sms",
        "message_type": "text",
        "text": "This is an SMS sent using the Vonage Messages API."
      }
    ]
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-message-with-failover.sh

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

val messageId = client.messages.send(
    rcsText {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        text("This is an RCS text message sent using the Messages API")
        failover(
            smsText {
                to(MESSAGES_TO_NUMBER)
                from(SMS_SENDER_ID)
                text("This is an SMS sent using the Vonage Messages API.")
            }
        )
    }
)

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 with the package containing SendMessageWithFailover:

gradle run -Pmain=com.vonage.quickstart.kt.messages.SendMessageWithFailover

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

var response = client.getMessagesClient().sendMessage(
		RcsTextRequest.builder()
			.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.text("This is an RCS message sent via the Vonage Messages API")
			.failover(SmsTextRequest.builder()
					.from(SMS_SENDER_ID).to(MESSAGES_TO_NUMBER)
					.text("This is an SMS sent using the Vonage Messages API.")
					.build()
			)
			.build()
);
System.out.println(response);

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 with the package containing SendMessageWithFailover:

gradle run -Pmain=com.vonage.quickstart.messages.SendMessageWithFailover

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

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "This is an RCS text message sent via the Vonage Messages API",
    Failover = new List<IMessage>
    {
        new SmsRequest
        {
            To = MESSAGES_TO_NUMBER,
            From = SMS_SENDER_ID,
            Text = "This is an SMS text message sent via the Vonage Messages API"
        }
    }
};
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.

gem install vonage

Create a file named send-message-with-failover.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-message-with-failover.rb:

rcs_message = client.messaging.rcs(
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
  type: 'text',
  message: 'This is an RCS text message sent via the Vonage Messages API'
)

sms_message = client.messaging.sms(
    to: MESSAGES_TO_NUMBER,
    from: SMS_SENDER_ID,
    message: 'This is a failover SMS message in case the RCS message is rejected.'
  )

client.messaging.send(
  **rcs_message,
  failover: [sms_message]
)

View full source

Run your code

Save this file to your machine and run it:

ruby send-message-with-failover.rb

Try it out

When you run the code an RCS message is sent to the destination number; if that message is rejected, an SMS message will be sent in its place.