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
NEXMO_APPLICATION_ID The ID of the application that you created.
FROM_NUMBER The phone number you are sending the SMS from.
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

Create an application
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-sms-with-failover.sh:

Copy to Clipboard
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"
          }
        }
      }
    ]
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-sms-with-failover.sh

Prerequisites

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

npm install nexmo@beta

Write the code

Add the following to send-failover-sms-sms.js:

Copy to Clipboard
const nexmo = new Nexmo({
  apiKey: NEXMO_API_KEY,
  apiSecret: NEXMO_API_SECRET,
  applicationId: NEXMO_APPLICATION_ID,
  privateKey: NEXMO_APPLICATION_PRIVATE_KEY_PATH
});

nexmo.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);
    }
  }
);

View full source

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.