Receive SMS Messages Using Ruby

Overview

This guide shows how to receive SMS text messages on a Plivo phone number. Typical use cases for receiving messages include opt-in and opt-out messages and other customer interactions.

You can start receiving SMS messages either by using our PHLO visual workflow builder or our APIs. Follow the instructions in one of the tabs below.

You can create and deploy a PHLO to receive an SMS text message with a few clicks on the PHLO canvas.

How it works

Receive SMS

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To receive incoming messages, you must have a Plivo phone number that supports SMS. You can rent numbers from the Numbers page of the Plivo console, or by using the Numbers API.

Create the PHLO

To create a PHLO, visit the PHLO page of the Plivo console. If this is your first PHLO, the PHLO page will be empty.

Create a PHLO to receive SMS

  • Click Create New PHLO.

  • In the Choose your use case pop-up, click Build my own. The PHLO canvas will appear with the Start node.

    Note: The Start node is the starting point of any PHLO. It lets you trigger a PHLO to start upon one of three actions: incoming SMS message, incoming call, or API request.

  • From the list of components on the left-hand side, drag and drop the HTTP Request component onto the canvas. When a component is placed on the canvas it becomes a node.

  • Draw a line to connect the Start node’s Incoming Message trigger state to the HTTP Request node.

  • In the Configuration pane at the right of the canvas, configure the HTTP Request node. Specify the address of your web server and specify that from, to, and text fields should be passed along with the request.

  • Once you’ve configured the node, click Validate to save the configuration.

  • After you complete the configuration, give the PHLO a name by clicking in the upper left, then click Save.

Assign the PHLO to a Plivo number

Once you’ve created and configured your PHLO, assign it to a Plivo number.

  • On the Numbers page of the console, under Your Numbers, click the phone number you want to use for the PHLO.

  • In the Number Configuration box, select PHLO from the Application Type drop-down.

  • From the PHLO Name drop-down, select the PHLO you want to use with the number, then click Update Number.

Assign PHLO to a Plivo Number

Test

You can now send a message to your Plivo phone number to see how the inbound message is handled.

For more information about creating a PHLO application, see the PHLO Getting Started guide. For information on components and their variables, see the PHLO Components Library.

Here’s how to use Plivo APIs to receive SMS text messages.

How it works

Receive SMS

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To receive incoming messages, you must have a Plivo phone number that supports SMS; you can rent numbers from the Numbers page of the Plivo console or by using the Numbers API. If this is your first time using Plivo APIs, follow our instructions to set up a Ruby development environment.

Create a Rails controller to receive messages

Change to the project directory and run this command to create a Rails controller for inbound messages.

$ rails generate controller Plivo sms

This command generates a controller named plivo_controller in the app/controllers/ directory and a respective view in app/views/plivo. We can delete the view as we don’t need it.

$ rm app/views/plivo/sms.html.erb

Edit the app/controllers/plivo_controller.rb file and paste this code into the PlivoController class.

1
2
3
4
5
6
7
8
9
10
11
12

include Plivo
include Plivo::XML
include Plivo::Exceptions

class PlivoController < ApplicationController
 def inbound
    from_number = params[:From]
      to_number = params[:To]
      text = params[:Text]
      puts "Message received - From: #{from_number}, To: #{to_number}, Text: #{text}"
    end
end

Create a Plivo application to receive messages

Associate the controller you created with Plivo by creating a Plivo application. Visiting Messaging > Applications and click Add New Application. You can also use Plivo’s Application API.

Give your application a name — we called ours Receive SMS. Enter the server URL you want to use (for example https://<yourdomain>.com/receive_sms/) in the Message URL field and set the method to POST. Click Create Application to save your application.

Create Application

Assign a Plivo number to your application

Navigate to the Numbers page and select the phone number you want to use for this application.

From the Application Type drop-down, select XML Application.

From the Plivo Application drop-down, select Receive SMS (the name we gave the application).

Click Update Number to save.

Assign Phone Number to Receive SMS App

Test

Send a text message to the Plivo number you specified using any phone.