Receive an inbound SMS

When someone sends a text message to your Twilio number, Twilio can invoke a webhook that you've created to determine what reply to send back using TwiML. This page provides examples of Functions that can serve as the webhook for your Twilio number.

A Function that responds to webhook requests will receive details about the incoming message as properties on the event parameter. These include the incoming number (event.From), the recipient number (event.To), and the text body of the message (event.Body). Other relevant data include the number of media sent and geographic metadata about the phone numbers involved. You can view a full list of potential values at Twilio Request to your Webhook URL.

After a Function is invoked by an inbound SMS, you can take any number of actions. The following examples can serve as a starting point for your implementation.

Create and host a Function

In order to run any of the following examples, you will first need to create a Function into which you can paste the example code. You can create a Function using the Twilio Console or the Serverless Toolkit as explained below:

ConsoleServerless Toolkit

If you prefer a UI-driven approach, creating and deploying a Function can be done entirely using the Twilio Console and the following steps:

Log in to the Twilio Console and navigate to the Functions tab. If you need an account, you can sign up for a free Twilio account here!
Functions are contained within Services. Create a Service by clicking the Create Service button and providing a name such as test-function.
Once you've been redirected to the new Service, click the Add + button and select Add Function from the dropdown.
This will create a new Protected Function for you with the option to rename it. The name of the file will be path it is accessed from.
Copy any one of the example code snippets from this page that you want to experiment with, and paste the code into your newly created Function. You can quickly switch examples by using the dropdown menu of the code rail.
Click Save to save your Function's contents.
Click Deploy All to build and deploy the Function. After a short delay, your Function will be accessible from: https://<service-name>-<random-characters>-<optional-domain-suffix>.twil.io/<function-path>
For example: test-function-3548.twil.io/hello-world.

The Serverless Toolkit enables you with local development, project deployment, and other functionality via the Twilio CLI. To get up and running with these examples using Serverless Toolkit, follow this process:

From the CLI, run twilio serverless:init <your-service-name> --empty to bootstrap your local environment.
Navigate into your new project directory using cd <your-service-name>
In the /functions directory, create a new JavaScript file that is named respective to the purpose of the Function. For example, sms-reply.protected.js for a Protected Function intended to handle incoming SMS.
Populate the file using the code example of your choice and save. Note A Function can only export a single handler. You will want to create separate files if you want to run and/or deploy multiple examples at once.

Once your Function(s) code is written and saved, you can test it either by running it locally (and optionally tunneling requests to it via a tool like ngrok), or by deploying the Function and executing against the deployed url(s).

Run your Function in local development

Run twilio serverless:start from your CLI to start the project locally. The Function(s) in your project will be accessible from http://localhost:3000/sms-reply

If you want to test a Function as a Twilio webhook, run: twilio phone-numbers:update <your Twilio phone number> --sms-url "http://localhost:3000/sms-reply"
This will automatically generate an ngrok tunnel from Twilio to your locally running Function, so you can start sending texts to it. You can apply the same process but with the voice-url flag instead if you want to test with Twilio Voice.
If your code does not connect to Twilio Voice/Messages as a webhook, you can start your dev server and start an ngrok tunnel in the same command with the ngrok flag. For example: twilio serverless:start --ngrok=""

Deploy your Function

To deploy your Function and have access to live url(s), run twilio serverless:deploy from your CLI. This will deploy your Function(s) to Twilio under a development environment by default, where they can be accessed from:

https://<service-name>-<random-characters>-dev.twil.io/<function-path>

For example: https://incoming-sms-examples-3421-dev.twil.io/sms-reply

Your Function is now ready to be invoked by HTTP requests, set as the webhook of a Twilio phone number, invoked by a Twilio Studio Run Function Widget, and more!

Set a Function as a webhook

In order for your Function to react to incoming SMS and/or voice calls, it must be set as a webhook for your Twilio number. There are a variety of methods to set a Function as a webhook, as detailed below:

Twilio ConsoleTwilio CLITwilio server-side SDKs

You can use the Twilio Console UI as a straightforward way of connecting your Function as a webhook:

Log in to the Twilio Console's Phone Numbers page.
Click on the phone number you'd like to have connected to your Function.
If you want the Function to respond to incoming SMS, find the A Message Comes In option under Messaging. If you want the Function to respond to Voice, find the A Call Comes In option under Voice & Fax.
Select Function from the A Message Comes In or A Call Comes In dropdown.
Select the Service that you are using, then the Environment (this will default to ui unless you have created custom domains ), and finally Function Path of your Function from the respective dropdown menus.

Alternatively, you could select Webhook instead of Function, and directly paste in the full URL of the Function.

Click the Save button.

You can also use the Twilio CLI to assign the Function as the webhook of you phone number. You will need a few prerequisites:

Twilio CLI installed and executable from your terminal.
Either the E.164 formatted value of your Twilio phone number (+1234567890), or its SID (PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX).
The full URL of your Function (https://test-1337.twil.io/my-test-function)

Once you have the CLI installed and the necessary information, run the following to connect the Function to respond to incoming SMS:

1twilio phone-numbers:update +1234567890 \
2  --sms-url https://test-1337.twil.io/my-test-function

If you prefer to have the Function respond to incoming calls instead, run:

1twilio phone-numbers:update +1234567890 \
2  --voice-url https://test-1337.twil.io/my-test-function

You may also use the SID of your Twilio phone number instead of the E.164 formatted phone number:

1twilio phone-numbers:update PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
2  --sms-url https://test-1337.twil.io/my-test-function

You can also use any of the available Twilio SDKs to assign the Function as the webhook of you phone number. You will need a few prerequisites:

A local development environment for your language of choice and the associated Twilio SDK installed.
The SID (PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) of your Twilio phone number.
The full URL of your Function (https://test-1337.twil.io/my-test-function).

In JavaScript for example, you could execute the following code to assign the SMS webhook of your Twilio phone number. The same logic would apply for assigning to a voice webhook, except that the modified property instead would be voiceUrl:

1// Download the SDK from https://www.twilio.com/docs/node/install
2// Find your Account SID and Auth Token at twilio.com/console
3// and set the environment variables. See https://twil.io/secure
4const accountSid = process.env.TWILIO_ACCOUNT_SID;
5const authToken = process.env.TWILIO_AUTH_TOKEN;
6const client = require('twilio')(accountSid, authToken);
7
8client
9  .incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
10  .update({ smsUrl: 'https://test-1337.twil.io/my-test-function' })
11  .then((phoneNumber) => console.log(phoneNumber.smsUrl));
12

Respond with a static message

For the simplest example, you can reply to the incoming SMS with a hard-coded message. To do so, you can create a new MessagingResponse and declare the intended message contents. Once your message content has been set, you can return the generated TwiML by passing it to the callback function as shown and signaling a successful end to the Function.

Respond to an inbound SMS

1exports.handler = (context, event, callback) => {
2  // Create a new messaging response object
3  const twiml = new Twilio.twiml.MessagingResponse();
4  // Use any of the Node.js SDK methods, such as `message`, to compose a response
5  twiml.message('Hello, World!');
6  // Return the TwiML as the second argument to `callback`
7  // This will render the response as XML in reply to the webhook request
8  return callback(null, twiml);
9};

Respond dynamically to an inbound SMS

Because you can access the incoming message text from event.Body, you can tailor the response based on that text. For example, you could respond with "Hello, there!" to an incoming message that includes the text "hello". You could say "Goodbye" to any message including "bye". You can have a fallback response if neither of those conditions is met.

Dynamically respond to an inbound SMS

1exports.handler = (context, event, callback) => {
2  // Create a new messaging response object
3  const twiml = new Twilio.twiml.MessagingResponse();
4
5  // Access the incoming text content from `event.Body`
6  const incomingMessage = event.Body.toLowerCase();
7
8  // Use any of the Node.js SDK methods, such as `message`, to compose a response
9  if (incomingMessage.includes('hello')) {
10    twiml.message('Hello, there!');
11  } else if (incomingMessage.includes('bye')) {
12    twiml.message('Goodbye!');
13  } else {
14    twiml.message('Not sure what you meant! Please say hello or bye!');
15  }
16
17  // Return the TwiML as the second argument to `callback`
18  // This will render the response as XML in reply to the webhook request
19  return callback(null, twiml);
20};

Forward an inbound SMS

Another example uses additional event properties to forward SMS messages from your Twilio phone number to your personal phone. Use this approach when you don't want to share your personal number, such as when selling an item online or interacting with unknown contacts.

This Function will accept an incoming SMS and generate a TwiML response that contains the number that sent the message followed by the contents of the SMS. Because the to property of the TwiML is set to your personal phone number, this message will be forwarded to you instead of creating a response directly to the sender.

For a detailed example, see SMS Forwarding and Responding Using Twilio and JavaScript.

Forward an inbound SMS

1const MY_NUMBER = "+15095550100";
2
3exports.handler = (context, event, callback) => {
4  // Create a new messaging response object
5  const twiml = new Twilio.twiml.MessagingResponse();
6  // Use any of the Node.js SDK methods, such as `message`, to compose a response
7  // Access incoming text information like the from number and contents off of `event`
8  // Note: providing a `to` parameter like so will forward this text instead of responding to the sender
9  twiml.message({ to: MY_NUMBER }, `${event.From}: ${event.Body}`);
10  // Return the TwiML as the second argument to `callback`
11  // This will render the response as XML in reply to the webhook request
12  return callback(null, twiml);
13};

(information)

Info

This example hard-codes your personal number in the Function for convenience. For a more secure approach, consider setting MY_NUMBER as an Environment Variable in the Functions UI instead. It could then be referenced in your code as context.MY_NUMBER, as shown in the following example.

Forward an inbound SMS

Using an environment variable to store sensitive data

1exports.handler = (context, event, callback) => {
2  // Create a new messaging response object
3  const twiml = new Twilio.twiml.MessagingResponse();
4  // Use any of the Node.js SDK methods, such as `message`, to compose a response
5  // Access incoming text information like the from number and contents off of `event`
6  // Access environment variables and other runtime data from `context`
7  twiml.message({ to: context.MY_NUMBER }, `${event.From}: ${event.Body}`);
8  // Return the TwiML as the second argument to `callback`
9  // This will render the response as XML in reply to the webhook request
10  return callback(null, twiml);
11};

Respond with MMS media from an HTTP request

All the Function examples so far are fully synchronous and only rely on data from the inbound message. Functions can also request data from other services by using modern async/await syntax.

For example, a Function can fetch an online resource (such as an image of a Shiba Inu) and reply with an MMS that includes the image.

Respond to an inbound SMS with an asynchronously generated MMS

1const axios = require('axios');
2
3// Note that the function must be `async` to enable the use of the `await` keyword
4exports.handler = async (context, event, callback) => {
5  // Create a new messaging response object
6  const twiml = new Twilio.twiml.MessagingResponse();
7
8  // You can do anything in a Function, including making async requests for data
9  const response = await axios
10    .get('https://dog.ceo/api/breed/shiba/images/random')
11    .catch((error) => {
12      // Be sure to handle any async errors, and return them in a callback to end
13      // Function execution if it makes sense for your application logic
14      console.error(error);
15      return callback(error);
16    });
17
18  const imageUrl = response.data.message;
19
20  // Use any of the Node.js SDK methods, such as `message`, to compose a response
21  // In this case we're also including the doge image as a media attachment
22  // Note: access incoming text details such as the from number on `event`
23  twiml
24    .message(`Hello, ${event.From}! Enjoy this doge!`)
25    .media(imageUrl);
26
27  // Return the TwiML as the second argument to `callback`
28  // This will render the response as XML in reply to the webhook request
29  return callback(null, twiml);
30};

(warning)

Warning

To use an npm module such as axios to create HTTP requests, you will need to add it as a Dependency.