Skip to navigation

Send an MMS with failover

In this example you will send an MMS 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.

NOTE: MMS only supports US Short Codes.

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 The phone number you are sending the MMS from. (US Short Code, 10DLC number, or SMS Enabled Toll Free Number)
TO_NUMBER Replace with the number you are sending to. E.g. 447700900001

NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example 447700900000.

  • cURL
  • Node.js

    • 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-mms-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": "mms", "number": '$FROM_NUMBER' },
        "to": { "type": "mms", "number": '$TO_NUMBER' },
        "message": {
          "content": {
            "type": "img",
            "image": { "url": "$IMG_URL" }
          }
        },
        "failover":{
          "expiry_time": 600,
          "condition_status": "delivered"
        }
      },
      {
        "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-mms-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-mms-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: "mms", number: FROM_NUMBER },
      to: { type: "mms", number: TO_NUMBER },
      message: {
        content: {
          type: "image",
          image: { url: IMG_URL }
        }
      },
      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-mms-sms.js

    Try it out

    When you run the code it will attempt to send an MMS. If this fails, for example because the recipient is on T-Mobile, then a message will be sent via SMS to the destination number.

    Improve this page