Adding White or Black Listing to a Routing Script

This artilce describes how to add White or Black listing to any Routing scripts. With this script, any called or calling number prefix can be blacklisted or whitelisted. This script can be assigned globally, or per NAP. For this, you choose the "scope" to be "global" or "per_nap". It also reads a .csv file which has the called and calling number list (default name 'black_white_list.csv').

A blacklisted called number set globally will block anyone trying to reach that number (or number prefix). A whitelisted calling number will only allow calls from these calling numbers in the system - all other calls will be dropped.

Setting up White and Black Listing Scripts

To set up a Filter, the main script needs to be modified. The main script can be either simple_routing.rb, or any other script.

First, go to the routing script section of the Web portal

Gateway -> Routing scripts -> Example Scripts -> simple_routing.rb [Edit]

Three things need to be added. At the start of the script:

require 'black_white_listing'

In the main class:

include BlackWhiteListing

before_filter :method => :black_white_listing, :scope => :global

The final script will look like this:

require 'base_routing'
require 'black_white_listing'

class NapGroupAndWeightRouting < BaseRouting
  include BlackWhiteListing

  before_filter :method => :black_white_listing, :scope => :global

  route_match :call_field_name => :called
  route_match :call_field_name => :calling
  route_match :call_field_name => :nap
  route_match :method => :match_nap_availability
  route_remap :call_field_name => :called, :route_field_name => :remapped_called
  route_remap :call_field_name => :calling, :route_field_name => :remapped_calling
  route_remap :call_field_name => :nap, :route_field_name => :remapped_nap
end

White and black listing file

The 'black_white_list.csv' file needs to be formatted in a specific way. There are 4 columns: The first one indicates the calling number (or calling number prefix). The second one indicates the whether the calling number is whitelisted 'w' or blacklisted 'b'. The third one indicates the called number (or called number prefix). The last one indicates whether the prefix is whitelisted 'w' or blacklisted 'b'.

This example blacklists the calling numbers 148240000 and 148240707, and also any calls that try to reach numbers starting with 450 or 514 :

calling	calling_params	called	called_params
148240707	b
148240000	b
		450	b
		514	b

To add the white and black listing file to the system

1. Click FileDB in the navigation panel

2. Click Import new file

3. Click Browse and select the 'black_white_list.csv' you wish to import.

4. Click Import

Import new file black white listing

To assign a white and black listing to a NAP

The scope needs to be set to "per_nap"

 before_filter :method => :black_white_listing, :scope => :per_nap

You need to add new NAP colums to assign the files to the NAPs:

Gateway -> Routes -> NAP Columns -> Create New NAP Column

Name: black_white_list Type attributes: dbfile Default: black_white_list.csv

NAP black white listing

Add/Edit Black and White List with RestFul API

You can use the Add/Edit black and white list file in your system with RestFul API using JSON format. The JSON format must be the following:

{ "meta": { "version": "3.1.135", "src_path": "" }, "name": "Black_white_list.csv", "content": "calling,calling_params,called,called_param\r\n3016824959,b,,\r\n,,450,b\r\n,,514,b\r\n" }

• name: digitmap file name

• \r\n: new line. Each digit/digits you entered must start with the new line.

Add Black and White List with RestFul API

You can add a new Black and White List with RestFul API file with the POST command:

POST http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/custom_files/

ProSBC will create a new Black and White List file from the name in the JSON file.

Example: We use the Postman tool in this example and the URL is:

http://192.168.1.26:12358/configurations/3CX/file_dbs/File_DB/custom_files/

RestFul BW Post Send

If the import is successful you will see the following information in the Postman Tool

RestFul BW Post Response

Edit Black and White List with RestFul API

You can add a new Black and White List with RestFul API file with the PUT command:

PUT http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/custom_files/

Example: We use the Postman tool in this example and the URL is:

http://192.168.1.26:12358/configurations/3CX/file_dbs/File_DB/custom_files/Black_white_list%2Ecsv

RestFul BW Put Send

If the import is successful you will see the following information in the Postman Tool

RestFul BW Put Response

You can get more information about how to use RestFul API and Postman Tool from the following link Northbound_interface:RESTful