Send a Viber message with failover

In this example you will send a Viber message that fails 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`	Replace with the number you are sending to. E.g. `447700900001`
`VIBER_SERVICE_MESSAGE_ID`	Your Viber Service Message ID. For sandbox testing this is 16273.

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-viber-message-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": "viber_service_msg", "id": '$VIBER_SERVICE_MESSAGE_ID' },
        "to": { "type": "viber_service_message", "id": '$TO_NUMBER' },
        "message": {
          "content": {
            "type": "text",
            "text": "This is a Viber Message sent via the Dispatch API"
          }
        },
        "failover":{
          "expiry_time": 600,
          "condition_status": "read"
        }
      },
      {
        "from": {"type": "sms", "number": '$FROM_NUMBER'},
        "to": { "type": "sms", "number": '$TO_NUMBER'},
        "message": {
          "content": {
            "type": "text",
            "text": "This is an SMS sent via the Dispatch API"
          }
        }
      }
    ]
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-viber-message-with-failover.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@beta

Write the code

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

const Vonage = require("@vonage/server-sdk");

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: "viber_service_msg", id: VIBER_SERVICE_MESSAGE_ID },
      to: { type: "viber_service_msg", number: TO_NUMBER },
      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 },
      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-viber-sms.js

Try it out

When you run the code it will attempt to send a message via Viber. This will fail and then a message will be sent via SMS to the destination number.

Improve this page