Skip to main content

Documentation Index

Fetch the complete documentation index at: https://plivo.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

You may want to have an application dial out for someone, so that it calls them on their phone, then connects them to the number they want. This involves three tasks:
  1. Make an outbound call to a caller.
  2. When the call recipient answers the phone, place a new call to a different number (second user).
  3. Bridge the calls (first and second user) after the second user answers.
Common use cases for this practice include click to call, where a server application directs a call to a person who clicks on a web link, then connects them with a company representative. This guide shows how to code connecting a user to second person on the Plivo platform, either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.
Here‘s how to connect a call to a second person using XML.

​
Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. You must have a voice-enabled Plivo phone number to receive incoming calls; 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 Java development environment and a web server and safely expose that server to the internet.

​
Create a Spring server to connect calls to a second person

Edit the PlivoVoiceApplication.java file in the src/main/java/com.example.demo/ folder and paste into it this code.
Note: Here, the demo application name is PlivoVoiceApplication.java because we provided the friendly name Plivo Voice in the Spring Initializr.
package com.example.connect;

import com.plivo.api.Plivo;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.exceptions.PlivoValidationException;
import com.plivo.api.exceptions.PlivoXmlException;
import com.plivo.api.models.call.Call;
import com.plivo.api.models.call.CallCreateResponse;
import com.plivo.api.xml.Dial;
import javax.servlet.http.HttpServletRequest;
import com.plivo.api.xml.Number;
import com.plivo.api.xml.Response;
import com.plivo.api.xml.Speak;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;
import java.util.Collections;

@RestController
@SpringBootApplication
public class ConnectApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConnectApplication.class, args);
	}
	
	@RequestMapping(value = "/outbound_call", produces = {"application/json"}, method = {RequestMethod.GET})
	public String call(HttpServletRequest request) throws PlivoXmlException, PlivoValidationException, IOException, PlivoRestException {
		String hostName = request.getRequestURL().toString();
		Plivo.init("<auth_id>","<auth_token>");
		System.out.println(hostName + "/connect");
		CallCreateResponse response = Call.creator("<caller_id>", Collections.singletonList("<destination_number>"), hostName + "connect")
				.create();
		return response.toString();
	}
	
	@RequestMapping(value = "outbound_call/connect", produces = {"text/xml"})
	public String connect() throws PlivoXmlException, PlivoValidationException {
		Response response = new Response()
				.children(
						new Speak("Please wait while we connect your call to the second number"),
						new Dial()
								.children(
										new Number("<second_number>") // Dial to second number
								));
		return response.toXmlString();
	}
}
Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers (for example, 12025551234).Save the file and run it.
You should see your basic server application in action at http://localhost:8080/outbound_call/.Set up ngrok to expose your local server to the internet.
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 <a rel="nofollow" href="https://docs.oracle.com/javase/tutorial/essential/environment/env.html">System.getenv()</a> to store environment variables and retrieve them when initializing the client.

​
Test

Have your application make a call to a regular mobile phone. Plivo will send a request to your answer URL requesting a valid XML response and connect the call to a second user.