Build Node.js Express Two-Way SMS Messaging with Vonage - code-examples -

This guide provides a step-by-step walkthrough for building a Node.js application using the Express framework to handle two-way SMS communication via the Vonage Messages API. You will learn how to send outbound SMS messages and receive inbound messages through a webhook, enabling interactive conversations.

We'll cover setting up your development environment, configuring Vonage, writing the core application logic for sending and receiving messages, handling security considerations, and providing guidance on deployment and testing.

Goal: Create a functional Node.js Express application capable of:

  1. Sending SMS messages programmatically using the Vonage Messages API.
  2. Receiving incoming SMS messages sent to a Vonage virtual number via a webhook.
  3. Logging message details for basic tracking.

Technologies Used:

  • Node.js: A JavaScript runtime environment for server-side development.
  • Express: A minimal and flexible Node.js web application framework used to create the webhook server.
  • Vonage Messages API: A unified API for sending and receiving messages across various channels (we'll focus on SMS).
  • Vonage Node.js SDK (@vonage/server-sdk): Simplifies interaction with Vonage APIs.
  • ngrok: A tool to expose local development servers to the internet for webhook testing.
  • dotenv: A module to load environment variables from a .env file.

System Architecture:

+-------------+       +-----------------+       +-------------------+       +-----------------+       +-------------+
| User's      | ----> | Vonage Platform | ----> | Your Ngrok Tunnel | ----> | Node.js/Express | ----> | Log Output  |
| Mobile Phone|       | (Inbound SMS)   |       | (Webhook Forward) |       | App (Webhook)   |       | (Console)   |
+-------------+       +-----------------+       +-------------------+       +-----------------+       +-------------+
      ^                                                                             |
      |                                                                             | (Trigger Send)
      +-----------------------------------------------------------------------------+
      |                                +-----------------+       +-----------------+
      | (Outbound SMS via API Call)    | Vonage Platform | ----> | User's          |
      +--------------------------------| (Send SMS)      |       | Mobile Phone    |
                                       +-----------------+       +-----------------+

Prerequisites:

  • Node.js and npm (or yarn): Installed on your system. Download from nodejs.org.
  • Vonage API Account: Sign up at Vonage API Dashboard. You'll get free credit for testing.
  • Vonage Virtual Number: Purchase an SMS-capable number from the Vonage Dashboard (Numbers > Buy Numbers).
  • ngrok: Installed. Download from ngrok.com. While basic HTTP tunneling often works without an account, authentication (ngrok authtoken <your-token&gt;) is recommended and required for features like stable subdomains or longer tunnel durations. A free account is sufficient for basic authentication.
  • Basic Terminal/Command Line Knowledge: Familiarity with navigating directories and running commands.

1. Setting Up the Project

Let's initialize our Node.js project and install the necessary dependencies.

  1. Create Project Directory: Open your terminal or command prompt and create a new directory for your project, then navigate into it.

    mkdir vonage-two-way-sms
cd vonage-two-way-sms

  2. Initialize npm: Create a package.json file to manage project dependencies and metadata.

    npm init -y

    (The -y flag accepts the default settings)

  3. Install Dependencies: We need the Vonage SDK, the Express framework, and dotenv for managing environment variables.

    npm install @vonage/server-sdk express dotenv

  4. Set Up Project Structure: Create the following basic file structure within your vonage-two-way-sms directory:

    vonage-two-way-sms/
├── node_modules/
├── .env             # For storing environment variables (API keys, etc.)
├── .gitignore       # To prevent committing sensitive files
├── package.json
├── package-lock.json
└── server.js        # Our main Express application file

  5. Configure .gitignore: Create a file named .gitignore and add the following lines to prevent committing sensitive information and unnecessary files:

    # Dependencies
node_modules/

# Environment variables
.env

# Vonage Private Key (if stored locally)
private.key

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*

  6. Set Up Environment Variables (.env): Create a file named .env in the project root. We will populate this with credentials obtained from Vonage in a later step. Add the following placeholder keys for now:

    # Vonage Credentials (Obtain from Vonage Dashboard)
VONAGE_API_KEY=YOUR_VONAGE_API_KEY
VONAGE_API_SECRET=YOUR_VONAGE_API_SECRET
VONAGE_APPLICATION_ID=YOUR_VONAGE_APPLICATION_ID
VONAGE_PRIVATE_KEY_PATH=./private.key # Or the absolute path to your key
VONAGE_NUMBER=YOUR_VONAGE_VIRTUAL_NUMBER

# Application Settings
APP_PORT=3000 # Port the Express server will listen on
    • Purpose: Using a .env file keeps sensitive credentials out of your source code, making your application more secure and configurable across different environments. dotenv loads these variables into process.env when the application starts.

2. Integrating with Vonage

Now, let's configure your Vonage account and application to enable SMS communication and obtain the necessary credentials.

  1. Retrieve API Key and Secret:

    • Navigate to your Vonage API Dashboard.
    • Your API Key and API Secret are displayed at the top.
    • Copy these values and paste them into your .env file for VONAGE_API_KEY and VONAGE_API_SECRET.

  2. Configure Vonage Account for Messages API:

    • Crucially, ensure your account is set to use the Messages API for SMS by default, as webhook formats differ between the older SMS API and the newer Messages API.
    • In the Vonage Dashboard, go to your Account Settings (usually accessible via your username/profile icon in the top right -> Settings).
    • Find the ""API settings"" section, then navigate to ""SMS settings"".
    • Under ""Default SMS Setting"", select ""Messages API"".
    • Click ""Save changes"".

  3. Create a Vonage Application: The Messages API uses an Application ID and a private key for authentication when sending messages and routing webhooks.

    • In the Vonage Dashboard, navigate to ""Applications"" -> ""Create a new application"".
    • Enter an Application name (e.g., ""Node Two-Way SMS App"").
    • Click ""Generate public and private key"". This will automatically download the private key file (e.g., private.key). Save this file securely (Vonage does not store it). Move it into your project directory (or note its path).
    • Enable the ""Messages"" capability.
    • You'll see fields for Inbound URL and Status URL. We'll fill these in the next step using ngrok. Leave them blank for now or use temporary placeholders like http://example.com/webhooks/inbound and http://example.com/webhooks/status.
    • Click ""Generate new application"".
    • You'll be redirected to the application's page. Copy the Application ID.
    • Paste the Application ID into your .env file for VONAGE_APPLICATION_ID.
    • Update VONAGE_PRIVATE_KEY_PATH in your .env file to the correct path where you saved the downloaded private.key file (e.g., ./private.key if it's in the root).

  4. Link Your Vonage Number: Associate your purchased Vonage virtual number with the application you just created.

    • Navigate to ""Numbers"" -> ""Your numbers"".
    • Find the virtual number you want to use for two-way SMS.
    • Click the ""Manage"" or ""Edit"" button (often a pencil icon) next to the number.
    • In the ""Forwarding"" or ""Application"" section, select ""Application"".
    • From the dropdown, choose the application you created (e.g., ""Node Two-Way SMS App"").
    • Click ""Save"".
    • Copy your full Vonage virtual number (including country code, e.g., 14155550100) and paste it into your .env file for VONAGE_NUMBER.

  5. Start ngrok and Configure Webhook URLs: To receive inbound messages during local development, we need ngrok to expose our local server to the internet.

    • Open a new terminal window (keep the first one for running the app later).

    • Run ngrok, telling it to forward to the port your Express app will listen on (defined as APP_PORT in .env, default is 3000).

      ngrok http 3000

    • ngrok will display forwarding URLs (e.g., https://<random-string&gt;.ngrok.io). Copy the https URL. This is your public base URL.

    • Go back to your Vonage Application settings in the dashboard (""Applications"" -> Click your app name).

    • Edit the Messages capability URLs:

      • Inbound URL: Paste your ngrok https URL and append /webhooks/inbound. Example: https://<random-string&gt;.ngrok.io/webhooks/inbound
      • Status URL: Paste your ngrok https URL and append /webhooks/status. Example: https://<random-string&gt;.ngrok.io/webhooks/status

    • Click ""Save changes"".

    • Why ngrok? Webhooks require a publicly accessible URL. Vonage's servers need to be able to send HTTP requests to your application when an SMS is received. ngrok creates a secure tunnel from a public URL to your local machine running on localhost:3000.

3. Implementing Core Functionality (Sending & Receiving SMS)

Now, let's write the Node.js/Express code in server.js.

// server.js

// Load environment variables from .env file
require('dotenv').config();

const express = require('express');
const { Vonage } = require('@vonage/server-sdk');
const { FileSystemCredentials } = require('@vonage/server-sdk/dist/auth/fileSystemCredentials'); // For private key auth

const app = express();

// Middleware to parse incoming request bodies (applied globally)
app.use(express.json()); // For parsing application/json
app.use(express.urlencoded({ extended: true })); // For parsing application/x-www-form-urlencoded

// --- Vonage Setup ---
// Input validation for essential environment variables
const requiredEnvVars = [
    'VONAGE_API_KEY', // Needed for potential future use or reference
    'VONAGE_API_SECRET', // Needed for webhook signing (if implemented) or reference
    'VONAGE_APPLICATION_ID',
    'VONAGE_PRIVATE_KEY_PATH',
    'VONAGE_NUMBER',
    'APP_PORT'
];

for (const envVar of requiredEnvVars) {
    if (!process.env[envVar]) {
        console.error(`Error: Missing required environment variable ${envVar}`);
        process.exit(1); // Exit if essential config is missing
    }
}

const VONAGE_APPLICATION_ID = process.env.VONAGE_APPLICATION_ID;
const VONAGE_PRIVATE_KEY_PATH = process.env.VONAGE_PRIVATE_KEY_PATH;
const VONAGE_NUMBER = process.env.VONAGE_NUMBER; // Your Vonage virtual number
const APP_PORT = process.env.APP_PORT;

// Initialize Vonage using Application ID and Private Key for Messages API
// We use FileSystemCredentials for better handling of the private key path
const vonageCredentials = new FileSystemCredentials(
    VONAGE_APPLICATION_ID,
    VONAGE_PRIVATE_KEY_PATH
);

const vonage = new Vonage(vonageCredentials);

// --- Webhook Endpoints ---

// Inbound Message Webhook (POST /webhooks/inbound)
app.post('/webhooks/inbound', (req, res) =&gt; {
    console.log('--- Inbound Message Received ---');
    console.log('Request Body:', JSON.stringify(req.body, null, 2)); // Log the entire payload prettily

    const { from, text, timestamp } = req.body;

    if (from && from.type === 'sms' && text) { // Check type is SMS
        console.log(`Message from ${from.number}: "${text}" at ${timestamp}`);
        // --- Add your logic here ---
        // Example: Respond back to the sender
        /*
        sendSms(from.number, `You said: "${text}"`)
            .then(resp =&gt; console.log('Reply sent successfully:', resp))
            .catch(err =&gt; console.error('Error sending reply:', err));
        */
    } else {
        console.warn('Received non-SMS or incomplete inbound message data.');
    }

    // CRITICAL: Always respond with a 200 OK status to Vonage
    // Otherwise, Vonage will retry sending the webhook, potentially causing duplicate processing.
    res.status(200).end();
});

// Message Status Webhook (POST /webhooks/status)
app.post('/webhooks/status', (req, res) =&gt; {
    console.log('--- Message Status Received ---');
    console.log('Request Body:', JSON.stringify(req.body, null, 2)); // Log the status payload

    const { message_uuid, status, timestamp, usage } = req.body;
    if (message_uuid && status) {
        console.log(`Message ${message_uuid} status: ${status} at ${timestamp}`);
        if (usage && usage.price) {
            console.log(`Cost: ${usage.price} ${usage.currency}`);
        }
    }

    // Respond with 200 OK
    res.status(200).end();
});

// --- Function to Send SMS ---
async function sendSms(toNumber, messageText) {
    console.log(`Attempting to send SMS to ${toNumber}...`);
    try {
        // Vonage API expects E.164 format (e.g., 14155550100)
        const resp = await vonage.messages.send({
            message_type: "text",
            text: messageText,
            to: toNumber,        // Destination number (ensure E.164 format)
            from: VONAGE_NUMBER, // Your Vonage virtual number
            channel: "sms"
        });
        console.log(`Message sent successfully. UUID: ${resp.message_uuid}`);
        return resp; // Contains message_uuid
    } catch (err) {
        console.error("Error sending SMS:", err);
        // More detailed error logging
        if (err.response && err.response.data) {
            console.error("Vonage API Error Details:", JSON.stringify(err.response.data, null, 2));
        }
        throw err; // Re-throw the error for upstream handling if needed
    }
}

// --- Example Route to Trigger Sending SMS (for testing) ---
// You might replace this with your actual application logic
app.post('/send-test-sms', async (req, res) =&gt; { // express.json() is applied globally now
    const { to, text } = req.body;

    if (!to || !text) {
        return res.status(400).json({ error: "Missing 'to' or 'text' in request body" });
    }

    // Basic validation: Check if 'to' contains only digits (and optionally a leading '+').
    // IMPORTANT: Vonage requires E.164 format (e.g., '14155550100').
    // This validation is basic; consider a more robust library for production.
    if (!/^\+?\d+$/.test(to)) {
         return res.status(400).json({ error: "Invalid 'to' number format. Use E.164 format (e.g., 14155550100)." });
    }

    try {
        const result = await sendSms(to, text);
        res.status(200).json({ success: true, message_uuid: result.message_uuid });
    } catch (error) {
        // The error is already logged in sendSms function
        res.status(500).json({ success: false, error: 'Failed to send SMS' });
    }
});


// --- Start Server ---
app.listen(APP_PORT, () =&gt; {
    console.log(`Server listening on http://localhost:${APP_PORT}`);
    console.log(`ngrok should be forwarding to this port.`);
    console.log(`Inbound Webhook URL: /webhooks/inbound`);
    console.log(`Status Webhook URL:  /webhooks/status`);
    console.log('Make sure your Vonage Application URLs match your ngrok address.');
});

// Optional: Add a simple root route for testing if the server is up
app.get('/', (req, res) =&gt; {
    res.send('Vonage Two-Way SMS Server is running!');
});

Code Explanation:

  1. Dependencies & Setup: Imports express, dotenv, and the Vonage SDK. Loads environment variables using dotenv.config(). Initializes Express.
  2. Middleware: express.json() and express.urlencoded() are applied globally using app.use() to parse JSON and URL-encoded data from incoming request bodies.
  3. Vonage Initialization:
    • Performs basic validation to ensure critical environment variables are set.
    • Uses FileSystemCredentials to correctly load the private key from the path specified in .env. This is the required authentication method for the Messages API.
    • Initializes the Vonage client with these credentials.
  4. Inbound Webhook (/webhooks/inbound):
    • Defines a POST route handler matching the Inbound URL configured in Vonage.
    • Logs the entire request body received from Vonage.
    • Extracts key information like the sender's number (from.number) and the message content (text). Added a check for from.type === 'sms'.
    • Includes a placeholder comment where you would add your application logic. An example async call to sendSms is commented out.
    • Crucially sends a 200 OK response using res.status(200).end().
  5. Status Webhook (/webhooks/status):
    • Defines a POST route handler matching the Status URL configured in Vonage.
    • Logs the status update payload.
    • Also sends a 200 OK response.
  6. sendSms Function:
    • An async function to encapsulate sending an SMS.
    • Uses vonage.messages.send() with required parameters. Includes comment reminding about E.164 format for to number.
    • Includes try...catch for robust error handling.
    • Returns the response from Vonage on success.
  7. Test Send Route (/send-test-sms):
    • A simple POST endpoint for testing sendSms. Removed the redundant express.json() middleware from the route definition.
    • Expects a JSON body with to and text.
    • Performs basic validation for to number format, adding guidance about E.164 in the code comment and error message.
    • Calls sendSms and returns a JSON response.
  8. Server Start:
    • Starts the Express server, listening on APP_PORT.
    • Logs helpful messages.

4. Implementing Error Handling and Logging

The provided server.js includes basic error handling and logging:

  • Environment Variable Check: Exits gracefully if essential configuration is missing.
  • sendSms Error Handling: Uses try...catch around the Vonage API call. Logs detailed errors from the Vonage SDK if available.
  • Webhook Logging: Logs the full request body for both inbound and status webhooks using console.log and JSON.stringify. This is invaluable for debugging.
  • Webhook Response: Explicitly sends 200 OK to prevent Vonage retries, which is a form of error prevention.

Further Enhancements (Beyond Scope of Basic Guide):

  • Structured Logging: Use libraries like winston or pino for leveled logging (info, warn, error), formatting, and potentially sending logs to external services.
  • Centralized Error Handling Middleware: Implement Express error-handling middleware to catch unhandled errors consistently.
  • Webhook Signature Verification: For enhanced security (Section 5), verify that incoming webhook requests genuinely originate from Vonage.
  • Retry Logic (Application Level): If your application needs to retry sending an SMS after a temporary failure (e.g., network issue calling Vonage), implement logic with exponential backoff.

5. Adding Security Features

Security is paramount, especially when handling user communication and API credentials.

  • Environment Variables: As implemented, using .env and .gitignore prevents hardcoding credentials in source control. Ensure the .env file has restrictive permissions on your server.
  • Input Validation:
    • The /send-test-sms route includes basic validation for to and text, with guidance on the required E.164 format.
    • For inbound messages (/webhooks/inbound), you should validate/sanitize the text content if you plan to store or process it further, to prevent injection attacks (e.g., XSS if displayed on a web interface, SQL injection if stored in a DB). Libraries like express-validator can help.
  • Webhook Security (Signature Verification - Recommended):
    • Vonage webhooks can be signed using your API Secret or a shared secret you define. Verifying this signature ensures the request is authentic and hasn't been tampered with.
    • This typically involves:
      1. Retrieving the signature from the request headers (e.g., X-Vonage-Signature).
      2. Generating a signature on your end using the request body and your secret key (often involving HMAC-SHA1 or SHA256).
      3. Comparing the calculated signature with the one provided in the header.
    • It is highly recommended to implement this for production applications. Consult the official Vonage developer documentation for detailed instructions and check if the @vonage/server-sdk provides helper functions for signature validation.
  • Rate Limiting: Protect your webhook endpoints and any API endpoints (like /send-test-sms) from abuse by implementing rate limiting using middleware like express-rate-limit.
  • HTTPS: Always use HTTPS for your webhook URLs (ngrok provides this). When deploying, ensure your server uses TLS/SSL certificates (e.g., via LetsEncrypt).

6. Troubleshooting and Caveats

  • Webhook Not Firing:
    • Check ngrok: Is it running? Is the forwarding URL correct? Check the ngrok web interface (http://127.0.0.1:4040 by default) for request logs.
    • Check Vonage Application URLs: Do the Inbound and Status URLs in the Vonage dashboard exactly match your current ngrok https URL, including the /webhooks/inbound or /webhooks/status paths?
    • Check Server Logs: Is your Node.js server running? Are there errors on startup?
    • Check Number Linking: Is the Vonage number correctly linked to the correct Vonage Application?
    • Check API Settings: Ensure ""Messages API"" is selected as the default SMS setting in your Vonage account API settings.
  • Error Sending SMS:
    • Check Credentials: Are VONAGE_APPLICATION_ID and VONAGE_PRIVATE_KEY_PATH correct in .env? Does the private key file exist at that path and have read permissions?
    • Check toNumber Format: Ensure it's in E.164 format (e.g., 14155550100). The /send-test-sms route provides basic validation, but the sendSms function itself relies on the correct format being passed.
    • Check VONAGE_NUMBER: Is this a valid Vonage number linked to your Application ID?
    • Check Server Logs: Look for detailed errors logged by the sendSms function's catch block.
    • Vonage Account Funds: Ensure you have sufficient credit.
  • Duplicate Inbound Messages:
    • This usually happens if your /webhooks/inbound endpoint doesn't respond with 200 OK quickly enough (or at all). Vonage retries. Ensure res.status(200).end() is called promptly at the end of the handler.
  • Private Key Errors: Ensure the path in VONAGE_PRIVATE_KEY_PATH is correct relative to where you run node server.js, or use an absolute path. Ensure the file is not corrupted.
  • ngrok Limitations: Free ngrok tunnels have temporary URLs that change each time you restart ngrok. You'll need to update the Vonage application webhook URLs frequently during development. Authenticated free accounts or paid ngrok plans offer stable subdomains.
  • Messages vs. SMS API: Remember this guide uses the Messages API. If you accidentally configure Vonage or your code for the older SMS API, authentication methods (Key/Secret vs. AppID/Key) and webhook payload formats will differ, causing errors.

7. Deployment and CI/CD (Conceptual)

Deploying this application involves moving beyond ngrok and running it on a server.

  1. Choose a Hosting Provider: Options include Heroku, AWS (EC2, Lambda), Google Cloud (App Engine, Cloud Run), DigitalOcean, etc.
  2. Environment Variables: Configure your production environment variables (VONAGE_API_KEY, VONAGE_API_SECRET, VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH, VONAGE_NUMBER, APP_PORT, NODE_ENV=production) securely using your hosting provider's mechanism (e.g., Heroku Config Vars, AWS Parameter Store). Do not commit .env to production. Securely transfer or store the private.key file on the server and update VONAGE_PRIVATE_KEY_PATH accordingly.
  3. Update Webhook URLs: Once deployed to a public URL (e.g., https://your-app-domain.com), update the Inbound and Status URLs in your Vonage Application settings to point to your production endpoints (e.g., https://your-app-domain.com/webhooks/inbound).
  4. Process Management: Use a process manager like pm2 to keep your Node.js application running reliably, manage logs, and handle restarts. 
    npm install pm2 -g
pm2 start server.js --name vonage-sms-app
pm2 startup # To ensure it restarts on server reboot
pm2 save
  5. HTTPS: Configure your production server (e.g., using Nginx as a reverse proxy) to handle HTTPS/TLS termination.
  6. CI/CD Pipeline (Advanced): Set up a pipeline (e.g., using GitHub Actions, GitLab CI, Jenkins) to automatically:
    • Lint and test your code on commit/push.
    • Build your application (if necessary).
    • Deploy to your hosting provider.
    • Run health checks.

8. Verification and Testing

  1. Start the Application:

    • Ensure ngrok http 3000 is running in one terminal.
    • Ensure your .env file is populated with correct credentials and paths.
    • Run the server in another terminal: 
      node server.js
    • Verify the server starts without errors and logs the listening port and webhook URLs.

  2. Test Inbound SMS (Receiving):

    • Using your physical mobile phone, send an SMS message to your Vonage virtual number (VONAGE_NUMBER).
    • Check Server Logs: Look for the ""--- Inbound Message Received ---"" log entry in the terminal where server.js is running. Verify the logged from number and text match what you sent.
    • Check ngrok Interface: Open http://127.0.0.1:4040 in your browser. You should see a POST /webhooks/inbound request with a 200 OK response. Inspect the request details.

  3. Test Outbound SMS (Sending):

    • Use a tool like curl or Postman to send a POST request to your test endpoint. Replace <your-ngrok-url&gt; with your actual ngrok HTTPS URL and <your-phone-number&gt; with your destination phone number in E.164 format (e.g., 14155550100).
    curl -X POST \
  <your-ngrok-url&gt;/send-test-sms \
  -H 'Content-Type: application/json' \
  -d '{
        ""to"": ""<your-phone-number-in-E.164-format&gt;"",
        ""text"": ""Hello from Vonage Node App!""
      }'
    • Check Server Logs: Look for the ""Attempting to send SMS..."" and ""Message sent successfully..."" logs. Note any errors.
    • Check Your Mobile Phone: You should receive the SMS message shortly.
    • Check Status Webhook: Look for the ""--- Message Status Received ---"" log entry in the server console. The status should eventually transition (e.g., submitted -> delivered or failed). Check the ngrok interface for POST /webhooks/status requests.

  4. Verification Checklist:

    • Project setup complete (npm install, .env, .gitignore).
    • Vonage account configured (Messages API default).
    • Vonage Application created, keys obtained, number linked.
    • .env file correctly populated with all credentials and paths.
    • ngrok is running and forwarding to the correct port.
    • Vonage Application webhook URLs match the current ngrok URL.
    • node server.js runs without errors.
    • Inbound SMS successfully logged by the server.
    • Inbound webhook receives 200 OK response (check ngrok interface).
    • Outbound SMS triggered via /send-test-sms successfully sends.
    • Outbound SMS is received on the target phone.
    • Status webhook events are logged by the server.

This guide provides a solid foundation for building two-way SMS applications with Node.js, Express, and Vonage. Remember to enhance security (especially webhook signature verification) and implement more robust error handling and logging for production deployments.