When you don’t want to receive calls from a specific phone number or even a whole country, follow the instructions in this guide to create an application to block phone numbers or country codes associated with incoming calls.
You can screen incoming calls either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.
You can create and deploy a PHLO to screen inbound calls with a few clicks on the PHLO canvas, without writing a single line of code.
When you receive a call on a voice-enabled Plivo number, you can control the call flow by associating a PHLO application to that Plivo number. Plivo will fetch the PHLO associated with the number and expect valid instructions via PHLO to handle the call.
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 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.
To create a PHLO, visit the PHLO page of the Plivo console. If this is your first PHLO, the PHLO page will be empty.
You can create a PHLO to block a specific number or a whole country. This first example shows how to block a specific number.
Draw a line to connect the Start node’s Incoming Call trigger state to the Branch node.
The branch component splits a workflow by comparing a variable with a value. Based on the conditions, the execution branches into different workflows. In this case, we compare the “from” number to a specific phone number to block.
In the Configuration panel, enter the caller ID variable {{Start.call.from}}
in Variable to compare field.
In Operation, select “Is equal to” from the drop-down list.
In the final field, enter a value to compare: in this case a phone number — for example, 1-202-555-1234.
Drag and drop the Call forwarding component onto the canvas and connect No Match to it.
This example shows how to block calls from a whole country.
Click Create New PHLO.
From the list of components on the left side, drag and drop the Branch 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 Branch node.
The branch component splits a workflow by comparing a variable with a value. Based on the conditions, the execution branches into different workflows. In this case, we compare the two-character ISO country code to block calls from a specific country.
In the Configuration panel, enter the ISO code variable {{Start.call.from_iso2}}
in Variable to compare field.
In Operation, select “Is equal to” from the drop-down list.
In the final field, enter a value to compare: in this case the ISO code for the country you want to block.
Drag and drop the Call forwarding component onto the canvas and connect No Match to it.
Once you’ve created and configured your PHLO, assign it to a Plivo number.
You can now make a call to your Plivo phone number from a blocked phone number or country and see that the call is rejected. If you make a call from any other number, the call should be forwarded as specified in the PHLO.
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 a Plivo XML document that screens incoming calls on a Plivo number.
Plivo requests an answer URL when it answers the call (step 2) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. In this example, when an incoming call is received, we check whether the number has been blacklisted. If it has, we reject the call using the Hangup XML element. If the phone number hasn’t been blacklisted, we return a Speak XML element that says, “Hello, how are you today.”
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 .NET development environment and a web server and safely expose that server to the internet.
In Visual Studio, create a new project. Use the template for Web Application (Model-View-Controller).
Give the project a name — we used Screencall
.
Navigate to Controllers directory in the Screencall project. Create a controller named ScreencallController.cs 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
27
28
29
30
31
32
using System;
using System.Collections.Generic;
using Plivo.XML;
using Microsoft.AspNetCore.Mvc;
namespace Screencall.Controllers
{
public class ScreencallController : Controller
{
// GET: /<controller>/
public IActionResult Index()
{
string[] blacklist = { "<phone_number1>", "<phone_number2>", "<phone_number3>" };
string fromNumber = Request.Query["From"];
Plivo.XML.Response resp = new Plivo.XML.Response();
if (blacklist.Equals(fromNumber))
{
resp.AddHangup(new Dictionary<string, string>()
{
{"reason","rejected"}, // Specify the reason for hangup
});
}
else
{
resp.AddSpeak("Hello, how are you today", new Dictionary<string, string>() { });
}
var output = resp.ToString();
return this.Content(output, "text/xml");
}
}
}
Replace the phone number placeholders with actual phone numbers (for example, 12025551234).
Associate the controller you created with Plivo by creating a Plivo application. Visit Voice > Applications in the Plivo console and click on Add New Application, or use Plivo’s Application API.
Give your application a name — we called ours Screen Call
. Enter the server URL you want to use (for example https://<yourdomain>.com/screen_call/
) in the Answer URL
field and set the method to POST
. Click Create Application to save 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 Screen Call
(the name we gave the application).
Click Update Number to save.
Make a call to your Plivo number using any phone. Plivo will send a request to the answer URL you provided requesting an XML response and then process the call according to the instructions in the XML document the server provides. If your phone number is not blacklisted, the call will go through and you should hear, “Hello, how are you today.”