Forgot your password?

Frequently Asked Questions

Busy Lamp Field (BLF) feature on Kamailio 5.0.1 with Zoiper

PUA DialogInfo (BLF) config file:

#!KAMAILIO
#
# Kamailio (OpenSER) SIP Server v4.1 - default configuration script
#     - web: http://www.kamailio.org
#     - git: http://sip-router.org
#
# Direct your questions about this file to: <sr-users@lists.sip-router.org>
#
# Refer to the Core CookBook at http://www.kamailio.org/wiki/
# for an explanation of possible statements, functions and parameters.
#
# Several features can be enabled using '#!define WITH_FEATURE' directives:
#
# *** To run in debug mode:
#     - define WITH_DEBUG
#
# *** To enable mysql:
#     - define WITH_MYSQL
#
# *** To enable authentication execute:
#     - enable mysql
#     - define WITH_AUTH
#     - add users using 'kamctl'
#
# *** To enable IP authentication execute:
#     - enable mysql
#     - enable authentication
#     - define WITH_IPAUTH
#     - add IP addresses with group id '1' to 'address' table
#
# *** To enable persistent user location execute:
#     - enable mysql
#     - define WITH_USRLOCDB
#
# *** To enable presence server execute:
#     - enable mysql
#     - define WITH_PRESENCE
#
# *** To enable nat traversal execute:
#     - define WITH_NAT
#     - install RTPProxy: http://www.rtpproxy.org
#     - start RTPProxy:
#        rtpproxy -l _your_public_ip_ -s udp:localhost:7722
#
# *** To enable PSTN gateway routing execute:
#     - define WITH_PSTN
#     - set the value of pstn.gw_ip
#     - check route[PSTN] for regexp routing condition
#
# *** To enable database aliases lookup execute:
#     - enable mysql
#     - define WITH_ALIASDB
#
# *** To enable speed dial lookup execute:
#     - enable mysql
#     - define WITH_SPEEDDIAL
#
# *** To enable multi-domain support execute:
#     - enable mysql
#     - define WITH_MULTIDOMAIN
#
# *** To enable TLS support execute:
#     - adjust CFGDIR/tls.cfg as needed
#     - define WITH_TLS
#
# *** To enable XMLRPC support execute:
#     - define WITH_XMLRPC
#     - adjust route[XMLRPC] for access policy
#
# *** To enable anti-flood detection execute:
#     - adjust pike and htable=>ipban settings as needed (default is
#       block if more than 16 requests in 2 seconds and ban for 300 seconds)
#     - define WITH_ANTIFLOOD
#
# *** To block 3XX redirect replies execute:
#     - define WITH_BLOCK3XX
#
# *** To enable VoiceMail routing execute:
#     - define WITH_VOICEMAIL
#     - set the value of voicemail.srv_ip
#     - adjust the value of voicemail.srv_port
#
# *** To enhance accounting execute:
#     - enable mysql
#     - define WITH_ACCDB
#     - add following columns to database
#!ifdef ACCDB_COMMENT
  ALTER TABLE acc ADD COLUMN src_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN src_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN src_ip varchar(64) NOT NULL default '';
  ALTER TABLE acc ADD COLUMN dst_ouser VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN dst_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE acc ADD COLUMN dst_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_domain VARCHAR(128) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN src_ip varchar(64) NOT NULL default '';
  ALTER TABLE missed_calls ADD COLUMN dst_ouser VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN dst_user VARCHAR(64) NOT NULL DEFAULT '';
  ALTER TABLE missed_calls ADD COLUMN dst_domain VARCHAR(128) NOT NULL DEFAULT '';
#!endif

####### Include Local Config If Exists #########
import_file "kamailio-local.cfg"

####### Defined Values #########
#!define WITH_MYSQL
#!define WITH_MULTIDOMAIN
#!define WITH_AUTH
##!define WITH_MSRP
#!define WITH_TLS
##!define WITH_MSILO
#!define WITH_USRLOCDB
#!define WITH_PRESENCE
##!define WITH_XCAPSRV

# *** Value defines - IDs used later in config
#!ifdef WITH_MYSQL
# - database URL - used to connect to database server by modules such
#       as: auth_db, acc, usrloc, a.s.o.
#!ifndef DBURL
#!define DBURL "mysql://kamailio:kamailiorw@localhost/kamailio"
#!endif
#!endif
#!ifdef WITH_MULTIDOMAIN
# - the value for 'use_domain' parameters
#!define MULTIDOMAIN 1
#!else
#!define MULTIDOMAIN 0
#!endif

# - flags
#   FLT_ - per transaction (message) flags
#       FLB_ - per branch flags
#!define FLT_ACC 1
#!define FLT_ACCMISSED 2
#!define FLT_ACCFAILED 3
#!define FLT_NATS 5
#!define FLT_DLG 9
#!define FLT_DLGINFO 10

#!define FLB_NATB 6
#!define FLB_NATSIPPING 7

#!substdef "!MY_IP_ADDR!10.7.2.22!g"
#!substdef "!MY_DOMAIN!asterisk117.securax.net!g"
#!substdef "!MY_MSRP_PORT!2855!g"
#!substdef "!MY_MSRP_ADDR!tcp:MY_IP_ADDR:MY_MSRP_PORT!g"
#!substdef "!MSRP_MIN_EXPIRES!1800!g"
#!substdef "!MSRP_MAX_EXPIRES!3600!g"

####### Global Parameters #########

### LOG Levels: 3=DBG, 2=INFO, 1=NOTICE, 0=WARN, -1=ERR
#!ifdef WITH_DEBUG
debug=2
log_stderror=yes
#!else
debug=2
log_stderror=no
loadmodule "debugger.so" 
modparam("debugger", "cfgtrace", 1)
#!endif

memdbg=5
memlog=5

log_facility=LOG_LOCAL0

fork=yes
children=4

/* uncomment the next line to disable TCP (default on) */
#disable_tcp=yes

/* uncomment the next line to disable the auto discovery of local aliases
   based on reverse DNS on IPs (default on) */
#auto_aliases=no

/* add local domain aliases */
alias="asterisk117.securax.net"

/* uncomment and configure the following line if you want Kamailio to
   bind on a specific interface/port/proto (default bind on all available) */
listen=udp:10.7.2.22:6060
listen=tcp:10.7.2.22:6060
listen=udp:10.7.2.22:5060
listen=tcp:10.7.2.22:5060
#listen=udp:[fd00::baba]:6060
#listen=udp:[2001:67c:2e90:10::99]:6060
#listen=tcp:[fe80::20c:29ff:fe5a:b3be]:6060

/* port to listen to
 * - can be specified more than once if needed to listen on many ports */
port=6060

#!ifdef WITH_TLS
enable_tls=yes
listen=tls:10.7.2.22:6061
listen=tls:10.7.2.22:5061
#listen=tls:[fe80::20c:29ff:fe5a:b3be]:6061
#!endif

# life time of TCP connection when there is no traffic
# - a bit higher than registration expires to cope with UA behind NAT
tcp_connection_lifetime=3605

#!ifdef WITH_MSRP
listen=MY_MSRP_ADDR
#!endif

#!ifdef WITH_XCAPSRV
tcp_accept_no_cl=yes
#!endif

####### Custom Parameters #########

# These parameters can be modified runtime via RPC interface
# - see the documentation of 'cfg_rpc' module.
#
# Format: group.id = value 'desc' description
# Access: $sel(cfg_get.group.id) or @cfg_get.group.id
#

#!ifdef WITH_PSTN
# PSTN GW Routing
#
# - pstn.gw_ip: valid IP or hostname as string value, example:
# pstn.gw_ip = "10.0.0.101" desc "My PSTN GW Address"
#
# - by default is empty to avoid misrouting
pstn.gw_ip = "" desc "PSTN GW Address"
pstn.gw_port = "" desc "PSTN GW Port"
#!endif

#!ifdef WITH_VOICEMAIL
# VoiceMail Routing on offline, busy or no answer
#
# - by default Voicemail server IP is empty to avoid misrouting
voicemail.srv_ip = "" desc "VoiceMail IP Address"
voicemail.srv_port = "5060" desc "VoiceMail Port"
#!endif

####### Modules Section ########

# set paths to location of modules (to sources or installation folders)
#!ifdef WITH_SRCPATH
mpath="modules/"
#!else
mpath="/usr/local/kamailio/lib64/kamailio/modules"
#!endif

#!ifdef WITH_MYSQL
loadmodule "db_mysql.so"
#!endif

loadmodule "jsonrpcs.so"
loadmodule "kex.so"
loadmodule "corex.so"
loadmodule "tm.so"
loadmodule "tmx.so"
loadmodule "sl.so"
loadmodule "rr.so"
loadmodule "pv.so"
loadmodule "maxfwd.so"
loadmodule "usrloc.so"
loadmodule "registrar.so"
loadmodule "textops.so"
loadmodule "siputils.so"
loadmodule "xlog.so"
loadmodule "sanity.so"
loadmodule "ctl.so"
loadmodule "cfg_rpc.so"
loadmodule "acc.so"
loadmodule "stun.so"
loadmodule "dialog.so"

#!ifdef WITH_AUTH
loadmodule "auth.so"
loadmodule "auth_db.so"
#!ifdef WITH_IPAUTH
loadmodule "permissions.so"
#!endif
#!endif

#!ifdef WITH_ALIASDB
loadmodule "alias_db.so"
#!endif

#!ifdef WITH_SPEEDDIAL
loadmodule "speeddial.so"
#!endif

#!ifdef WITH_MULTIDOMAIN
loadmodule "domain.so"
#!endif

#!ifdef WITH_PRESENCE
loadmodule "presence.so"
loadmodule "presence_xml.so"
loadmodule "presence_dialoginfo"
loadmodule "pua.so"
loadmodule "pua_dialoginfo.so"
#!endif

loadmodule "nathelper.so"
#!ifdef WITH_NAT
loadmodule "rtpproxy.so"
#!endif

#!ifdef WITH_TLS
loadmodule "tls.so"
#!endif

#!ifdef WITH_ANTIFLOOD
loadmodule "htable.so"
loadmodule "pike.so"
#!endif

#!ifdef WITH_XMLRPC
loadmodule "xmlrpc.so"
#!endif

#!ifdef WITH_DEBUG
loadmodule "debugger.so"
#!endif

#!ifdef WITH_MSRP
loadmodule "msrp.so"
loadmodule "htable.so"
loadmodule "cfgutils.so"
#!endif

#!ifdef WITH_XCAPSRV
loadmodule "xhttp.so"
loadmodule "xcap_server.so"
#!endif

#!ifdef WITH_MSILO
loadmodule "msilo.so"
#!endif

# ----------------- setting module-specific parameters ---------------

# ----- tm params -----
# auto-discard branches from previous serial forking leg
modparam("tm", "failure_reply_mode", 3)
# default retransmission timeout: 30sec
modparam("tm", "fr_timer", 30000)
# default invite retransmission timeout after 1xx: 120sec
modparam("tm", "fr_inv_timer", 120000)

# ----- jsonrpcs params -----
modparam("jsonrpcs", "pretty_format", 1)
/* set the path to RPC fifo control file */
modparam("jsonrpcs", "fifo_name", "/var/run/kamailio/kamailio_rpc.fifo")
/* set the path to RPC unix socket control file */
modparam("jsonrpcs", "dgram_socket", "/var/run/kamailio/kamailio_rpc.sock")


# ----- rr params -----
# add value to ;lr param to cope with most of the UAs
modparam("rr", "enable_full_lr", 1)
# do not append from tag to the RR (no need for this script)
modparam("rr", "append_fromtag", 0)


# ----- registrar params -----
modparam("registrar", "method_filtering", 1)
/* uncomment the next line to disable parallel forking via location */
# modparam("registrar", "append_branches", 0)
/* uncomment the next line not to allow more than 10 contacts per AOR */
#modparam("registrar", "max_contacts", 10)
# max value for expires of registrations
modparam("registrar", "max_expires", 3600)
# set it to 1 to enable GRUU
modparam("registrar", "gruu_enabled", 0)

# -- msilo params --
#!ifdef WITH_MSILO
modparam("msilo","db_url","mysql://kamailio:kamailiorw@localhost/kamailio")
modparam("msilo","from_address","sip:$rU@10.7.2.22")
modparam("msilo","contact_hdr","Contact: $rU@10.7.2.22:$rp;msilo=yes\r\n")
modparam("msilo","content_type_hdr","Content-Type: text/plain\r\n")
#modparam("msilo","offline_message","*** User $rU is offline!")
#!endif

# ----- acc params -----
/* what special events should be accounted ? */
modparam("acc", "early_media", 0)
modparam("acc", "report_ack", 0)
modparam("acc", "report_cancels", 0)
/* by default ww do not adjust the direct of the sequential requests.
   if you enable this parameter, be sure the enable "append_fromtag"
   in "rr" module */
modparam("acc", "detect_direction", 0)
/* account triggers (flags) */
modparam("acc", "log_flag", FLT_ACC)
modparam("acc", "log_missed_flag", FLT_ACCMISSED)
modparam("acc", "log_extra",
        "src_user=$fU;src_domain=$fd;src_ip=$si;"
        "dst_ouser=$tU;dst_user=$rU;dst_domain=$rd")
modparam("acc", "failed_transaction_flag", FLT_ACCFAILED)
/* enhanced DB accounting */
#!ifdef WITH_ACCDB
modparam("acc", "db_flag", FLT_ACC)
modparam("acc", "db_missed_flag", FLT_ACCMISSED)
modparam("acc", "db_url", DBURL)
modparam("acc", "db_extra",
        "src_user=$fU;src_domain=$fd;src_ip=$si;"
        "dst_ouser=$tU;dst_user=$rU;dst_domain=$rd")
#!endif


# ----- usrloc params -----
/* enable DB persistency for location entries */
#!ifdef WITH_USRLOCDB
modparam("usrloc", "db_url", DBURL)
modparam("usrloc", "db_mode", 2)
modparam("usrloc", "use_domain", MULTIDOMAIN)
#!endif


# ----- auth_db params -----
#!ifdef WITH_AUTH
modparam("auth_db", "db_url", DBURL)
modparam("auth_db", "calculate_ha1", 0)
#modparam("auth_db", "password_column", "password")
modparam("auth_db", "password_column", "ha1")
modparam("auth_db", "load_credentials", "")
modparam("auth_db", "use_domain", MULTIDOMAIN)
#modparam("auth_db", "use_domain", 1)
modparam("auth", "nonce_count", 1) # enable nonce_count support
modparam("auth", "qop", "auth")    # enable qop=auth
modparam("auth", "algorithm", "MD5")

# ----- permissions params -----
#!ifdef WITH_IPAUTH
modparam("permissions", "db_url", DBURL)
modparam("permissions", "db_mode", 1)
#!endif

#!endif


# ----- alias_db params -----
#!ifdef WITH_ALIASDB
modparam("alias_db", "db_url", DBURL)
modparam("alias_db", "use_domain", MULTIDOMAIN)
#!endif


# ----- speeddial params -----
#!ifdef WITH_SPEEDDIAL
modparam("speeddial", "db_url", DBURL)
modparam("speeddial", "use_domain", MULTIDOMAIN)
#!endif


# ----- domain params -----
#!ifdef WITH_MULTIDOMAIN
modparam("domain", "db_url", DBURL)
# register callback to match myself condition with domains list
modparam("domain", "register_myself", 0)
#!endif

#!ifdef WITH_XCAPSRV
# ----- xcap_server params -----
modparam("xcap_server", "db_url", DBURL)
#!endif

#!ifdef WITH_PRESENCE
# ----- presence params -----
modparam("presence", "db_url", DBURL)
modparam("presence", "db_update_period", 20)
modparam("presence", "server_address", "sip:10.7.2.22:5060")
modparam("presence", "send_fast_notify", 0)
modparam("presence", "db_update_period", 20)
modparam("presence", "clean_period", 40)
modparam("presence", "subs_db_mode", 2)
modparam("presence", "fetch_rows", 1000)


# ----- presence_xml params -----
modparam("presence_xml", "db_url", DBURL)
modparam("presence_xml", "force_active", 1)

# ----- presence_dialoginfo params -----
modparam("presence_dialoginfo", "force_single_dialog", 0)

# ----- pua params -----
modparam("pua", "db_url", DBURL)
modparam("pua", "db_mode", 2)
modparam("pua", "update_period", 60)
modparam("pua", "dlginfo_increase_version", 0)
modparam("pua", "reginfo_increase_version", 0)
modparam("pua", "check_remote_contact", 1)
modparam("pua", "fetch_rows", 1000)

# ----- pua_dialoginfo params -----
modparam("pua_dialoginfo", "include_callid", 1)
modparam("pua_dialoginfo", "send_publish_flag", FLT_DLGINFO)
modparam("pua_dialoginfo", "caller_confirmed", 0)
modparam("pua_dialoginfo", "include_tags", 1)
modparam("pua_dialoginfo", "override_lifetime", 124)
#!endif

# ----- dialog params -----
modparam("dialog", "db_url", DBURL)
modparam("dialog", "enable_stats", 1)
modparam("dialog", "db_mode", 1)
modparam("dialog", "dlg_flag", FLT_DLG)

#!ifdef WITH_NAT
# ----- rtpproxy params -----
modparam("rtpproxy", "rtpproxy_sock", "udp:127.0.0.1:7722")

# ----- nathelper params -----
modparam("nathelper", "natping_interval", 30)
modparam("nathelper", "ping_nated_only", 1)
modparam("nathelper", "sipping_bflag", FLB_NATSIPPING)
modparam("nathelper", "sipping_from", "sip:pinger@kamailio.org")

# params needed for NAT traversal in other modules
modparam("nathelper|registrar", "received_avp", "$avp(RECEIVED)")
modparam("usrloc", "nat_bflag", FLB_NATB)
#!endif


#!ifdef WITH_TLS
# ----- tls params -----
modparam("tls", "config", "/usr/local/kamailio/etc/kamailio/tls.cfg")
#!endif

#!ifdef WITH_ANTIFLOOD
# ----- pike params -----
modparam("pike", "sampling_time_unit", 2)
modparam("pike", "reqs_density_per_unit", 16)
modparam("pike", "remove_latency", 4)

# ----- htable params -----
# ip ban htable with autoexpire after 5 minutes
modparam("htable", "htable", "ipban=>size=8;autoexpire=300;")
#!endif

#!ifdef WITH_XMLRPC
# ----- xmlrpc params -----
modparam("xmlrpc", "route", "XMLRPC");
modparam("xmlrpc", "url_match", "^/RPC")
#!endif

#!ifdef WITH_DEBUG
# ----- debugger params -----
modparam("debugger", "cfgtrace", 1)
#!endif

#!ifdef WITH_MSRP
# ----- htable params -----
modparam("htable", "htable", "msrp=>size=8;autoexpire=MSRP_MAX_EXPIRES;")
#!endif


####### Routing Logic ########


# Main SIP request routing logic
# - processing of any incoming SIP request starts with this route
# - note: this is the same as route { ... }
request_route {

        # per request initial checks
        route(REQINIT);

        # NAT detection
        route(NATDETECT);

        # CANCEL processing
        if (is_method("CANCEL"))
        {
                if (t_check_trans()) {
                        route(RELAY);
                }
                exit;
        }

        # handle requests within SIP dialogs
        route(WITHINDLG);

        #### milliwatt
        if (method=="INVITE" && uri=~"sip:(14|701)@.*") 
        {

        xlog("L_INFO", "CALL: Call to check milliwatt\n");
        rewritehostport("10.2.1.99:5062");
        route(RELAY);
        record_route();
        exit;
        }

        #### milliwatt
        if (method=="INVITE" && uri=~"sip:(wait)@.*")
        {
        
        xlog("L_INFO", "CALL: Call to check milliwatt\n");
        rewritehostport("185.117.83.44:6060");
        route(RELAY);
        record_route();
        exit;
        }


        ### only initial requests (no To tag)

        t_check_trans();

        # authentication
        route(AUTH);

        # record routing for dialog forming requests (in case they are routed)
        # - remove preloaded route headers
        remove_hf("Route");
        if (is_method("INVITE|SUBSCRIBE"))
                record_route();

        # account only INVITEs
        if (is_method("INVITE"))
        {
                setflag(FLT_ACC); # do accounting
        }

        # dispatch requests to foreign domains
        route(SIPOUT);

        ### requests for my local domains

        # Fake Error Generator
        route(FAKEERROR);

        # Sylkserver
        route(SYLKSERVERPRE);

        # handle presence related requests
        route(PRESENCE);

        # handle registrations
        route(REGISTRAR);

        # handle push hax tests
        route(PUSHTEST);

        if ($rU==$null)
        {
                # request with no Username in RURI
                sl_send_reply("484","Address Incomplete");
                exit;
        }

        # Sylkserver
        route(SYLKSERVERPOST);

        # dispatch destinations to PSTN
        route(PSTN);

        # user location service
        route(LOCATION);

}


route[RELAY] {

        # enable additional event routes for forwarded requests
        # - serial forking, RTP relaying handling, a.s.o.
        if (is_method("INVITE|BYE|SUBSCRIBE|UPDATE")) {
                if(!t_is_set("branch_route")) t_on_branch("MANAGE_BRANCH");
        }
        if (is_method("INVITE|SUBSCRIBE|UPDATE")) {
                if(!t_is_set("onreply_route")) t_on_reply("MANAGE_REPLY");
        }
        if (is_method("INVITE")) {
                if(!t_is_set("failure_route")) t_on_failure("MANAGE_FAILURE");
        }

        if(is_method("INVITE|BYE|UPDATE|CANCEL|ACK")) {
                setflag(FLT_DLGINFO);
                dlg_manage();
        }


        if (!t_relay()) {
                sl_reply_error();
        }
        exit;
}

# Per SIP request initial checks
route[REQINIT] {
#!ifdef WITH_ANTIFLOOD
        # flood dection from same IP and traffic ban for a while
        # be sure you exclude checking trusted peers, such as pstn gateways
        # - local host excluded (e.g., loop to self)
        if(src_ip!=myself)
        {
                if($sht(ipban=>$si)!=$null)
                {
                        # ip is already blocked
                        xdbg("request from blocked IP - $rm from $fu (IP:$si:$sp)\n");
                        exit;
                }
                if (!pike_check_req())
                {
                        xlog("L_ALERT","ALERT: pike blocking $rm from $fu (IP:$si:$sp)\n");
                        $sht(ipban=>$si) = 1;
                        exit;
                }
        }
#!endif

        if (!mf_process_maxfwd_header("10")) {
                sl_send_reply("483","Too Many Hops");
                exit;
        }

        if(!sanity_check("1511", "7"))
        {
                xlog("Malformed SIP message from $si:$sp\n");
                exit;
        }
        
}

# Handle requests within SIP dialogs
route[WITHINDLG] {
        if (has_totag()) {
                # sequential request withing a dialog should
                # take the path determined by record-routing
                if (loose_route()) {
                        route(DLGURI);
                        if (is_method("BYE")) {
                                setflag(FLT_ACC); # do accounting ...
                                setflag(FLT_ACCFAILED); # ... even if the transaction fails
                        }
                        else if ( is_method("ACK") ) {
                                # ACK is forwarded statelessy
                                route(NATMANAGE);
                        }
                        else if ( is_method("NOTIFY") ) {
                                # Add Record-Route for in-dialog NOTIFY as per RFC 6665.
                                record_route();
                        }
                        route(RELAY);
                } else {
                        if (is_method("SUBSCRIBE") && uri == myself) {
                                # in-dialog subscribe requests
                                route(PRESENCE);
                                exit;
                        }
                        if ( is_method("ACK") ) {
                                if ( t_check_trans() ) {
                                        # no loose-route, but stateful ACK;
                                        # must be an ACK after a 487
                                        # or e.g. 404 from upstream server
                                        route(RELAY);
                                        exit;
                                } else {
                                        # ACK without matching transaction ... ignore and discard
                                        exit;
                                }
                        }
                        sl_send_reply("404","Not here");
                }
                exit;
        }
}

# Handle SIP registrations
route[REGISTRAR] {
        if (is_method("REGISTER"))
        {
                if(isflagset(FLT_NATS))
                {
                        setbflag(FLB_NATB);
                        # uncomment next line to do SIP NAT pinging
                        ## setbflag(FLB_NATSIPPING);
                }
                if (!save("location"))
                        sl_reply_error();

#!ifdef WITH_MSILO
                m_dump();
#!endif

                exit;
        }
}

route[PUSHTEST] {
        if (is_method("NOTIFY"))
        {
                if ($rU==$null)
                {
                        if ($hdr(Event)=="push" || $hdr(Event)=="tokenreq")
                        {
                                sl_send_reply("200", "OK");
                                exit;
                        }
                }
        }
}

# USER location service
route[LOCATION] {

#!ifdef WITH_SPEEDDIAL
        # search for short dialing - 2-digit extension
        if($rU=~"^[0-9][0-9]$")
                if(sd_lookup("speed_dial"))
                        route(SIPOUT);
#!endif

#!ifdef WITH_ALIASDB
        # search in DB-based aliases
        if(alias_db_lookup("dbaliases"))
                route(SIPOUT);
#!endif

#!ifdef WITH_MSILO
        if(is_method("MESSAGE")){
        route(MSILO);
        exit;
 }
#!endif

        $avp(oexten) = $rU;
        if (!lookup("location")) {
                $var(rc) = $rc;
                route(TOVOICEMAIL);
                t_newtran();
                switch ($var(rc)) {
                        case -1:
                        case -3:
                                send_reply("404", "Not Found");
                                exit;
                        case -2:
                                send_reply("405", "Method Not Allowed");
                                exit;
                }
        }

        # when routing via usrloc, log the missed calls also
        if (is_method("INVITE"))
        {
                setflag(FLT_ACCMISSED);
        }

        route(RELAY);
        exit;
}

# Presence server route
route[PRESENCE] {
        if(!is_method("PUBLISH|SUBSCRIBE"))
                return;

        if(is_method("SUBSCRIBE") && $hdr(Event)=="message-summary") {
                route(TOVOICEMAIL);
                # returns here if no voicemail server is configured
                sl_send_reply("404", "No voicemail service");
                exit;
        }

#!ifdef WITH_PRESENCE
        if (!t_newtran())
        {
                sl_reply_error();
                exit;
        }

        if(is_method("PUBLISH"))
        {
                handle_publish();
                t_release();
        } else if(is_method("SUBSCRIBE")) {
                handle_subscribe();
                t_release();
        }
        exit;
#!endif

        # if presence enabled, this part will not be executed
        if (is_method("PUBLISH") || $rU==$null)
        {
                sl_send_reply("404", "Not here");
                exit;
        }
        return;
}

# Authentication route
route[AUTH] {
#!ifdef WITH_AUTH

#!ifdef WITH_IPAUTH
        if((!is_method("REGISTER")) && allow_source_address())
        {
                # source IP allowed
                return;
        }
#!endif

#!ifdef WITH_MSILO
        if(is_method("MESSAGE")){
        return;
        }
#!endif

        if (is_method("REGISTER") && from_uri==myself)
        {
                # authenticate requests
                if (!auth_check("$fd", "subscriber", "1")) {
                        auth_challenge("$fd", "0");
                        exit;
                }
                # user authenticated - remove auth header
                if(!is_method("REGISTER|PUBLISH"))
                        consume_credentials();
        }
        # if caller is not local subscriber, then check if it calls
        # a local destination, otherwise deny, not an open relay here
        if (from_uri!=myself && uri!=myself)
        {
                sl_send_reply("403","Not relaying");
                exit;
        }

#!endif
        return;
}

# Caller NAT detection route
route[NATDETECT] {
#!ifdef WITH_NAT
        force_rport();
        if (nat_uac_test("19")) {
                if (is_method("REGISTER")) {
                        fix_nated_register();
                } else {
                        if(is_first_hop())
                                set_contact_alias();
                }
                setflag(FLT_NATS);
        }
#!endif
        return;
}

# RTPProxy control
route[NATMANAGE] {
#!ifdef WITH_NAT
        if (is_request()) {
                if(has_totag()) {
                        if(check_route_param("nat=yes")) {
                                setbflag(FLB_NATB);
                        }
                }
        }
        if (!(isflagset(FLT_NATS) || isbflagset(FLB_NATB)))
                return;

        rtpproxy_manage("co");

        if (is_request()) {
                if (!has_totag()) {
                        if(t_is_branch_route()) {
                                add_rr_param(";nat=yes");
                        }
                }
        }
        if (is_reply()) {
                if(isbflagset(FLB_NATB)) {
                        if(is_first_hop())
                                set_contact_alias();
                }
        }
#!endif
        return;
}

# URI update for dialog requests
route[DLGURI] {
#!ifdef WITH_NAT
        if(!isdsturiset()) {
                handle_ruri_alias();
        }
#!endif
        return;
}

# Routing to foreign domains
route[SIPOUT] {
        if (!uri==myself)
        {
                append_hf("P-hint: outbound\r\n");
                route(RELAY);
        }
}

# PSTN GW routing
route[PSTN] {
#!ifdef WITH_PSTN
        # check if PSTN GW IP is defined
        if (strempty($sel(cfg_get.pstn.gw_ip))) {
                xlog("SCRIPT: PSTN rotuing enabled but pstn.gw_ip not defined\n");
                return;
        }

        # route to PSTN dialed numbers starting with '+' or '00'
        #     (international format)
        # - update the condition to match your dialing rules for PSTN routing
        if(!($rU=~"^(\+|00)[1-9][0-9]{3,20}$"))
                return;

        # only local users allowed to call
        if(from_uri!=myself) {
                sl_send_reply("403", "Not Allowed");
                exit;
        }

        if (strempty($sel(cfg_get.pstn.gw_port))) {
                $ru = "sip:" + $rU + "@" + $sel(cfg_get.pstn.gw_ip);
        } else {
                $ru = "sip:" + $rU + "@" + $sel(cfg_get.pstn.gw_ip) + ":"
                                        + $sel(cfg_get.pstn.gw_port);
        }

        route(RELAY);
        exit;
#!endif

        return;
}

# XMLRPC routing
#!ifdef WITH_XMLRPC
route[XMLRPC] {
        # allow XMLRPC from localhost
        if ((method=="POST" || method=="GET")
                        && (src_ip==127.0.0.1)) {
                # close connection only for xmlrpclib user agents (there is a bug in
                # xmlrpclib: it waits for EOF before interpreting the response).
                if ($hdr(User-Agent) =~ "xmlrpclib")
                        set_reply_close();
                set_reply_no_connect();
                dispatch_rpc();
                exit;
        }
        send_reply("403", "Forbidden");
        exit;
}
#!endif

# route to voicemail server
route[TOVOICEMAIL] {
#!ifdef WITH_VOICEMAIL
        if(!is_method("INVITE|SUBSCRIBE"))
                return;

        # check if VoiceMail server IP is defined
        if (strempty($sel(cfg_get.voicemail.srv_ip))) {
                xlog("SCRIPT: VoiceMail rotuing enabled but IP not defined\n");
                return;
        }
        if(is_method("INVITE")) {
                if($avp(oexten)==$null)
                        return;
                $ru = "sip:" + $avp(oexten) + "@" + $sel(cfg_get.voicemail.srv_ip)
                                + ":" + $sel(cfg_get.voicemail.srv_port);
        } else {
                if($rU==$null)
                        return;
                $ru = "sip:" + $rU + "@" + $sel(cfg_get.voicemail.srv_ip)
                                + ":" + $sel(cfg_get.voicemail.srv_port);
        }
        route(RELAY);
        exit;
#!endif

        return;
}

# Sylkserver routing, pre-registration hook
route[SYLKSERVERPRE] {
#!ifdef WITH_SYLKSERVER
        xlog("L_DBG", "SYLK: PRE");
        if($rU=~"^room[0-9]([0-9])*$")
        {
                xlog("L_DBG", "SYLK: room signature");
                if(is_method("REGISTER")) {
                        xlog("L_INFO", "SYLK: rejecting register attempt for room");
                        t_reply("403","Room extensions are reserved for conferencing");
                        exit;
                }
        }
#!endif
return;
}

# Fake Error generator for targets of the form error[3-9][0-9][0-9]
route[FAKEERROR] {
#!ifdef WITH_FAKEERROR
        xlog("L_DBG", "Fake Error");
        if($tU=~"^error[3-9][0-9][0-9]$")
        {
                $var(faker) = $(tU{s.substr,5,0});
                $var(fakerstr) = "Kypo Mypo " + $var(faker);
                xlog("L_DBG", "Fake error for $tU -> $var(faker) $var(fakerstr)");
                sl_send_reply("$(var(faker){s.int})", "$var(fakerstr)");
                exit;
        }
#!endif
return;
}

# Sylkserver routing, post-registration hook
route[SYLKSERVERPOST] {
#!ifdef WITH_SYLKSERVER
        xlog("L_DBG", "SYLK: POST");
        if($rU=~"^room[0-9]([0-9])*$")
        {
                xlog("L_INFO", "SYLK: Relaying to room");
                t_relay_to("tcp:10.7.2.22:8060");
                exit;
        }
#!endif
return;
}

# manage outgoing branches
branch_route[MANAGE_BRANCH] {
        xdbg("new branch [$T_branch_idx] to $ru\n");
        route(NATMANAGE);
}

# manage incoming replies
onreply_route[MANAGE_REPLY] {
        xdbg("incoming reply\n");
        if(status=~"[12][0-9][0-9]")
                route(NATMANAGE);
}

#!ifdef WITH_MSILO
#manage failure message
        failure_route[MANAGE_FAILURE_MESSAGE] {
        if (!method=="MESSAGE")
        {
        exit;
        }
    
        log(1,"MSILO:the downstream UA doesn't support MESSAGEs\n");
        # we have changed the R-URI with the contact address, ignore it now
        if (m_store("$ou"))
        {
            log("MSILO: offline message stored\n");
            t_reply("202", "Accepted"); 
        }else{
            log("MSILO: offline message NOT stored\n");
            t_reply("503", "Service Unavailable");
    }
}
#!endif

# manage failure routing cases
failure_route[MANAGE_FAILURE] {
        route(NATMANAGE);

        if (t_is_canceled()) {
                exit;
        }

#!ifdef WITH_BLOCK3XX
        # block call redirect based on 3xx replies.
        if (t_check_status("3[0-9][0-9]")) {
                t_reply("404","Not found");
                exit;
        }
#!endif

#!ifdef WITH_VOICEMAIL
        # serial forking
        # - route to voicemail on busy or no answer (timeout)
        if (t_check_status("486|408")) {
                $du = $null;
                route(TOVOICEMAIL);
                exit;
        }
#!endif
}

#!ifdef WITH_XCAPSRV

#!define WITH_XHTTPAUTH
event_route[xhttp:request] {
xdbg("===== xhttp: request [$rv] $rm => $hu\n");
##!ifdef WITH_XHTTPAUTH
#if (!www_authorize("xcap", "subscriber"))
#{
#www_challenge("xcap", "0");
#exit;
#}
##!endif
if($hu=~"^/xcap-root/")
{
set_reply_close();
set_reply_no_connect();
# xcap ops
$xcapuri(u=>data) = $hu;
if($xcapuri(u=>xuid)=~"^sip:.+@.+")
$var(uri) = $xcapuri(u=>xuid);
else if($xcapuri(u=>xuid)=~".+@.+")
$var(uri) = "sip:" + $xcapuri(u=>xuid);
else
$var(uri) = "sip:"+ $xcapuri(u=>xuid) + "@" + $Ri;
xlog("===== xhttp: $xcapuri(u=>auid) : $xcapuri(u=>xuid)\n");
if($xcapuri(u=>auid)=="xcap-caps")
{
$var(xbody) =
"<?xml version='1.0' encoding='UTF-8'?> <xcap-caps xmlns='urn:ietf:params:xml:ns:xcap-caps'>   <auids>     <auid>rls-services</auid>     <auid>pidf-manipulation</auid>     <auid>xcap-caps</auid>     <auid>resource-lists</auid>     <auid>pres-rules</auid>     <auid>org.openmobilealliance.pres-rules</auid>   </auids>   <extensions>   </extensions>   <namespaces>     <namespace>urn:ietf:params:xml:ns:rls-services</namespace>     <namespace>urn:ietf:params:xml:ns:pidf</namespace>     <namespace>urn:ietf:params:xml:ns:xcap-caps</namespace>     <namespace>urn:ietf:params:xml:ns:resource-lists</namespace>     <namespace>urn:ietf:params:xml:ns:pres-rules</namespace>   </namespaces> </xcap-caps>";
xhttp_reply("200", "ok", "application/xcap-caps+xml",
"$var(xbody)");
exit;
}
#!ifdef WITH_XHTTPAUTH
        # be sure auth user access only its documents
        if ($au!=$(var(uri){uri.user})) {
            xhttp_reply("403", "Forbidden", "text/html",
                    "<html><body>$si:$sp</body></html>");
            exit;
        }

#!endif
switch($rm) {
case "PUT":
xcaps_put("$var(uri)", "$hu", "$rb");
if($xcapuri(u=>auid)=~"pres-rules")
{
xlog("===== xhttp put: refreshing watchers for $var(uri)\n");
pres_update_watchers("$var(uri)", "presence");
pres_refresh_watchers("$var(uri)", "presence", 1);
}
exit;
break;
case "GET":
xlog("===== xhttp: get $var(uri) => $hu\n");
xcaps_get("$var(uri)", "$hu");
exit;
break;
case "DELETE":
xcaps_del("$var(uri)", "$hu");
if($xcapuri(u=>auid)=~"pres-rules")
{
xlog("===== xhttp del: refreshing watchers for $var(uri)\n");
pres_update_watchers("$var(uri)", "presence");
pres_refresh_watchers("$var(uri)", "presence", 1);
}
exit;
break;
}
}

# http ops
xhttp_reply("200", "ok", "text/html",
"<html><body>OK: $si:$sp</body></html>");
exit;
}
#!endif


#!ifdef WITH_MSRP
event_route[msrp:frame-in] {
        xdbg("============#[[$msrp(method)]]===========\n");
        xdbg("============*[[$si:$sp]]\n");
        xdbg("============ crthop:   [$msrp(crthop)]\n");
        xdbg("============ prevhop:  [$msrp(prevhop)]\n");
        xdbg("============ nexthop:  [$msrp(nexthop)]\n");
        xdbg("============ firsthop: [$msrp(firsthop)]\n");
        xdbg("============ lasthop:  [$msrp(lasthop)]\n");
        xdbg("============ prevhops: [$msrp(prevhops)]\n");
        xdbg("============ nexthops: [$msrp(nexthops)]\n");
        xdbg("============ srcaddr:  [$msrp(srcaddr)]\n");
        xdbg("============ srcsock:  [$msrp(srcsock)]\n");
        xdbg("============ sessid:   [$msrp(sessid)]\n");

        msrp_reply_flags("1");

        if(msrp_is_reply())
        {
                msrp_relay();
        }
        else if($msrp(method)=="AUTH")
        {
                if($msrp(nexthops)>0)
                {
                        msrp_relay();
                        exit;
                }
        
                # frame for local server - send Use-Path
                # -- passwd can be loaded from DB based on $au
                #$var(passwd) = "123";
                $var(msrprealm) = $(hdr(To-Path){msrpuri.host});
                xlog("L_ALERT","============ msrprealm:       [$var(msrprealm)]\n");
                if (!www_authenticate("$var(msrprealm)", "subscriber", "$msrp(method)"))
                #if(!pv_www_authenticate("$var(msrprealm)", "$var(passwd)", "1","$msrp(method)"))
                {
                        if (auth_get_www_authenticate("$var(msrprealm)", "1","$var(wauth)"))
                        {
                                $var(s1) = "qop=\"auth\"";
                                $var(s2) = "qop=\"auth\", opaque=\"c52854eebc40626ab22f751cf58bc722\"";
                                $var(wauth) = $(var(wauth){s.replace,$var(s1),$var(s2)});
                                xlog("www authenticate header is [$var(wauth)]\n");
                                msrp_reply("401", "Unauthorized","$var(wauth)");
                                #msrp_reply("200", "OK");
                        } else {
                                msrp_reply("500", "Server Error");
                        }
                        exit;
                }

                if ($hdr(Expires) != $null) {
                        $var(expires) = (int) $hdr(Expires);
                        if ($var(expires) < MSRP_MIN_EXPIRES) {
                                msrp_reply("423", "Interval Out-of-Bounds",
                                        "Min-Expires: MSRP_MIN_EXPIRES\r\n");
                                exit;
                        } else {
                                msrp_reply("423", "Interval Out-of-Bounds",
                                        "Max-Expires: MSRP_MAX_EXPIRES\r\n");
                                exit;
                        }

                } else
                        $var(expires) = MSRP_MAX_EXPIRES;

                $var(cnt) = $var(cnt) + 1;
                pv_printf("$var(sessid)", "s.$(pp).$(var(cnt)).$(RANDOM)");
                $sht(msrp=>$var(sessid)::srcaddr) = $msrp(srcaddr);
                $sht(msrp=>$var(sessid)::srcsock) = $msrp(srcsock);
                $shtex(msrp=>$var(sessid)) = $var(expires) + 5;
                # - Use-Path: the MSRP address for server + session id
                $var(headers) = "Use-Path: msrp://127.0.0.1:5060/"
                                + $var(sessid) + ";tcp\r\n"
                                + "Expires: " + $var(expires) + "\r\n";
                msrp_reply("200", "OK", "$var(headers)");
        }
        else if($msrp(method)=="SEND" || $msrp(method)=="REPORT")
        {
                if($msrp(nexthops)>1)
                {
                        if ($msrp(method)!="REPORT")
                        {
                                msrp_reply("200", "OK");
                        }
                        msrp_relay();
                        exit;
                }
                $var(sessid) = $msrp(sessid);
                if($sht(msrp=>$var(sessid)::srcaddr) == $null)
                {
                        # one more hop, but we don't have address in htable
                        if ($msrp(method)!="REPORT")
                        {
                                msrp_reply("481", "Session-does-not-exist");
                        }
                        exit;
                }
                else if($msrp(method)!="REPORT")
                {
                        msrp_reply("200", "OK");
                }
                msrp_relay_flags("1");
                msrp_set_dst("$sht(msrp=>$var(sessid)::srcaddr)",
                                "$sht(msrp=>$var(sessid)::srcsock)");
                msrp_relay();
        }
        else
        {
                msrp_reply("501", "Request-method-not-understood");
        }
}

#!endif

route[MSILO]{
#!ifdef WITH_MSILO
 if(!is_method("MESSAGE"))
  return;
 
        if(!lookup("location")) 
        {
  $var(rc)=$rc;
   if (! t_newtran())
             {
                 sl_reply_error();
                 exit;
              };

              switch ($var(rc)) {
                        case -1:
                        case -3:
    if (m_store("$ru"))
             {
                   log("MSILO: offline message stored\n");
                   if (!t_reply("202", "Accepted"))
                   {
                       sl_reply_error();
                   };

             } else {
                    log("MSILO: offline message NOT stored\n");
                    if (!t_reply("503", "Service Unavailable"))
                   {
                       sl_reply_error();
                   };
             };
               exit;

                                
                        case -2:
                                t_on_failure("MANAGE_FAILURE_MESSAGE");
           t_relay();
           exit;
                }
        };
  t_on_failure("MANAGE_FAILURE_MESSAGE");
        t_relay();
        exit;
                 
#!endif
return;
}

 

If all is configured and work correctly the signalling flow should be like this:

SUBSCRIBE sip:10.7.2.22:5060;transport=tcp SIP/2.0.
Via: SIP/2.0/TCP 10.2.4.38:57366;branch=z9hG4bK-524287-1---f1be3bbfb573044a.
Max-Forwards: 70.
Contact: <sip:222@10.2.4.38:57366;transport=tcp>.
To: <sip:333@10.7.2.22;transport=TCP>;tag=339c21513a585618341888f199c2a0f6-772a.
From: <sip:222@10.7.2.22;transport=TCP>;tag=4c016371.
Call-ID: GEZg2Vh3kQEmFqIW8FC0Gw...
CSeq: 9 SUBSCRIBE.
Expires: 0.
Accept: application/dialog-info+xml.
User-Agent: Z 3.14.38765 rv2.8.3.
Event: dialog.
Allow-Events: presence, kpml, talk.
Content-Length: 0.
.

 

SIP/2.0 202 OK.
Via: SIP/2.0/TCP 10.2.4.38:57366;branch=z9hG4bK-524287-1---f1be3bbfb573044a.
To: <sip:333@10.7.2.22;transport=TCP>;tag=339c21513a585618341888f199c2a0f6-772a.
From: <sip:222@10.7.2.22;transport=TCP>;tag=4c016371.
Call-ID: GEZg2Vh3kQEmFqIW8FC0Gw...
CSeq: 9 SUBSCRIBE.
Expires: 0.
Contact: <sip:10.7.2.22:5060;transport=tcp>.
Server: kamailio (5.0.1 (x86_64/linux)).
Content-Length: 0

.....................................................................

NOTIFY sip:222@10.2.4.38:57366;transport=UDP SIP/2.0.
Via: SIP/2.0/UDP 10.7.2.22;branch=z9hG4bK790e.ae967f96000000000000000000000000.0.
To: <sip:222@10.7.2.22>;tag=751db371.
From: <sip:333@10.7.2.22>;tag=339c21513a585618341888f199c2a0f6-4be7.
CSeq: 3 NOTIFY.
Call-ID: lonAkQUBgTTuFJcbeVU5bQ...
Content-Length: 569.
User-Agent: kamailio (5.0.1 (x86_64/linux)).
Max-Forwards: 70.
Event: dialog.
Contact: <sip:10.7.2.22:5060>.
Subscription-State: active;expires=14.
Content-Type: application/dialog-info+xml.
.
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="2" state="full" entity="sip:333@10.7.2.22">
<dialog id="pi44ZYDt6h6CRxF7yWNtZA.." call-id="pi44ZYDt6h6CRxF7yWNtZA.." direction="recipient">
<state>confirmed</state>
<remote>
<identity>sip:444@10.7.2.22;transport=TCP</identity>
<target uri="sip:444@10.2.4.38:51610;transport=TCP"/>
</remote>
<local>
<identity>sip:333@10.7.2.22;transport=TCP</identity>
<target uri="sip:333@10.7.2.22;transport=TCP"/>
</local>
</dialog>
</dialog-info>

 

SIP/2.0 200 OK.
Via: SIP/2.0/UDP 10.7.2.22;branch=z9hG4bK790e.ae967f96000000000000000000000000.0.
Contact: <sip:222@10.2.4.38:57366;transport=UDP>.
To: <sip:222@10.7.2.22>;tag=751db371.
From: <sip:333@10.7.2.22>;tag=339c21513a585618341888f199c2a0f6-4be7.
Call-ID: lonAkQUBgTTuFJcbeVU5bQ...
CSeq: 3 NOTIFY.
User-Agent: Z 3.14.38765 rv2.8.3.
Content-Length: 0.