Join us in San Francisco on the 29/30th of October for two days of developer workshops and technical talks

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
NEXMO_APPLICATION_ID The ID of the application that you created.
FROM_NUMBER The phone number you are sending the MMS from (US Short Code only).
TO_NUMBER The phone number you are sending the MMS to.

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-mms-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": "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

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-mms.js:

Copy to Clipboard
nexmo.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": 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 from the Dispatch API"
      }
    }
  },
  (err, data) => { console.log(data.dispatch_uuid); }
])

View full source

Run your code

Save this file to your machine and run it:

node send-failover-sms-mms.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.