$Revision: 1821 $
$Date: 2007-03-12 00:27:26 +0200 (Mon, 12 Mar 2007) $
User's Guide
Overview
This module provides on-server speed dial facilities. An user can store
records consisting of pairs short numbers (2 digits) and SIP addresses
into a table of OpenSER. Then it can dial the two digits whenever it
wants to call the SIP address associated with them.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
database module (mysql, dbtext, ...).
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>db_url</varname> (string)
The URL of database where the table containing speed dial records.
Default value is DEFAULT_RODB_URL.
Set <varname>db_url</varname> parameter
...
modparam("speeddial", "db_url", "mysql://openser:xxx@localhost/openser")
...
<varname>user_column</varname> (string)
The name of column storing the user name of the owner of the speed dial
record.
Default value is username
.
Set <varname>user_column</varname> parameter
...
modparam("speeddial", "user_column", "userid")
...
<varname>domain_column</varname> (string)
The name of column storing the domain of the owner of the speed dial
record.
Default value is domain
.
Set <varname>domain_column</varname> parameter
...
modparam("speeddial", "domain_column", "userdomain")
...
<varname>sd_user_column</varname> (string)
The name of the column storing the user part of the short dial address.
Default value is sd_username
.
Set <varname>sd_user_column</varname> parameter
...
modparam("speeddial", "sd_user_column", "short_user")
...
<varname>sd_domain_column</varname> (string)
The name of the column storing the domain of the short dial address.
Default value is sd_domain
.
Set <varname>sd_domain_column</varname> parameter
...
modparam("speeddial", "sd_domain_column", "short_domain")
...
<varname>new_uri_column</varname> (string)
The name of the column containing the URI that will be use to replace
the short dial URI.
Default value is new_uri
.
Set <varname>new_uri_column</varname> parameter
...
modparam("speeddial", "new_uri_column", "real_uri")
...
<varname>domain_prefix</varname> (string)
If the domain of the owner (From URI) starts with the value of this parameter, then
it is stripped before performing the lookup of the short number.
Default value is NULL.
Set <varname>domain_prefix</varname> parameter
...
modparam("speeddial", "domain_prefix", "tel.")
...
<varname>use_domain</varname> (int)
The parameter specifies wheter or not to use the domain when searching a
speed dial record (0 - no domain, 1 - use domain from From URI,
2 - use both domains, from From URI and from request URI).
Default value is 0.
Set <varname>use_domain</varname> parameter
...
modparam("speeddial", "use_domain", 1)
...
Exported Functions
<function moreinfo="none">sd_lookup(table [, owner])</function>
The function lookups the short dial number from R-URI in 'table' and replaces the R-URI with associated address.
Meaning of the parameters is as follows:
table - The name of the table storing the
speed dial records.
owner - The SIP URI of the owner of
short dialing codes. If not pressent, URI of From header is used.
This function can be used from REQUEST_ROUTE.
<function>sd_lookup</function> usage
...
# 'speed_dial' is the default table name created by openser db script
if(uri=~"sip:[0-9]{2}@.*")
sd_lookup("speed_dial");
# use auth username
if(uri=~"sip:[0-9]{2}@.*")
sd_lookup("speed_dial", "sip:$au@$fd");
...
Installation & Running
&ser; config file
Next picture displays a sample usage of speeddial.
&ser; config script - sample speeddial usage
...
&speeddialcfg;
...