Twilio SMS

In this document, you’ll learn about the Twilio SMS Plugin, what it does, and how to use it in Medusa.

Overview

Twilio’s SMS API can be used to send users SMS messages instantly. It has a lot of additional features such as Whatsapp messaging and conversations.

By integrating Twilio SMS into Medusa, you’ll have easy access to Twilio’s SMS API to send SMS messages to your users and customers. You can use it to send Order confirmations, verification codes, reset password messages, and more.

Note

This plugin only gives you access to the Twilio SMS API but does not implement sending messages at any given point. You’ll have to add this yourself where you need it. You can look at the example later in this tutorial to check how you can send an SMS for a new order.

Prerequisites

Before going further with this guide make sure you have a Medusa backend set up. You can follow the Quickstart guide if you don’t.

You also must have a Twilio account created so if you don’t already please go ahead and create one.

Retrieve Credentials

For the Twilio SMS plugin, you need three credentials from your Twilio account: Account SID, Auth Token, and a Twilio phone number to send from. You can find these three from your Twilio Console’s homepage.

Install Plugin

In the directory of your Medusa backend, run the following command to install Twilio SMS plugin:

npm
Yarn
pnpm

npm install medusa-plugin-twilio-sms

yarn add medusa-plugin-twilio-sms

pnpm add medusa-plugin-twilio-sms

Then, you’ll need to add your credentials in .env:

TWILIO_SMS_ACCOUNT_SID=<YOUR_ACCOUNT_SID>
TWILIO_SMS_AUTH_TOKEN=<YOUR_AUTH_TOKEN>
TWILIO_SMS_FROM_NUMBER=<YOUR_TWILIO_NUMBER>

Make sure to replace <YOUR_ACCOUNT_SID>, <YOUR_AUTH_TOKEN>, and <YOUR_TWILIO_NUMBER> with the credentials you obtained from your Twilio Console.

Finally, add the plugin and its options in the medusa-config.js file to the plugins array:

medusa-config.js

const plugins = [
  // ...
  {
    resolve: `medusa-plugin-twilio-sms`,
    options: {
      account_sid: process.env.TWILIO_SMS_ACCOUNT_SID,
      auth_token: process.env.TWILIO_SMS_AUTH_TOKEN,
      from_number: process.env.TWILIO_SMS_FROM_NUMBER,
    },
  },
]

Example Usage of the Plugin

This plugin adds the service twilioSmsService to your Medusa backend. To send SMS using it, all you have to do is resolve it in your file as explained in the dependency injection documentation.

In this example, you’ll create a subscriber that listens to the order.placed event and sends an SMS to the customer to confirm their order.

Tip

For this example to work, you'll need to have an event bus module installed and configured, which should be available by default.

Create the file src/subscriber/sms.ts in your Medusa backend with the following content:

src/subscriber/sms.ts

import { 
  type SubscriberConfig, 
  type SubscriberArgs,
  OrderService,
} from "@medusajs/medusa"

export default async function handleOrderPlaced({ 
  data, eventName, container, pluginOptions, 
}: SubscriberArgs<Record<string, string>>) {
  const twilioSmsService = container.resolve("twilioSmsService")
  const orderService: OrderService = container.resolve(
    "orderService"
  )

  const order = await orderService.retrieve(data.id, {
    relations: ["shipping_address"],
  })

  if (order.shipping_address.phone) {
    twilioSmsService.sendSms({
      to: order.shipping_address.phone,
      body: "We have received your order #" + data.id,
    })
  }
}

export const config: SubscriberConfig = {
  event: OrderService.Events.PLACED,
  context: {
    subscriberId: "order-placed-handler",
  },
}

In the handler function, you resolve the twilioSmsService and orderService using container of type MedusaContainer. You then retrieve the order's details, and send an SMS to the customer based on the phone number in their shipping address.

The sendSms method of the Twilio service accepts an object of parameters. These parameters are based on Twilio’s SMS APIs. You can check their API documentation for more fields that you can add.

Warning

If you’re on a Twilio trial make sure that the phone number you entered on checkout is a verified Twilio number on your console.

Overview​

Prerequisites​

Retrieve Credentials​

Install Plugin​

Example Usage of the Plugin​

See Also​

Overview

Prerequisites

Retrieve Credentials

Install Plugin

Example Usage of the Plugin

See Also