A Step by step Guide for Using Kaleyra’s Blacklist API

A Step by step Guide for Using Kaleyra’s Blacklist API
By Sakshee Sunil Sarrawgi . 13 Mar 2019 . image 4 min read

Kaleyra’s Voice APIs help give businesses complete control over their communication. Its unique and easy to use voice platform can easily be integrated into your existing systems, hassle-free. Through our blacklist API, you can block any number from an account. Businesses often need to blacklist spam numbers, robocalls or other unwanted numbers that hinder the execution process. This API allows you to easily blacklist a certain phone number or a pool of numbers.

With this guide, you will learn how to use our blacklist API to your advantage. We will be taking you through two different ways in which you can easily blacklist a number. One would be at the application level by using Kaleyra’s Voice Platform and the other would be at the developer level by running our Blacklist API. To blacklist multiple numbers simultaneously, add all the numbers on to the API and separate them by a comma (,).

Kaleyra’s Black list API parameters

   Parameter               Description                   Expected Value
Format Output response format   Default text. Supports JSON and XML 

Response Data

                         Status                              Message
It indicates the success or failure of your request. 200 is a success, others are a failure It indicates the success  or failure message                                                                                               

What you will need:

  1. Active Kaleyra Voice account
  2. Activate API key
  3. Phone number(s) that needs to be blacklisted

How does it work?

Using Kaleyra’s Voice Platform

Step 1: Activate your Kaleyra Voice Account

Step 2: Once your account is ready to use and you have logged in, click on the blacklist option from the menu bar

Activate your Kaleyra Voice Account

Step 3: Click on the ‘New’ button to add a new number that you want to blacklist


Click on the ‘New’ button and add number

Step 4: Simply enter the number you want to blacklist. You can also add notes to remember the reason behind blocking a specific number


add to black list

Step 5: Once you add the number you can immediately view its status. The page also shows you the phone number, notes, date and time of all blacklisted contacts, allowing you to easily keep track of your actions

blacklisted contacts

You can also remove a contact from the blacklist with a simple click. All you have to do is select on the ‘delete icon’ under the ‘Actions’ column. In addition, by clicking on the ‘edit icon’ you can make the required changes, at any time.

remove a contact from the blacklist

Running Kaleyra’s Blacklist API

Step 1: Go to Kaleyra’s Voice APIs page

Step 2: Click on the ‘blacklist a number’ API from the numerous other Voice APIs available


Step 3: Copy the unique URL to use the Blacklist API

Copy the unique URL to use the Blacklist API

Step 4: Fill in the required details including the unique URL you copied earlier, your activated API Key, and the number that needs to be blocked


Step 5: Once you click on the ‘send’ button, you can immediately view the status of your action

view the status

To remove a number from the blacklist, you can use Kaleyra’s Undo Number Blacklist API and run it following the same steps you used to run the Blacklist API. Once you remove the number, you can immediately view the status change.

remove a number from the blacklist

In 5 quick steps, you can use Kaleyra’s blacklist API to block unwanted contacts and ensure that your business communication is running smoothly. Kaleyra’s dynamic Voice APIs serve as the optimal interface required for effective communication with customers and, at the same time, allows high scalability. They further enable click-to-call, number blacklisting, provide call edits and much more. To learn about how these numerous APIs can help you build the exact call experience you want, click here.


Your email address will not be published. Required fields are marked *