Send SMS Alerts Using Ruby

    Overview

    This guide shows how to send an SMS alert or notification to any phone number.

    You can send SMS alerts and notifications either by using our PHLO visual workflow builder or our APIs. Follow the instructions in one of the tabs below.

    You can create a PHLO to send SMS alerts with a few clicks on the PHLO canvas and trigger it with a few lines of code.

    How it works

    Prerequisites

    To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. If this is your first time triggering a PHLO with Ruby, follow our instructions to set up a Ruby development environment.

    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.

    • 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 Send Message 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 API Request trigger state to the Send Message node.

    • In the Configuration pane at the right of the canvas, configure the Send Message node with a sender ID in the From field. Enter the destination number you wish to send a message to in the To field. Put your message in the Text field.

      Note: You can define a static payload by specifying values when you create the PHLO, or define a dynamic payload by passing values through Liquid templating parameters when you trigger the PHLO from your application.
    • 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.

    Your complete PHLO should look like this.

    SMS Notification

    Your PHLO is now ready to test.

    Trigger the PHLO

    You integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload — the set of parameters you pass to the PHLO. You can define a static payload by specifying values when you create the PHLO, or define a dynamic payload by passing values through parameters when you trigger the PHLO from your application.

    In either case, you need your Auth ID and Auth Token, which you can get from the overview page of the Plivo console.

    AUTHID

    «««< HEAD Once you have created and setup your Ruby dev envrironment, you can go to your Plivo Consolse and copy the PHLO_ID. You can integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload. ======= You also need the PHLO ID, which you can copy from the PHLO list page.

    9d50777aa7d4b98b5f1453ecf822b0cb81852605

    PHLO List

    With a static payload

    When you configure values when creating the PHLO, they act as a static payload.

    With Static Payload

    Code

    Create a file called trigger_phlo.rb and paste into it this code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    
    require 'rubygems'
    require 'plivo'
    
    include Plivo
    
    AUTH_ID = '<auth_id>'
    AUTH_TOKEN = '<auth_token>'
    
    client = Phlo.new(AUTH_ID, AUTH_TOKEN)
    
    # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
    # then initialize client as:
    # client = Phlo.new
    
    begin
      phlo = client.phlo.get('<phlo_id>')
      response = phlo.run()
      puts response
    rescue PlivoRESTError => e
      puts 'Exception: ' + e.message
    end
    

    Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console.

    With a dynamic payload

    To use dynamic values for the parameters, use Liquid templating parameters when you create the PHLO and pass the values from your code when you trigger it.

    With Dynamic Payload

    Code

    Create a file called trigger_phlo.rb and paste into it this code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    
    require 'rubygems'
    require 'plivo'
    
    include Plivo
    
    AUTH_ID = '<auth_id>'
    AUTH_TOKEN = '<auth_token>'
    
    client = Phlo.new(AUTH_ID, AUTH_TOKEN)
    
    # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
    # then initialize client as:
    # client = Phlo.new
    
    begin
      phlo = client.phlo.get('<phlo_id>')
      #parameters set in PHLO - params
      params = {
         From: '<sender_id>',
         To: '<destination_number>',
      }
      response = phlo.run(params)
      puts response
    rescue PlivoRESTError => e
      puts 'Exception: ' + e.message
    end
    

    Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phlo_id placeholder with your PHLO ID from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

    Test

    Save the file and run it.

    ruby trigger_phlo.rb
    
    Note: If you’re using a Plivo Trial account, you can make calls only to phone numbers that have been verified with Plivo. You can verify (sandbox) a number by going to the console’s Phone Numbers > Sandbox Numbers page.

    Here’s how to use Plivo APIs to send SMS alerts.

    Prerequisites

    To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. To send messages to the United States and Canada, 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 the send SMS application

    Create a file called send_sms.rb and paste into it this code.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    require "plivo"
    include Plivo
    
    api = RestClient.new("<auth_id>","<auth_token>")
    response = api.messages.create(
        src:"<sender_id>",
        dst:"<destination_number>", 
        text:"Your package TWLO-484-555 was delivered to 742 Evergreen Terrace, Springfield",
      )
      puts response
    

    Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234). In countries other than the US and Canada you can use a sender ID for the message source. You must have a Plivo phone number to send messages to the US or Canada; you can buy a Plivo number from Phone Numbers > Buy Numbers on the Plivo console or via the Numbers API.

    Note: We recommend that you store your credentials in the auth_id and auth_token environment variables to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use ENV to store environment variables and fetch them when initializing the client.

    Test

    Save the file and run it. Your application triggers an outbound SMS API request, and Plivo delivers your message to the destination number you specified.

    ruby send_sms.rb
    
    Note: If you’re using a Plivo Trial account, you can make calls only to phone numbers that have been verified with Plivo. You can verify (sandbox) a number by going to the console’s Phone Numbers > Sandbox Numbers page.