Send an SMS message During a Phone Call with Java and Spark

Tags

Java

Products

Messaging

Time to read: 6 minutes

August 21, 2018

Written by

Kat King

Twilion

Reviewed by

Paul Kamp

Twilion

Stephanie Marchante

Twilion

Jonatas deOliveira

Contributor

Send an SMS message During a Phone Call with Java and Spark

In this tutorial, we’ll show you how to use Twilio's Programmable Voice and SMS to send a text message during a phone call.

We’ll write a small Java web application that:

Accepts an incoming phone call
Says something to your caller
Sends the caller a text message

The code we’re going to write uses the Spark web framework and Twilio’s Java helper library.

Ready? Let’s get started!

If you have a Twilio account and Twilio phone number with SMS and Voice capabilities, you’re all set here! Feel free to jump to the next step.

Before you can receive phone calls and send messages, you’ll need to sign up for a Twilio account and buy a Twilio phone number.

If you don’t currently own a Twilio phone number with both SMS and Voice capabilities, you’ll need to buy one. After navigating to the Buy a Number page, check the "SMS" and "Voice" boxes and click "Search":

You’ll then see a list of available phone numbers that meet your criteria. Find a number that suits you and click "Buy" to add it to your account.

Create a Spark app that accepts incoming calls

We’ll be building a small Spark web application that accepts incoming calls and sends the caller an SMS. Let’s start by building out the code that receives the call and says something to the caller.

Editor: this is a migrated tutorial. You can clone the code from https://github.com/TwilioDevEd/send-sms-during-inbound-calls-java/

Set up your development environment

To download the code used in this tutorial and run it, you can clone this GitHub repository and follow the setup instructions in the README.

If you’d prefer to build this app from scratch, start by creating a new directory named twilio_calls. Within that directory, create a pom.xml to define the project dependencies.

Handle incoming calls

Now that our environment is all set up we need to create a directory structure to hold our app. First, create this directory tree src/main/java/com/twilio/app/ and inside of it a file named App.java. We’ll create a small /answer route that can say something to someone who calls our new Twilio phone number.

package com.twilio.app;

import static spark.Spark.*;

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.Message;
import com.twilio.twiml.voice.Say;
import com.twilio.twiml.VoiceResponse;
import com.twilio.exception.ApiException;
import com.twilio.type.PhoneNumber;


public class App {
    public static void main(String[] args) {
        port(8080);
        post("/answer", (req, res) -> {
            // get the urlencoded form parameters
            String caller = req.queryParams("From");
            String twilioNumber = req.queryParams("To");

            sendSms(caller, twilioNumber);
            VoiceResponse twiml = new VoiceResponse.Builder()
                .say(new Say.Builder("Thanks for calling! We just sent you a text with a clue.")
                      .voice(Say.Voice.ALICE)
                      .build())
                .build();

            return twiml.toXml();
        });
    }

    public static void sendSms(String toNumber, String fromNumber) {
        String accountSid = System.getenv("ACCOUNT_SID");
        String authToken = System.getenv("AUTH_TOKEN");

        try {
            Twilio.init(accountSid, authToken);
            Message
                .creator(new PhoneNumber(toNumber),
                         new PhoneNumber(fromNumber),
                        "There's always money in the banana stand.")
                .create();
        } catch (ApiException e) {
            if (e.getCode() == 21614) {
                System.out.println("Uh oh, looks like this caller can't receive SMS messages.");
            }
        }
    }
}

In the code sample above, we leveraged Twilio's Java library to create a com.twilio.twiml.VoiceResponse that says some text to a caller. We can ignore the blurred lines for now: those will come into play later when we're ready to create an SMS from this call.

You can now run this Spark application:

mvn compile exec:java -Dexec.mainClass=com.twilio.app.App

You can check that your app is running by going to http://127.0.0.1:4567/answer in your browser. You should see some text that says "Thanks for calling! We just sent you a text with a clue."

But how do we tell Twilio to use this response when someone calls our Twilio phone number?

Allow Twilio to talk to your Spark application

For Twilio to know how to handle incoming calls to your phone number, you’ll need to give this local application a publicly accessible URL. We recommend using ngrok.

If you’re new to ngrok, you can find more information here about how it works and why we recommend using it when developing locally.

Once you’ve downloaded ngrok, make sure your Spark application is running. Then, open a new terminal window and start ngrok:

./ngrok http 4567 -host-header="localhost:4567"

If your local server is running on a port other than 4567, replace '4567' in the command above with the correct port number.

You should see some output that tells you your public ngrok URL.

Now you can configure your Twilio phone number to use this app when someone calls you:

Log in to twilio.com and go to the console's Phone Numbers page.
Click on your voice-enabled phone number.
Find the "Voice & Fax" section. Make sure the "Accept Incoming" selection is set to "Voice Calls." The default "Configure With" selection is what you’ll need: "Webhooks/TwiML...".
In the "A Call Comes In" section, select "Webhook" and paste in the URL you want to use, appending your /answer route:

Save your changes. Now you're ready to test it out!

Call the Twilio phone number that you just configured. You should hear your message and the call will end.

Great! Next, we'll get some information about the caller so we can send them a follow-up SMS.

Get your caller's phone number from Twilio's request

When someone dials your Twilio phone number, Twilio sends some extra data in its request to your application.

While Twilio sends a lot of data with each inbound call, the two pieces of information we need are:

Our incoming caller’s phone number: From
Our Twilio phone number: To

While we won’t be using them in this app, many values are included in Twilio’s request to our application. Check out the full list of parameters Twilio sends with every request.

To send our caller an SMS, we'll need to access that To and From information. Update your /answer route to include the following:

 String caller = req.queryParams("From");
 String twilioNumber = req.queryParams("To");

The code should now look like this:

package com.twilio.app;

import static spark.Spark.*;

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.Message;
import com.twilio.twiml.voice.Say;
import com.twilio.twiml.VoiceResponse;
import com.twilio.exception.ApiException;
import com.twilio.type.PhoneNumber;


public class App {
    public static void main(String[] args) {
        port(8080);
        post("/answer", (req, res) -> {
            // get the urlencoded form parameters
            String caller = req.queryParams("From");
            String twilioNumber = req.queryParams("To");

            sendSms(caller, twilioNumber);
            VoiceResponse twiml = new VoiceResponse.Builder()
                .say(new Say.Builder("Thanks for calling! We just sent you a text with a clue.")
                      .voice(Say.Voice.ALICE)
                      .build())
                .build();

            return twiml.toXml();
        });
    }

    public static void sendSms(String toNumber, String fromNumber) {
        String accountSid = System.getenv("ACCOUNT_SID");
        String authToken = System.getenv("AUTH_TOKEN");

        try {
            Twilio.init(accountSid, authToken);
            Message
                .creator(new PhoneNumber(toNumber),
                         new PhoneNumber(fromNumber),
                        "There's always money in the banana stand.")
                .create();
        } catch (ApiException e) {
            if (e.getCode() == 21614) {
                System.out.println("Uh oh, looks like this caller can't receive SMS messages.");
            }
        }
    }
}

Getting the Twilio phone number from the request allows us to connect this app to multiple phone numbers and route our responses appropriately.

Now that we have our Twilio phone number and our caller’s phone number, we can send our SMS reply!

Send an SMS to your caller from your Twilio number

Now we can create a new method in our application that sends our caller a message with Twilio's SMS API. To do that, we'll first need to include our Twilio authentication information.

Manage your secret keys with environment variables

To send an SMS via the API, you’ll need to include the Account SID and authentication token for your Twilio account.

However, we don’t want to expose this information to anyone, so we’ll store that information in a .env file instead of hard-coding it.

Create a file named .env at the root of your project. It should contain two lines:

export ACCOUNT_SID=ACXXXXXXXXXXXXXXXXXX
export AUTH_TOKEN=your_auth_token

You can find your unique Account SID and Auth Token in your Twilio console. Replace the placeholder values with your SID and token and save the file.

To enable this variables inside the app, remember to load the file into your environment before running the app:

source .env

Now your application can safely access your Twilio authentication information.

Programmatically send an SMS from the call

Now it’s time to send a message to our caller!

Update your App.java file to include a sendSms method that sends the caller a clue:

package com.twilio.app;

import static spark.Spark.*;

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.Message;
import com.twilio.twiml.voice.Say;
import com.twilio.twiml.VoiceResponse;
import com.twilio.exception.ApiException;
import com.twilio.type.PhoneNumber;


public class App {
    public static void main(String[] args) {
        port(8080);
        post("/answer", (req, res) -> {
            // get the urlencoded form parameters
            String caller = req.queryParams("From");
            String twilioNumber = req.queryParams("To");

            sendSms(caller, twilioNumber);
            VoiceResponse twiml = new VoiceResponse.Builder()
                .say(new Say.Builder("Thanks for calling! We just sent you a text with a clue.")
                      .voice(Say.Voice.ALICE)
                      .build())
                .build();

            return twiml.toXml();
        });
    }

    public static void sendSms(String toNumber, String fromNumber) {
        String accountSid = System.getenv("ACCOUNT_SID");
        String authToken = System.getenv("AUTH_TOKEN");

        try {
            Twilio.init(accountSid, authToken);
            Message
                .creator(new PhoneNumber(toNumber),
                         new PhoneNumber(fromNumber),
                        "There's always money in the banana stand.")
                .create();
        } catch (ApiException e) {
            if (e.getCode() == 21614) {
                System.out.println("Uh oh, looks like this caller can't receive SMS messages.");
            }
        }
    }
}

Now, update the /answer route to execute this new sendSms function. We’ll pass along the From and To values found in the initial request.

package com.twilio.app;

import static spark.Spark.*;

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.Message;
import com.twilio.twiml.voice.Say;
import com.twilio.twiml.VoiceResponse;
import com.twilio.exception.ApiException;
import com.twilio.type.PhoneNumber;


public class App {
    public static void main(String[] args) {
        port(8080);
        post("/answer", (req, res) -> {
            // get the urlencoded form parameters
            String caller = req.queryParams("From");
            String twilioNumber = req.queryParams("To");

            sendSms(caller, twilioNumber);
            VoiceResponse twiml = new VoiceResponse.Builder()
                .say(new Say.Builder("Thanks for calling! We just sent you a text with a clue.")
                      .voice(Say.Voice.ALICE)
                      .build())
                .build();

            return twiml.toXml();
        });
    }

    public static void sendSms(String toNumber, String fromNumber) {
        String accountSid = System.getenv("ACCOUNT_SID");
        String authToken = System.getenv("AUTH_TOKEN");

        try {
            Twilio.init(accountSid, authToken);
            Message
                .creator(new PhoneNumber(toNumber),
                         new PhoneNumber(fromNumber),
                        "There's always money in the banana stand.")
                .create();
        } catch (ApiException e) {
            if (e.getCode() == 21614) {
                System.out.println("Uh oh, looks like this caller can't receive SMS messages.");
            }
        }
    }
}

Save your file and double check that ngrok is still running. If you restart ngrok, you’ll need to reset your webhook for your Twilio phone number via the console.

Try calling your Twilio phone number again. Now you should hear your updated message and get an SMS with a super-secret password!

If you send messages while in trial mode, you must first verify your 'To' phone number so Twilio knows you own it. If you attempt to send an SMS from your trial account to an unverified number, the API will return Error 21219.

You can verify your phone number by adding it to your Verified Caller IDs in the console.

What about landlines?

This app doesn’t know if our caller is dialing from a phone that accepts SMS or not. What happens if someone calls from a landline and can’t receive an SMS?

Twilio handles an attempt to send an SMS to a landline differently depending on the location of the SMS recipient.

If you try to send an SMS to a landline in the US, Canada, or the UK, Twilio will not check if the number is a landline first. Instead, it will attempt to send the message to the carrier for delivery. Some carriers (especially those in the UK) will convert the SMS to a text-to-speech message via a voice call.

To learn how to see if your SMS was delivered to your recipient, see our tutorial on tracking the delivery status of your message.

If your recipient is located elsewhere, the Twilio REST API will throw Error 21614, and the message will not appear in your logs.

To better handle exceptions on a call from someone who used a landline to dial our Twilio number, we’ll build some error handling right into our app:

package com.twilio.app;

import static spark.Spark.*;

import com.twilio.Twilio;
import com.twilio.rest.api.v2010.account.Message;
import com.twilio.twiml.voice.Say;
import com.twilio.twiml.VoiceResponse;
import com.twilio.exception.ApiException;
import com.twilio.type.PhoneNumber;


public class App {
    public static void main(String[] args) {
        port(8080);
        post("/answer", (req, res) -> {
            // get the urlencoded form parameters
            String caller = req.queryParams("From");
            String twilioNumber = req.queryParams("To");

            sendSms(caller, twilioNumber);
            VoiceResponse twiml = new VoiceResponse.Builder()
                .say(new Say.Builder("Thanks for calling! We just sent you a text with a clue.")
                      .voice(Say.Voice.ALICE)
                      .build())
                .build();

            return twiml.toXml();
        });
    }

    public static void sendSms(String toNumber, String fromNumber) {
        String accountSid = System.getenv("ACCOUNT_SID");
        String authToken = System.getenv("AUTH_TOKEN");

        try {
            Twilio.init(accountSid, authToken);
            Message
                .creator(new PhoneNumber(toNumber),
                         new PhoneNumber(fromNumber),
                        "There's always money in the banana stand.")
                .create();
        } catch (ApiException e) {
            if (e.getCode() == 21614) {
                System.out.println("Uh oh, looks like this caller can't receive SMS messages.");
            }
        }
    }
}

With this exception handling, our caller will still hear our voice response but won’t receive the text.

In our sample app, we’re printing the error message and gracefully exiting. If you were running this app in production, you could handle this exception any way you like: you might track these occurrences in your application logs or spin up a response voice call to your caller.

What's next?

Now that you know how to leverage both Twilio’s Voice and SMS APIs to send a text message when someone calls your Twilio number, you may want to go deeper: