Difference between revisions of "Mobile Number Portability Addon"

From Kolmisoft Wiki
Jump to navigationJump to search
(38 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<!---This functionality is available from MOR 8--->
[http://en.wikipedia.org/wiki/Mobile_number_portability Mobile number portability (MNP)] enables mobile telephone users to retain their mobile telephone numbers when changing from one mobile network operator to another.
[http://en.wikipedia.org/wiki/Mobile_number_portability Mobile number portability (MNP)] enables mobile telephone users to retain their mobile telephone numbers when changing from one mobile network operator to another.


Line 5: Line 6:
MNP Addon for MOR allows system owner to check number if it belongs to other network and if so - route it through different providers or bill it with different price.
MNP Addon for MOR allows system owner to check number if it belongs to other network and if so - route it through different providers or bill it with different price.


Current implementation allows to save numbers in MySQL database on any server (possible not on local server).
Current implementation allows to save numbers in MySQL database on any server (possible not necessarily on local server).


Before each call MOR MNP Addon checks dialed number and if number is found in database - some prefix is added in front of it.
Before each call MOR MNP Addon checks dialed number and if number is found in database - some prefix is added in front of it.


By prefix MOR can set different routing(LCR) or billing(Tariff) for this number.
By prefix MOR can set different routing(LCR) or billing(Tariff) for this number. [[Localization | Localization rules]] should be used to perform these actions.


Detailed technique is described here: [[LCR/Tariff change based on call prefix]]
Detailed technique is described here: [[LCR/Tariff change based on call prefix]]


MNP Addon for MOR is available from MOR v8
As Kolmisoft cannot make one unique database for all MNP services in all countries all over the world. MOR admin has to


<br><br>
manually enter numbers in MNP database (process described below) in order for this solution to work. mor_mnp database has
NOTE: It is important to take care of various number formats user can use to dial a number. As a solution to it is to insert MNP number into DB in several possible formats.
 
to contain only the necessary data (telephone numbers).


<br><br>
<br><br>
Line 23: Line 25:
Do such steps:
Do such steps:


  1. [[Upgrade_MOR_GUI |Upgrade MOR]]
1. Update MOR scripts:
  2. cd /usr/src/mor/sh_scripts
rm -fr /usr/src/mor
  3. ./install_mnp.sh
svn co http://svn.kolmisoft.com/mor/install_script/trunk/ /usr/src/mor
2. Run MNP installation script:
/usr/src/mor/sh_scripts/install_mnp.sh
3. Run script which will update Asterisk extlines to work with MNP database:
/usr/src/mor/test/scripts/asterisk/mnp_cfgs.sh
 
== How to see if MNP works ==
 
Open Asterisk CLI. During the call check very first lines shown in CLI. In about 10th line you should be able to see lines like that:
 
    -- Launched AGI Script /var/lib/asterisk/agi-bin/mor_mnp
mor_mnp:
mor_mnp: MOR MNP AGI script started.
mor_mnp: Successfully connected to database.
mor_mnp: Extension: 37012312345
mor_mnp: New extension: 37012312345
mor_mnp: MOR MNP AGI script stopped.
mor_mnp:
 
If you cannot see it. Something is wrong with configuration.


<br><br>
<br><br>
= Upgrade =


After [[Upgrade_MOR_GUI |Upgrade MOR]] run /usr/src/mor/upgrade/trunk/mnp_reenable.sh
= Upgrade/Update =


After [[Upgrade_MOR_GUI |MOR Upgrade]] or Update run /usr/src/mor/test/scripts/asterisk/mnp_cfgs.sh
<br><br>
<br><br>
= Database =
= Database =


Line 52: Line 74:


Make sure you have set correct MySQL permissions for mor_mnp database and also local or remote asterisk must have correct settings in /usr/local/mor/mor_mnp.conf . If your number is still not recognized, double check if you have it in your mor_mnp database!
Make sure you have set correct MySQL permissions for mor_mnp database and also local or remote asterisk must have correct settings in /usr/local/mor/mor_mnp.conf . If your number is still not recognized, double check if you have it in your mor_mnp database!
An example how to set MySQL permissions:
GRANT REPLICATION SLAVE , REPLICATION CLIENT ON * . * TO 'mor'@'localhost' IDENTIFIED BY 'mor' WITH MAX_QUERIES_PER_HOUR 0
MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;
GRANT ALL PRIVILEGES ON `mor_mnp` . * TO 'mor'@'localhost' WITH GRANT OPTION ;
<br><br>
= How to use MNP =
You need to insert two values in mor_mnp database. These values are number and prefix.
<br><br>
To manage mor_mnp database you can use PhpMyAdmin:
<nowiki>http://<your server IP>/mordbadmin</nowiki>
PhpMyAdmin login details can be found in file /root/phpMyAdminPassword
<br><br>
If after loging in to PhpMyAdmin, MySQL login page will appear, use these details to login to MySQL:
username: mor
password: mor
<br><br>
Now click "_mnp (1)" menu item on the left to select mor_mnp database.
"numbers" menu item will appear after that.
Click on "numbers" menu item to manage number table.
Now click on "Insert" tab at the top of page.
Fields number and prefix will appear.
Enter desired values and click "Go" to insert these values.
Done!
<br><br>
= Number localization =
In situations when number can be dialed in multiple ways you can set '''mnp_prefixes''' variable in '''/usr/local/mor/mor_mnp.conf'''.<br>
For example, if number 123456789 can be dialed with the following prefixes '''00370'''123456789, '''370'''123456789, '''8'''123456789 then you can set '''mnp_prefixes''' variable with the following prefixes:
mnp_prefixes = 00370,370,8
then you will be able to upload only single number 123456789 into MNP database and this number will be matched when client dials '''00370'''123456789, '''370'''123456789 or '''8'''123456789.
= MNP tags in SIP INVITE =
MNP tags (npdi and rn) can be enabled by setting '''Enable MNP tags''' to '''yes''' in Provider configuration.<br>
If MNP tags are enabled and MNP lookup was successful, then npdi and rn tags will be added to SIP INVITE:
INVITE sip:DST_NUMBER;npdi;rn=MNP_NUMBER@IP SIP/2.0
here:
* DST_NUMBER - localized destination number, for example +370123456789
* MNP_NUMBER - localized destination number with MNP prefix, for example +370'''999'''123456789
If number is not found in MNP database, then only npdi tag will be added to SIP INVITE:
INVITE sip:DST_NUMBER;npdi@IP SIP/2.0
here:
* DST_NUMBER - localized destination number, for example +370123456
'''Note''' that only SIP INVITE request will be modified. Other SIP headers (such as TO, FROM) are not affected by '''Enable MNP tags''' setting.
= How to import numbers from CSV =
There is no such option to import numbers from CSV in MOR GUI, but numbers can be imported directly to MNP database.
This procedure is described here:
1. You need to have CSV file on your server and file should look like:
...
37012312345;9991
37012312344;9991
37112312343;9992
37112354321;9992
...
2. Open MySQL CLI:
mysql mor_mnp
3. Create temporary table and import CSV file to it:
CREATE TABLE temp (col_1 VARCHAR(50) default NULL , col_2 VARCHAR(20) default NULL);
LOAD DATA LOCAL INFILE '/home/mnpnumbers.csv' IGNORE INTO TABLE temp FIELDS TERMINATED BY ';' ;
4. Copy data from temporary table to 'numbers' table:
<nowiki>INSERT INTO numbers (number,prefix) SELECT TRIM(REPLACE(col_1, '\r', '')), TRIM(REPLACE(col_2, '\r', '')) FROM temp
WHERE ( TRIM(REPLACE(col_1, '\r', '')) REGEXP '^[0-9]+$' = 1) and (TRIM(REPLACE(col_2, '\r', '')) REGEXP '^[0-9]+$' = 1) ;</nowiki>
NOTE: this query skips values which contains non-numerical characters.
For example: row
...
+370123123456;9997
...
will not be imported to 'numbers' table.
5. Detele temporary table:
DROP TABLE temp;
Done. Numbers are imported to 'numbers' table.
<br><br>
== Automatic import script ==
Script downloads compressed (ZIP) CSV with list of numbers from SFTP server and imports in with default prefix to MNP database. Current ZIP file required. Only SFTP is supported. Script does not import prefixes from CSV. CSV should contain only list of numbers.
Script is located in /usr/src/mor/sh_scripts/mnp_numbers_import.sh
Script uses same configuration file /usr/local/mor/mor_mnp.conf . Options which are specific for this script:
download_url = sftp.server.com:/path/to/file.zip  #some remote location of a number file (for sftp)
username = ftpuser                                #user name to connect to a remote server
password = ftppassword                            #password for a user to connect to a remote server
default_prefix = 0009                            #default prefix for numbers (current version does not support prefix import)
= How to configure external MNP database =
Skip this step if your MOR billing installation is on one server.<br>
Locate mor_mnp.conf file<br>
cd /usr/local/mor<br>
Edit the file with your favorite text editor, for example:<br>
mcedit mor_mnp.conf<br>
You should see similar values, '''mind the gaps in the file, they should be exactly the same as in the example below''':<br>
host = localhost
db = mor_mnp
user = mor
secret = mor
port = 3306
server_id = 1
show_sql = 0
debug = 1
mnp_prefixes = 00370,370,8
Change the values to the ones you need:<br>
host - your database IP address<br>
server_id - your Asterisk server id, same as in /etc/asterisk/mor.conf
<br><br>
=See also=
=See also=
* [[MOR Addons]]
* [[MOR Addons]]
* [http://en.wikipedia.org/wiki/Least-cost_routing#Impact_of_mobile-number_portability_in_VOIP_and_LCR_environments Impact of MNP in VOIP and LCR environments]
<br><br>

Revision as of 11:44, 29 August 2018

Mobile number portability (MNP) enables mobile telephone users to retain their mobile telephone numbers when changing from one mobile network operator to another.


MNP Addon for MOR allows system owner to check number if it belongs to other network and if so - route it through different providers or bill it with different price.

Current implementation allows to save numbers in MySQL database on any server (possible not necessarily on local server).

Before each call MOR MNP Addon checks dialed number and if number is found in database - some prefix is added in front of it.

By prefix MOR can set different routing(LCR) or billing(Tariff) for this number. Localization rules should be used to perform these actions.

Detailed technique is described here: LCR/Tariff change based on call prefix

As Kolmisoft cannot make one unique database for all MNP services in all countries all over the world. MOR admin has to

manually enter numbers in MNP database (process described below) in order for this solution to work. mor_mnp database has

to contain only the necessary data (telephone numbers).



Installation

Do such steps:

1. Update MOR scripts:

rm -fr /usr/src/mor
svn co http://svn.kolmisoft.com/mor/install_script/trunk/ /usr/src/mor

2. Run MNP installation script:

/usr/src/mor/sh_scripts/install_mnp.sh

3. Run script which will update Asterisk extlines to work with MNP database:

/usr/src/mor/test/scripts/asterisk/mnp_cfgs.sh

How to see if MNP works

Open Asterisk CLI. During the call check very first lines shown in CLI. In about 10th line you should be able to see lines like that:

    -- Launched AGI Script /var/lib/asterisk/agi-bin/mor_mnp
mor_mnp: 
mor_mnp: MOR MNP AGI script started.
mor_mnp: Successfully connected to database.
mor_mnp: Extension: 37012312345
mor_mnp: New extension: 37012312345
mor_mnp: MOR MNP AGI script stopped.
mor_mnp: 

If you cannot see it. Something is wrong with configuration.



Upgrade/Update

After MOR Upgrade or Update run /usr/src/mor/test/scripts/asterisk/mnp_cfgs.sh

Database

Config to DB in: /usr/local/mor/mor_mnp.conf

It should be MySQL database mor_mnp:

DROP TABLE IF EXISTS `numbers`;
CREATE TABLE `numbers` (
 `number` varchar(50) NOT NULL,
 `prefix` varchar(20) NOT NULL,
 PRIMARY KEY  (`number`),
 UNIQUE KEY `number` (`number`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;




Make sure you have set correct MySQL permissions for mor_mnp database and also local or remote asterisk must have correct settings in /usr/local/mor/mor_mnp.conf . If your number is still not recognized, double check if you have it in your mor_mnp database!

An example how to set MySQL permissions:


GRANT REPLICATION SLAVE , REPLICATION CLIENT ON * . * TO 'mor'@'localhost' IDENTIFIED BY 'mor' WITH MAX_QUERIES_PER_HOUR 0
MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;
GRANT ALL PRIVILEGES ON `mor_mnp` . * TO 'mor'@'localhost' WITH GRANT OPTION ;



How to use MNP

You need to insert two values in mor_mnp database. These values are number and prefix.

To manage mor_mnp database you can use PhpMyAdmin:

http://<your server IP>/mordbadmin

PhpMyAdmin login details can be found in file /root/phpMyAdminPassword

If after loging in to PhpMyAdmin, MySQL login page will appear, use these details to login to MySQL:

username: mor

password: mor

Now click "_mnp (1)" menu item on the left to select mor_mnp database.

"numbers" menu item will appear after that.

Click on "numbers" menu item to manage number table.

Now click on "Insert" tab at the top of page.

Fields number and prefix will appear.

Enter desired values and click "Go" to insert these values.

Done!

Number localization

In situations when number can be dialed in multiple ways you can set mnp_prefixes variable in /usr/local/mor/mor_mnp.conf.

For example, if number 123456789 can be dialed with the following prefixes 00370123456789, 370123456789, 8123456789 then you can set mnp_prefixes variable with the following prefixes:

mnp_prefixes = 00370,370,8

then you will be able to upload only single number 123456789 into MNP database and this number will be matched when client dials 00370123456789, 370123456789 or 8123456789.

MNP tags in SIP INVITE

MNP tags (npdi and rn) can be enabled by setting Enable MNP tags to yes in Provider configuration.

If MNP tags are enabled and MNP lookup was successful, then npdi and rn tags will be added to SIP INVITE:

INVITE sip:DST_NUMBER;npdi;rn=MNP_NUMBER@IP SIP/2.0

here:

  • DST_NUMBER - localized destination number, for example +370123456789
  • MNP_NUMBER - localized destination number with MNP prefix, for example +370999123456789

If number is not found in MNP database, then only npdi tag will be added to SIP INVITE:

INVITE sip:DST_NUMBER;npdi@IP SIP/2.0

here:

  • DST_NUMBER - localized destination number, for example +370123456


Note that only SIP INVITE request will be modified. Other SIP headers (such as TO, FROM) are not affected by Enable MNP tags setting.

How to import numbers from CSV

There is no such option to import numbers from CSV in MOR GUI, but numbers can be imported directly to MNP database.

This procedure is described here:

1. You need to have CSV file on your server and file should look like:

...
37012312345;9991
37012312344;9991
37112312343;9992
37112354321;9992
...

2. Open MySQL CLI:

mysql mor_mnp

3. Create temporary table and import CSV file to it:

CREATE TABLE temp (col_1 VARCHAR(50) default NULL , col_2 VARCHAR(20) default NULL);
LOAD DATA LOCAL INFILE '/home/mnpnumbers.csv' IGNORE INTO TABLE temp FIELDS TERMINATED BY ';' ;

4. Copy data from temporary table to 'numbers' table:

INSERT INTO numbers (number,prefix) SELECT TRIM(REPLACE(col_1, '\r', '')), TRIM(REPLACE(col_2, '\r', '')) FROM temp 
 WHERE ( TRIM(REPLACE(col_1, '\r', '')) REGEXP '^[0-9]+$' = 1) and (TRIM(REPLACE(col_2, '\r', '')) REGEXP '^[0-9]+$' = 1) ;


NOTE: this query skips values which contains non-numerical characters.

For example: row

...
+370123123456;9997
...

will not be imported to 'numbers' table.

5. Detele temporary table:

DROP TABLE temp;

Done. Numbers are imported to 'numbers' table.

Automatic import script

Script downloads compressed (ZIP) CSV with list of numbers from SFTP server and imports in with default prefix to MNP database. Current ZIP file required. Only SFTP is supported. Script does not import prefixes from CSV. CSV should contain only list of numbers.

Script is located in /usr/src/mor/sh_scripts/mnp_numbers_import.sh

Script uses same configuration file /usr/local/mor/mor_mnp.conf . Options which are specific for this script:

download_url = sftp.server.com:/path/to/file.zip  #some remote location of a number file (for sftp)
username = ftpuser                                #user name to connect to a remote server
password = ftppassword                            #password for a user to connect to a remote server
default_prefix = 0009                             #default prefix for numbers (current version does not support prefix import)

How to configure external MNP database

Skip this step if your MOR billing installation is on one server.

Locate mor_mnp.conf file

cd /usr/local/mor

Edit the file with your favorite text editor, for example:

mcedit mor_mnp.conf

You should see similar values, mind the gaps in the file, they should be exactly the same as in the example below:

host = localhost
db = mor_mnp
user = mor
secret = mor
port = 3306
server_id = 1
show_sql = 0
debug = 1
mnp_prefixes = 00370,370,8

Change the values to the ones you need:

host - your database IP address
server_id - your Asterisk server id, same as in /etc/asterisk/mor.conf

See also