Get Started with Java Using Spark Framework

Start by signing up for a free trial account that you can use to experiment with and learn about our services. The free trial account comes with free credits, and you can add more as you go along. You can also add a phone number to your account to start testing the full range of our voice and SMS features. A page in our support portal walks you through the signup process. You can start making and receiving calls either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Set up your Java Spark dev environment

You must set up and install Java 1.8 or higher and Plivo’s Java SDK before you make your first call.You can check your Java version under macOS or Linux by running the command java -version in a terminal window. Under Windows there are several ways to check. If you don’t have Java installed or need a more current version, download and install it.You should also download and install IntelliJ Idea.

Install the Plivo Java package using IntelliJ Idea

Create a new project in IntelliJ Idea.

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

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

Install the Plivo Java, Spark & SLF4j package by adding the dependency in pom.xml

<dependencies>
   <dependency>
      <groupId>com.sparkjava</groupId>
      <artifactId>spark-core</artifactId>
      <version>2.9.1</version>
   </dependency>
   <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-simple</artifactId>
      <version>1.7.21</version>
   </dependency>
   <dependency>
      <groupId>com.plivo</groupId>
      <artifactId>plivo-java</artifactId>
      <version>5.9.3</version>
   </dependency>
</dependencies>

Once you’ve set up your development environment, you can start making and receiving calls using PHLO, our visual workflow design studio, or using our APIs and XML documents. Here are three common use cases to get you started.

Make your first outbound call

You can create and deploy a PHLO to make an outbound call with a few clicks on the PHLO canvas, and trigger it with some simple code.

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 side, drag and drop the Initiate Call 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 Initiate Call node.
In the Configuration pane at the right of the canvas, configure the Initiate Call node with a caller ID in the From field. Enter the destination number you wish to call in the To 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.
Similarly, create a node from the Play Audio component. Connect the Initiate Call node to the Play Audio node using the Answered trigger state.
Configure the Play Audio node to play a message to the user by entering text in the Speak Text box in the Prompt section of the Configuration pane — for example, “Hello, you just received your first call.”
Connect the Initiate Call node’s Answered trigger state to the Play Audio node.
After you complete the configuration, give the PHLO a name by clicking in the upper left, then click Save.

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.

You also need the PHLO ID, which you can copy from the PHLO list page.

With a static payload

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

Code

Create a Java class in the project called TriggerPhlo and paste into it this code.

package com.plivo.api.samples.call;

import com.plivo.api.Plivo;
import com.plivo.api.PlivoClient;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.phlo.Phlo;
import com.plivo.api.models.phlo.PhloUpdateResponse;

import java.io.IOException;

import static spark.Spark.*;

class Example { 

    public static void main(String[] args) {
        get("/trigger_phlo", (req, resp) -> {
            try {
                final String authId = "<auth_id>";
                final String authToken = "<auth_token>";
                PlivoClient client = new PlivoClient(authId, authToken);
                {
                    String phloId = "<phlo_id>";
                    Plivo.init(authId, authToken);
                    Phlo phlo = Phlo.getter(phloId).client(client).get();
                    PhloUpdateResponse response = Phlo.updater(phloId).run();
                    return response;
                }
            } catch (PlivoRestException | IOException exception) {
                return exception;
            } });
    }
}

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.

Code

Create a Java class in the project called TriggerPhlo and paste into it this code.

package com.plivo.api.samples.call;

import com.plivo.api.Plivo;
import com.plivo.api.PlivoClient;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.phlo.Phlo;
import com.plivo.api.models.phlo.PhloUpdateResponse;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import static spark.Spark.*;

class Example {

    public static void main(String[] args) {
        get("/trigger_phlo_with_payload", (req, resp) -> {
            try {
                final String authId = "<auth_id>";
                final String authToken = "<auth_token>";
                PlivoClient client = new PlivoClient(authId, authToken);
                {
                    String phloId = "<phlo_id>";
                    Plivo.init(authId, authToken);
                    Phlo phlo = Phlo.getter(phloId).client(client).get();
                    Map<String, Object> payload = new HashMap<>();
                    payload.put("from", "<caller_id>");
                    payload.put("to", "<destination_number>");
                    PhloUpdateResponse response = Phlo.updater(phloId).payload(payload).run();
                    return response;
                }
            } catch (PlivoRestException | IOException exception) {
                return exception;
            } });
    }
}

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 from IntelliJ Idea.

Receive your first inbound call

You can create and deploy a PHLO to receive an inbound call with a few clicks on the PHLO canvas, without writing a single line of code.

Prerequisite

To receive incoming calls, you must have a voice-enabled Plivo phone number. 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.

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 side, drag and drop the Play Audio 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 Call trigger state to the Play Audio node.
In the Configuration pane at the right of the canvas, configure the Play Audio node to play a message to the caller.
Once you’ve configured the node, click Validate to save 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 have created and configured your PHLO, assign your PHLO to a Plivo number.

To assign a PHLO to a 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.

Test

You can now make a call to your Plivo phone number and see how the inbound call 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.

Forward an Incoming call

You can create and deploy a workflow to implement call forwarding with a few clicks on the PHLO canvas.

Prerequisite

To receive incoming calls, you must have a voice-enabled Plivo phone number. 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.

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 side, drag and drop the Call Forward 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 Call trigger state to the Call Forward node.
In the Configuration tab at the right of the canvas, configure the Call Forward node to select the From number using a variable. Enter two curly brackets to view all available variables, and choose the appropriate one. Enter all the numbers you want to call in the To field, separated with commas.
Once you’ve configured the node, click Validate to save 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 your PHLO 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 phone number, then click Update Number.

Test

You can now call your Plivo phone number and see how the inbound call is forwarded.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.

More use cases

We illustrate more than 20 use cases with code for both PHLO and API/XML on our documentation pages.

QUICKSTART GUIDES

MIGRATION GUIDES

SERVER SDK MIGRATION GUIDES

Get Started with Java Using Spark Framework

Set up your Java Spark dev environment

Install the Plivo Java package using IntelliJ Idea

Make your first outbound call

Create the PHLO

Trigger the PHLO

With a static payload

Code

With a dynamic payload

Code

Test

Receive your first inbound call

Prerequisite

Create the PHLO

Assign the PHLO to a Plivo number

To assign a PHLO to a number:

Test

Forward an Incoming call

Prerequisite

Create the PHLO

Assign the PHLO to a Plivo number

Test

More use cases

QUICKSTART GUIDES

MIGRATION GUIDES

SERVER SDK MIGRATION GUIDES

​Set up your Java Spark dev environment

​Install the Plivo Java package using IntelliJ Idea

​Make your first outbound call

​Create the PHLO

​Trigger the PHLO

​With a static payload

​Code

​With a dynamic payload

​Code

​Test

​Receive your first inbound call

​Prerequisite

​Create the PHLO

​Assign the PHLO to a Plivo number

​To assign a PHLO to a number:

​Test

​Forward an Incoming call

​Prerequisite

​Create the PHLO

​Assign the PHLO to a Plivo number

​Test

​More use cases

Set up your Java Spark dev environment

Install the Plivo Java package using IntelliJ Idea

Make your first outbound call

Create the PHLO

Trigger the PHLO

With a static payload

Code

With a dynamic payload

Code

Test

Receive your first inbound call

Prerequisite

Create the PHLO

Assign the PHLO to a Plivo number

To assign a PHLO to a number:

Test

Forward an Incoming call

Prerequisite

Create the PHLO

Assign the PHLO to a Plivo number

Test

More use cases