Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Programmable SMS Quickstart for Node.js

With just a few lines of code, your Node.js application can send and receive text messages with Twilio Programmable SMS.

This Node.js SMS Quickstart will teach you how to do this using our Communications REST API and the Twilio Node.js helper library.

In this Quickstart, you will learn how to:

  1. Sign up for Twilio and get your first SMS-enabled Twilio phone number
  2. Set up your development environment to send and receive messages
  3. Send your first SMS
  4. Receive inbound text messages
  5. Reply to incoming messages with an SMS

Prefer to get started by watching a video? Check out our Node.js SMS Quickstart video on Youtube.

Show me how it's done!

If you already have a Twilio account and an SMS-enabled Twilio phone number, you’re all set here! Feel free to jump to the next step.

Before you can send an SMS from Node.js, you'll need to sign up for a Twilio account or sign into your existing account and purchase an SMS-capable phone number. If you are signing up for a Twilio account for the first time, you'll need to:

  • Validate a phone number you own to prove you're a non-spamming human
  • Follow a project creation wizard in the Twilio console - you can choose any of the templates, but the "just exploring" template should do nicely

After you get to the main Console, navigate to the Buy a Number page. Check the "SMS" box and click "Search" to find an SMS-capable phone number you can use in your code.

Buy a SMS-Capable Twilio Phone Number

You’ll then see a list of available phone numbers and their capabilities. Click the "Buy" button to add one of them to your account.

Click to Buy an SMS capable number

Now that you have a Twilio account and a programmable phone number, you can start writing some code! To make things even easier, we'll install Twilio's official helper for Node.js next.

Super - let's write some JavaScript!

If you’ve gone through one of our other Node.js Quickstarts already and have Node.js and the Twilio Node.js helper library installed, you can skip this step and get straight to sending your first text message.

To send your first SMS, you’ll need to have Node.js and the Twilio Node.js module installed.

Install Node.js

You can check if you already have Node.js installed on your machine by opening up a terminal and running the following command:

node --version

You should see something like:

$ node --version
v8.9.1

If you don't have Node.js installed, head over to nodejs.org and download the appropriate installer for your system. Once you've installed Node, return to your terminal and run the command above once again. If you don't see the installed node version, you may need to relaunch your terminal.

Install the Twilio Node.js Module

Install the Twilio Node helper library using npm:

npm install twilio

This will install the twilio module so that Node.js scripts in the current directory can use it. If your project has a package.json, consider adding the --save flag to the command above to ensure you always install the same version of Twilio from npm.

All set! Let's send a text message.

Send an Outbound SMS Message with Node.js

Now that we have Node.js and the Twilio Node.js library installed, we can send an outbound text message from the Twilio phone number we just purchased with a single API request. Create and open a new file called send_sms.js and type or paste in this code sample.

Loading Code Sample...
      
      
      
      
      This code creates a new instance of the Message resource and sends an HTTP POST to the Messages resource URI.

      Send an SMS Using Twilio with Node.js

      This code creates a new instance of the Message resource and sends an HTTP POST to the Messages resource URI.

      You’ll need to edit this file a little more before your message will send:

      Replace the placeholder credential values

      Swap the placeholder values for accountSid and authToken with your personal Twilio credentials. Go to https://www.twilio.com/console and log in. On this page, you’ll find your unique Account SID and Auth Token, which you’ll need any time you send messages through the Twilio client like this.

      auth token reveal

      Open send_sms.js and replace the values for accountSid and authToken with your unique values.

      Please note: it's okay to hardcode your credentials when getting started, but you should use environment variables to keep them secret before deploying to production. Check out how to set environment variables for more information.

      Replace the "from" phone number

      Remember that SMS-enabled phone number you bought just a few minutes ago? Go ahead and replace the existing from number with that one, making sure to use E.164 formatting:

      [+][country code][phone number including area code]

      Replace the "to" phone number

      Replace the to phone number with your mobile phone number. This can be any phone number that can receive text messages, but it’s a good idea to test with your own phone so you can see the magic happen! As above, you should use E.164 formatting for this value.

      Save your changes and run this script from your terminal:

      node send_sms.js
      

      That's it! In a few moments, you should receive an SMS from your Twilio number on your phone.

      Are your customers in the U.S. or Canada? You can also send them MMS messages by adding just one line of code. Check out this guide to sending MMS to see how it's done.

      If you are on a Twilio Trial account, your outgoing SMS messages are limited to phone numbers that you have verified with Twilio. Phone numbers can be verified via your Twilio Console's Verified Caller IDs.

      I sent the message! How do I receive them?

      Receive and Reply to Inbound SMS Messages with Express

      When your Twilio number receives an incoming message, Twilio will send an HTTP request to a server you control. This callback mechanism is known as a webhook. When Twilio sends your application a request, it expects a response in the TwiML XML format telling it how to respond to the message. Let's see how we would build this in Node.js using Express.

      On the command line in your current directory, run the following command:

      npm install express
      

      Create a file called server.js and use the following code to create a server that can handle incoming messages.

      Loading Code Sample...
          
          
          
          
          When your Twilio phone number receives an incoming message, Twilio will send an HTTP request to your server. This code shows how your server can reply with a text message using the Twilio helper library.

          Respond to an incoming text message

          When your Twilio phone number receives an incoming message, Twilio will send an HTTP request to your server. This code shows how your server can reply with a text message using the Twilio helper library.

          Run this server with the following command:

          node server.js
          

          You'll see that the server starts up on port 1337.

          Before Twilio can send your application webhook requests, you'll need to make your application accessible over the Internet. While you can do that in any number of ways, we recommend a tool called ngrok, which gives your local development server a publicly accessible URL. We'll show you how to set that up next so your app can receive messages.

          Let's set up my app to receive messages.

          Allow Twilio to Talk to Your Node.js Application with ngrok

          We’ve just built a small Express application to receive incoming messages. Before it will work, we need to make sure that Twilio can reach your application. Most Twilio services use webhooks to communicate with your application. When Twilio receives an SMS, for example, it makes an HTTP request to a URL in your application seeking instructions on how to handle the message.

          When you’re working on your Express application in your development environment, your app is only reachable by other programs on your computer, so Twilio won’t be able to talk to it. We need to solve this problem by making your application accessible over the Internet.

          While there are a lot of ways to do this, like deploying your application to Heroku or AWS, you'll probably want a less laborious way to test your Twilio application. For a lightweight way to make your app available on the Internet, we recommend a tool called ngrok. Ngrok listens for incoming HTTP requests to a public URL it reserves for your application, and forwards those requests on to your local development server.

          How ngrok helps Twilio reach your local server

          If you haven't already, install ngrok. Make sure it's the ngrok version that’s appropriate for your operating system and take care that the `ngrok` command is on your system path. If you're working on a Mac or Linux, you're all set. If you're on Windows, follow our guide on how to install and configure ngrok on Windows. For more info on ngrok, including some great tips and tricks, check out this in-depth blog post.

          The following command would use ngrok to expose port 1337 to the public Internet. Replace 1337 with whatever port number you used in your Express app, and type the following command on the command line:

          ngrok http 1337
          

          ngrok terminal output

          Now we have a new external URL.

          Configure Your Webhook URL

          For Twilio to know where to look, you need to configure your Twilio phone number to call your webhook URL whenever a new message comes in.

          1. Log into Twilio.com and go to the Console's Numbers page.
          2. Click on your SMS-enabled phone number.
          3. Find the Messaging section. The default “CONFIGURE WITH” is what you’ll need: "Webhooks/TwiML".
          4. In the “A MESSAGE COMES IN” section, select "Webhook" and paste in your URL: in this quickstart step above, it would be: https://aaf29606.ngrok.io/sms - be sure to add `/sms` at the end.

          configure-phone-number

          Save your changes - you’re ready!

          Test Your Application

          Make sure you are running on the command line (in separate tabs) both 'node server.js' and your 'ngrok' command. If you restarted ngrok, you will have to update your webhook in the console to use the right url.

          With both of those servers running, we’re ready for the fun part - testing our new Express application!

          Send an SMS from your mobile phone to your Twilio phone number that's configured with this webhook. You should see an HTTP request in your ngrok console. Your Express app will process the text message, and you’ll get your response back as an SMS.

          It worked! All done - what's next?

          Where to next?

          Now that you know the basics of sending and receiving SMS and MMS text messages with Node.js, you might want to check out these resources.

          Happy hacking!

          Need some help?

          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

          Loading Code Sample...