DIALPLAN module

Admin Guide

Overview

This module implements generic string translations based on matching and replacement rules. It can be used to manipulate R-URI or a PV and to translated to a new format/value.

How it works

At startup, the module will load a set of transformation rules from a database. Every database raw will be stored in memory as a translation rule. Each rule will describe how the matching should be made, how the input value should be modified and which attributes should be set for the matching transformation.

The module expects an input value which will be matched against a rules via regexp or string matching. Overlapping matching expressions can be controlled via priorities. Once a rule is matched, the defined transformation (if any) is applied and the result is returned as output value. Also, if any string attribute is associated to the rule, this will be returned to the script along with the output value.

The first matching rule will be processed.

Usage cases

The module can be used to implement dialplans - do to auto completion of the dial numbers (like national to international), to convert generic numbers to specific numbers (like for emergency numbers).

Also the module can be used for detecting range or sets of numbers mapped on a service/case - attributes string can be used here to store extra information about the service/case.

Non-SIP string translation can be implemented - like converting country names from all possible formats to a canonical format: (UK, England, United Kingdom) -> GB.

Any other string-base translation or detection for whatever other purposes.

Database structure and usage

Depending what kind of operation (translation, matching, etc) you want to do with the module, you need to appropriate populate the DB records.

The definition of the tables used by the dialplan module can be found at dialplan table documentation

What to place in table

String translation (regexp detection, subst translation)

Recognize a number block in all forms (international, national) and convert it to a canonical format (e.164)

match_op = 1 (regexp)
match_exp = ”^(0040|+40|0|40)21[0-9]+” ; regular expresion that will be used to match with this rule (if the rule should be applied for the input string)
match_flags = 0 (0 - case sensitive, 1 - case insensitive matching)
subst_exp = ”^(0040|+40|0|40)(.+)” ; regular expresion used to do the transformation (first part of the subst operation)
repl_exp = “40\2” ; second part of the subst (output) - linked to the subst_exp field; when both defined, they work as a subst()

String translation (regexp detection, replacement)

Recognize the name of a country (multiple languages) and convert it to a single fix value

match_op = 1 (regexp)
match_exp = ”^((Germany)|(Germania)|(Deutschland)|(DE))” ; regular expresion that will be used to match with this rule (if the rule should be applied for the input string)
match_flags = 0 (0 - case sensitive, 1 - case insensitive matching)
subst_exp = NULL ; when translation is actually a replacement, this field must be NULL.
repl_exp = “DE” ; static string to replace the input - whenever this rule will match, it will return this string as output.

Number detection (regexp detection, no replacement)

Recognize a block of numbers as belong to a single service and signalize this via an attribute.

match_op = 1 (regexp)
match_exp = “^021456[0-9]{5}” ; regular expresion that will be used to match with this rule (if the rule should be applied for the input string)
match_flags = 0 (0 - case sensitive, 1 - case insensitive matching)
subst_exp = NULL ; no translation
repl_exp = NULL ; no translation
attrs = “serviceX” ; whatever string you will get into OpenSIPS script and it will provide you more information (totally custom)

String conversion (equal detection, replacement)

Recognize a fix string/number and replace it with something fix.

match_op = 0 (equal)
match_exp = “SIP server” ; string to be matched
match_flags = 0 (0 - case sensitive, 1 - case insensitive matching)
subst_exp = NULL ; no subst translation
repl_exp = “OpenSIPS” ; output string

Dependencies

OpenSIPS Modules

The following modules must be loaded before this module:

None

External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

libpcre-dev - the development libraries of PCRE.

Exported Parameters

db_url (string)

The translation rules will be loaded using this database url.

Default value is “mysql://opensips:opensipsrw@localhost/opensips”.

...
modparam("dialplan", "db_url", "mysql://user:passwb@localhost/db")
...

table_name (string)

The table’s name from which to load the translation rules.

Default value is “dialplan”.

...
modparam("dialplan", "table_name", "my_table")
...

dpid_col (string)

The column name to store the dialplan ID group.

Default value is “dpid”.

...
modparam("dialplan", "dpid_col", "column_name")
...

pr_col (string)

The column name to store the priority of the corresponding rule from the database raw.

Default value is “pr”.

...
modparam("dialplan", "pr_col", "column_name")
...

match_op_col (string)

The column name to store the type of matching of the rule.

Default value is “match_op”.

...
modparam("dialplan", "match_op_col", "column_name")
...

match_exp_col (string)

The column name to store the rule match expression.

Default value is “match_exp”.

...
modparam("dialplan", "match_exp_col", "column_name")
...

match_flags_col (string)

The column name to store various matching flags. Currently 0 - case sensitive matching, 1 - case insensitive matching.

Default value is “match_flags”.

...
modparam("dialplan", "match_flags_col", "column_name")
...

subst_exp_col (string)

The column name to store the rule’s substitution expression.

Default value is “subst_exp”.

...
modparam("dialplan", "subst_exp_col", "column_name")
...

repl_exp_col (string)

The column name to store the rule’s replacement expression.

Default value is “repl_exp”.

...
modparam("dialplan", "repl_exp_col", "column_name")
...

attrs_col (string)

The column name to store the rule’s attributes to be set to the message.

Default value is “attrs”.

...
modparam("dialplan", "attrs_col", "column_name")
...

disabled_col (integer)

The column name that indicates if the dialplan rule is disabled.

Default value is “disabled”.

...
modparam("dialplan", "disabled_col", "disabled_column")
...

attrs_pvar (string)

The pvar to store the rule’s attributes, after translation (dp_translate() succeeds). This parameter can be any PVAR that can be written.

Default value is “NULL”.

...
modparam("dialplan", "attrs_pvar", "$avp(dest)")
...

Exported Functions

dp_translate([table/]id, src/dest)

Will try to translate the src string into dest string according to the translation rules with dialplan ID equal to id.

Meaning of the parameters is as follows:

id - the dialplan id of possible matching rules. The id parameter can have the following types:
- integer - the dialplan id is statically assigned
- pvar - the dialplan id is the value of an existing pseudo-variable (as integer value)
table - Specifies the table where the search will take place. This parameter can be ommited. The default table is dialplan. The table parameter can have the following types:
- string - the table name is statically assigned
src/dest - input and output of the function. If this parameter is missing the default parameter “ruri.user/ruri.user” will be used, thus translating the request uri. The “src” variable can be any type of pseudo-variable. The “dest” variable can be also any type of pseudo-variable, but it must be a writtable one.

This function can be used from REQUEST_ROUTE, BRANCH_ROUTE.

...
dp_translate("240", "$ruri.user/$avp(dest)");
xlog("translated to var $avp(dest) \n");
...

...
$avp(src) = $ruri.user;
dp_translate("$var(x)", "$avp(src)/$var(y)");
xlog("translated to var $var(y) \n");
...

...
$avp(src) = $uri.user;
dp_translate("example_table/$var(x)", "$avp(src)/$var(y)");
xlog("translated to var $var(y) \n");
...

Exported MI Functions

dp_reload

It will update the translation rules, loading the database info.

Name: dp_reload

Parameters: 1

table_name - Table to be realoaded. If no table is specified, the table specified in the “table_name” parameter (default dialplan) will be reloaded.

MI DATAGRAM Command Format:

:dp_reload:
_empty_line_

dp_translate

It will apply a translation rule identified by a dialplan id and an input string.

Name: dp_translate

Parameters: 2

[Table Name/]Dialplan ID - The dpid of the rules used to match the input string. The table name can be ommited. The default table is dialplan.
Input String

MI DATAGRAM Command Format:

:dp_translate:
dpid
input
_empty_line_

Installation

The modules requires one table in OpenSIPS database: dialplan.The SQL syntax to create them can be found in dialplan-create.sql script in the database directories in the opensips/scripts folder. You can also find the complete database documentation on the project webpage, http://www.opensips.org/html/docs/db/db-schema-devel.html.

Developer Guide

The module does not provide any API to use in other OpenSIPS modules.

Contributors

By Commit Statistics

Top contributors by DevScore⁽¹⁾, authored commits⁽²⁾ and lines added/removed⁽³⁾

#	Name	DevScore	Commits	Lines++	Lines—
1.	Bogdan-Andrei Iancu (@bogdan-iancu)	45	31	566	514
2.	Andrei Dragus	37	3	882	1529
3.	Anca Vamanu	34	5	3278	34
4.	Liviu Chircu (@liviuchircu)	16	5	553	355
5.	Stefan Darius (@dariusstefan)	13	5	623	95
6.	Razvan Crainea (@razvancrainea)	10	7	68	114
7.	Henning Westerholt (@henningw)	5	3	51	60
8.	Ovidiu Sas (@ovidiusas)	4	2	18	17
9.	Vlad Paiu (@vladpaiu)	3	1	4	1
10.	Sergio Gutierrez	3	1	4	2

All remaining contributors: Paul Wise, Rudy Pedraza, UnixDev, Juha Heinanen (@juha-h).

(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)

(2) including any documentation-related commits, excluding merge commits

(3) ignoring whitespace edits, renamed files and auto-generated files

By Commit Activity

#	Name	Commit Activity
1.	Razvan Crainea (@razvancrainea)	Dec 2010 - Jul 2026
2.	Bogdan-Andrei Iancu (@bogdan-iancu)	Jun 2008 - Jul 2026
3.	Stefan Darius (@dariusstefan)	Jun 2026 - Jul 2026
4.	Liviu Chircu (@liviuchircu)	Jul 2012 - Aug 2014
5.	Vlad Paiu (@vladpaiu)	Dec 2013 - Dec 2013
6.	Ovidiu Sas (@ovidiusas)	Sep 2008 - Jan 2013
7.	Rudy Pedraza	Mar 2012 - Mar 2012
8.	Sergio Gutierrez	Dec 2010 - Dec 2010
9.	Paul Wise	Sep 2010 - Sep 2010
10.	Anca Vamanu	Jun 2008 - Jun 2010

All remaining contributors: Andrei Dragus, UnixDev, Juha Heinanen (@juha-h), Henning Westerholt (@henningw).

(1) including any documentation-related commits, excluding merge commits

Documentation

Contributors

Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Andrei Dragus, Anca Vamanu.

License

All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0