Send an SMS with failover
In this example you will send an SMS that can fail over to sending an SMS.
In the Workflow object, message objects can be placed in any order to suit your use case. Each message object must contain a failover object, except for the last message, as there are no more message objects to failover to.
Example
Ensure the following variables are set to your required values using any convenient method:
Key | Description |
---|---|
VONAGE_APPLICATION_ID |
The Vonage Application ID. |
FROM_NUMBER |
Replace with number you are sending from. E.g. 447700900002
|
TO_NUMBER_1 |
The phone number you are sending the SMS to. |
TO_NUMBER_2 |
The phone number of the second phone. In this example, the workflow will failover to this number if the first message is not read in 60 seconds. |
NOTE: Don't use a leading +
or 00
when entering a phone number, start with the country code, for example 447700900000.
Prerequisites
Write the code
Add the following to send-sms-with-failover.sh
:
curl -X POST https://api.nexmo.com/v0.1/dispatch \
-H 'Authorization: Bearer '$JWT\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d $'{
"template":"failover",
"workflow": [
{
"from": { "type": "sms", "number": '$FROM_NUMBER' },
"to": { "type": "sms", "number": '$TO_NUMBER_1' },
"message": {
"content": {
"type": "text",
"text": "Dispatch API: Message 1"
}
},
"failover":{
"expiry_time": 60,
"condition_status": "read"
}
},
{
"from": {"type": "sms", "number": '$FROM_NUMBER'},
"to": { "type": "sms", "number": '$TO_NUMBER_2'},
"message": {
"content": {
"type": "text",
"text": "Dispatch API: Message 2"
}
}
}
]
}'
Run your code
Save this file to your machine and run it:
bash send-sms-with-failover.sh
Prerequisites
npm install @vonage/server-sdk@beta
Write the code
Add the following to send-failover-sms-sms.js
:
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET,
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH
});
vonage.dispatch.create(
"failover",
[
{
from: { type: "sms", number: FROM_NUMBER },
to: { type: "sms", number: TO_NUMBER_1 },
message: {
content: {
type: "text",
text: "Dispatch API: Message 1"
}
},
failover: {
expiry_time: 60,
condition_status: "read"
}
},
{
from: { type: "sms", number: FROM_NUMBER },
to: { type: "sms", number: TO_NUMBER_2 },
message: {
content: {
type: "text",
text: "Dispatch API: Message 2"
}
}
}
],
(err, data) => {
if (err) {
console.error(err);
} else {
console.log(data.dispatch_uuid);
}
}
);
Run your code
Save this file to your machine and run it:
node send-failover-sms-sms.js
Try it out
When you run the code it will attempt to send an SMS to phone 1. If this fails, then a message will be sent via SMS to phone 2.
NOTE: Correct functioning of this code snippet will depend on the support provided by the underlying network. For example, availability of delivery and read receipts.