Get Started with Java using Spark Framework

Send Your First Outbound SMS/MMS

To send your first outbound sms, you can create and deploy a PHLO in just a few clicks using the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for sms you send/receive. Building with PHLO is free.

Prerequisites

1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
2. Set Up Your Java Spark Dev Environment: To set up your dev environment in Java, please refer to the instructions available in the Set Up Your Java Spark Dev Environment section.
3. Buy a Plivo Number(optional): You must have an SMS-enabled Plivo phone number if you wish to receive incoming sms. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.

Create the PHLO

Create a PHLO to send your first outbound SMS/MMS by following these instructions:

• SMS
• MMS

• On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
• Click Create New PHLO to build a new PHLO.
• In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
  Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the API Request trigger state.
• From the list of components on the left-hand side, drag and drop the Send Message component onto the canvas. This will add an Send Message node onto the canvas.
• Connect the Start node with the Send Message node, using the API Request trigger state.
• Configure the Send Message node with the source/from number using the From field. Enter the destination number you wish to send message in the To field.
• If you’d like to send MMS then Configure the Media URLs node with the Media files you’d like to send using the Media URLs field.
• Once you have configured the node, click Validate to save the configurations.
• After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready. You can trigger the PHLO and test it out. For more information, refer to the following section.

Set Up Your Java Spark Dev Environment

You must set up and install Java(Java 1.8 or higher) and Plivo’s Java SDK to send your first SMS. Here’s how.

Install Java

Install Plivo Java Package using IntelliJ Idea

• Create a new project in IntelliJ Idea

• Choose a dependency management and Java SE SDK for the new project

• Install the Plivo Java package by adding the dependency in pom.xml

<dependency>
    <groupId>com.plivo</groupId>
    <artifactId>plivo-java</artifactId>
    <version>5.2.0</version>
</dependency>

Trigger the PHLO

Once you have created and setup your Java dev envrironment, you can go to your Plivo Consolse and copy the PHLO_ID. Integrate a PHLO into your application workflow by making an API request to trigger the PHLO with the required payload.

With Static Payload

You can choose to either configure the mandatory params required for a PHLO while creating the PHLO itself or, you can pass the params as payload while triggering the PHLO from your app.

Code

Now, create a Java class in the project called TriggerPhlo and paste the following code.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import com.plivo.api.Plivo;
import com.plivo.api.PlivoClient;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.phlo.Phlo;
import java.io.IOException;

public class Example
{
    private static final String authId = "auth_id";
    private static final String authToken = "auth_token";
    private static PlivoClient client = new PlivoClient(authId, authToken);
    public static void main(String[] args) throws IOException, PlivoRestException
    {
        String phloId = "Your PHLO ID";
        Plivo.init(authId, authToken);
        Phlo phlo = Phlo.getter(phloId).client(client).get();
        PhloUpdateResponse response = Phlo.updater(phloId).payload().run();
    }
}

With Dynamic Payload

To use dynamic values for the parameters, follow the below steps.

• Select the StartNode - under API request, fill the Payload key as From & To and keep the values empty, then click validate & save.

• Use the liquid templating params while creating the PHLO and pass the values while triggering the PHLO.

Code

Now, create a Java class in the project called TriggerPhlo and paste the following code.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import com.plivo.api.Plivo;
import com.plivo.api.PlivoClient;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.phlo.Phlo;
import java.io.IOException;

public class Example
{
    private static final String authId = "auth_id";
    private static final String authToken = "auth_token";
    private static PlivoClient client = new PlivoClient(authId, authToken);
    public static void main(String[] args) throws IOException, PlivoRestException
    {
        String phloId = "Your PHLO ID";
        Plivo.init(authId, authToken);
        Phlo phlo = Phlo.getter(phloId).client(client).get();
        Map<String, Object> payload = new HashMap<>();
        payload.put("From", "+14157778888");
        payload.put("To", "+14157778889");
        PhloUpdateResponse response = Phlo.updater(phloId).payload(payload).run();
    }
}

Get your Auth_ID and Auth_token from your dashboard

You can find the PHLO_ID on the PHLO Listing page.

Test and Validate

Save the file and run it from Intellij.

Receive Your First Inbound SMS/MMS

Create and deploy a PHLO to receive your first inbound SMS and forward to your web server with a few clicks on the PHLO canvas. PHLO also lets you visually construct your entire use-case. With PHLO, only pay for calls you make/receive. Building with PHLO is free.

Prerequisites

1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
2. Buy a Plivo number: You must have a sms-enabled Plivo phone number to receive incoming calls. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
3. PHLO Application: When you receive a call on a Plivo sms-enabled number, you can control the call flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the sms.

Create the PHLO

You can create a PHLO by referring to the below instructions to receive your first incoming call:

• SMS
• MMS

• On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
• Click Create New PHLO to build a new PHLO.
• In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
  Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the Incoming Message trigger state.
• From the list of components on the left-hand side, drag and drop the HTTP Request component onto the canvas. This will add a HTTP Request node onto the canvas.
• Connect the Start node with the HTTP Request node, using the Incoming Message trigger state.
• Configure the HTTP Request node to send the details to your Web Server.
• Once you have configured the node, click Validate to save the configurations.
• After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

Assign the PHLO to a Plivo Number for Incoming SMS/MMS

Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

To assign a PHLO to a number:

1. Log in to your Plivo Console
2. On the Product Navigation bar, click Phone Numbers.
3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
4. In the Number Configuration window, select PHLO from the Application Type list.
5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

Test and Validate

You can now send a message to your Plivo phone number to receive an incoming sms and see how the inbound sms is handled using PHLO.

For more information about creating a PHLO app, see the PHLO User Guide.
For information on components and their variables, see the PHLO Components Library.

Forward an Incoming SMS/MMS

To forward an incoming sms, you can create and deploy a PHLO with a few clicks on the PHLO canvas.

Prerequisites

1. Create a Plivo account (if you don’t have one already): Sign up with your work email address and complete the phone verification step using your mobile number.
2. Buy a Plivo number: You must have a sms-enabled Plivo phone number to receive incoming sms. Purchase numbers from the Numbers section of your Plivo Console. It is also possible to purchase numbers using the Numbers API.
3. PHLO Application: When you receive a sms on a Plivo sms-enabled number, you can control the flow by associating a PHLO application to that Plivo phone number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the sms.

Create the PHLO

You can create a PHLO by referring to the below instructions to forward an incoming SMS/MMS:

• SMS
• MMS

• On the side navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any exist. If this is your first PHLO, then the PHLO page will be empty.
• Click Create New PHLO to build a new PHLO.
• In the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node.
  Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the start node; Incoming SMS, Incoming Call, and API Request. For this PHLO, we will use the Incoming Message trigger state.
• From the list of components on the left-hand side, drag and drop the Send Message component onto the canvas. This will add a Send Message node onto the canvas.
• Connect the Start node with the Send Message node, using the Incoming Message trigger state.
• Configure the Send Message node with the phone number to which you want to forward the Message. For example, in this case, “+14157778889”.
• Once you have configured the node, click Validate to save the configurations.
• After you complete the configurations, provide a recognizable name for your PHLO and click Save. Your PHLO is now ready.

Assign the PHLO to a Plivo Number to Forward Incoming SMS

Once you have created and configured your PHLO, assign your PHLO to a Plivo number.

To assign a PHLO to a number:

1. Log in to your Plivo Console
2. On the Product Navigation bar, click Phone Numbers.
3. On the Numbers page, under Your Numbers, click the phone number you wish to use for the PHLO.
4. In the Number Configuration window, select PHLO from the Application Type list.
5. From the PHLO Name list, select the PHLO you wish to use with the phone number, and then click Update Number.

If you have not purchased a phone number yet, you can buy a phone number(s) by referring to the instructions available here.

Test and Validate

You can now send a sms to your Plivo phone number and see how the inbound sms is forwarded to the phone number specified in the PHLO.

For more information about creating a PHLO app, see the PHLO User Guide.
For information on components and their variables, see the PHLO Components Library.