MSILO module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This modules provides offline message storage for the Open SIP Server. It stores received messages for an offline user and sends them when the user becomes online.
For each message, the modules stores “Request-URI” (“R-URI”) only if it is a complete address of record (“username@hostname”), URI from “To” header, URI from “From” header, incoming time, expiration time, content type and body of the message. If “R-URI” is not an address of record (it might be the contact address for current SIP session) the URI from “To” header will be used as R-URI.
When the expiration time passed, the message is discarded from database. Expiration time is computed based on incoming time and one of the module’s parameters.
Every time when a user registers with OpenSIPS, the module is looking in database for offline messages intended for that user. All of them will be sent to contact address provided in REGISTER request.
It may happen the SIP user to be registered but his SIP User Agent to have no support for MESSAGE request. In this case it should be used the “failure_route” to store the undelivered requests.
Another functionality provided by the modules is to send messages at a certain time — the reminder functionality. Using config logic, a received message can be stored and delivered at a time specified while storing with the ‘snd_time_avp’.
Dependencies
Section titled “Dependencies”OpenSIPS modules
Section titled “OpenSIPS modules”The following modules must be loaded before this module:
- database module - mysql, dbtext or other module that implements the “db” interface and provides support for storing/receiving data to/from a database system.
- TM—transaction module—is used to send SIP requests.
External libraries or applications
Section titled “External libraries or applications”The following libraries or applications must be installed before running OpenSIPS with this module:
- none.
Exported Parameters
Section titled “Exported Parameters”db_url (string)
Section titled “db_url (string)”Database URL.
Default value is “mysql://opensips:opensipsrw@localhost/opensips”.
...modparam("msilo", "db_url", "mysql://user:passwd@host.com/dbname")...db_table (string)
Section titled “db_table (string)”The name of table where to store the messages.
Default value is “silo”.
...modparam("msilo", "db_table", "silo")...from_address (string)
Section titled “from_address (string)”The SIP address used to inform users that destination of their message is not online and the message will be delivered next time when that user goes online. If the parameter is not set, the module will not send any notification. It can contain pseudo-variables.
Default value is “NULL”.
...modparam("msilo", "from_address", "sip:registrar@example.org")modparam("msilo", "from_address", "sip:$rU@example.org")...contact_hdr (string)
Section titled “contact_hdr (string)”The value of the Contact header (including header name and ending \r\n) to be added in notification messages. It can contain pseudo-variables.
Default value is “NULL”.
...modparam("msilo", "contact_hdr", "Contact: <sip:null@example.com>\r\n")...offline_message (string)
Section titled “offline_message (string)”The body of the notification message. It can contain pseudo-variables.
Default value is “NULL”.
...modparam("msilo", "offline_message", "*** User $rU is offline!")modparam("msilo", "offline_message", "<em>I am offline!</em>")...content_type_hdr (string)
Section titled “content_type_hdr (string)”The value of the Content-Type header (including header name and ending \r\n) to be added in notification messages. It must reflect what the ‘offline_message’ contains. It can contain pseudo-variables.
Default value is “NULL”.
...modparam("msilo", "content_type_hdr", "Content-Type: text/plain\r\n")modparam("msilo", "content_type_hdr", "Content-Type: text/html\r\n")...reminder (string)
Section titled “reminder (string)”The SIP address used to send reminder messages. If this value is not set, the reminder feature is disabled.
Default value is “NULL”.
...modparam("msilo", "reminder", "sip:registrar@example.org")...outbound_proxy (string)
Section titled “outbound_proxy (string)”The SIP address used as next hop when sending the message. Very useful when using OpenSIPS with a domain name not in DNS, or when using a separate OpenSIPS instance for msilo processing. If not set, the message will be sent to the address in destination URI.
Default value is “NULL”.
...modparam("msilo", "outbound_proxy", "sip:opensips.org;transport=tcp")...expire_time (int)
Section titled “expire_time (int)”Expire time of stored messages - seconds. When this time passed, the message is silently discarded from database.
Default value is “259200 (72 hours = 3 days)“.
...modparam("msilo", "expire_time", 36000)...check_time (int)
Section titled “check_time (int)”Timer interval to check if dumped messages are sent OK - seconds. The module keeps each request send by itself for a new online user and if the reply is 2xx then the message is deleted from database.
Default value is “30”.
...modparam("msilo", "check_time", 10)...send_time (int)
Section titled “send_time (int)”Timer interval in seconds to check if there are reminder messages. The module takes all reminder messages that must be sent at that moment or before that moment.
If the value is 0, the reminder feature is disabled.
Default value is “0”.
...modparam("msilo", "send_time", 60)...clean_period (int)
Section titled “clean_period (int)”Number of “check_time” cycles when to check if there are expired messages in database.
Default value is “5”.
...modparam("msilo", "clean_period", 3)...use_contact (int)
Section titled “use_contact (int)”Turns on/off the usage of the Contact address to send notification back to sender whose message is stored by MSILO.
Default value is “1 (0 = off, 1 = on)“.
...modparam("msilo", "use_contact", 0)...sc_mid (string)
Section titled “sc_mid (string)”The name of the column in silo table, storing message id.
Default value is “mid”.
...modparam("msilo", "sc_mid", "other_mid")...sc_from (string)
Section titled “sc_from (string)”The name of the column in silo table, storing the source address.
Default value is “src_addr”.
...modparam("msilo", "sc_from", "source_address")...sc_to (string)
Section titled “sc_to (string)”The name of the column in silo table, storing the destination address.
Default value is “dst_addr”.
...modparam("msilo", "sc_to", "destination_address")...sc_uri_user (string)
Section titled “sc_uri_user (string)”The name of the column in silo table, storing the user name.
Default value is “username”.
...modparam("msilo", "sc_uri_user", "user")...sc_uri_host (string)
Section titled “sc_uri_host (string)”The name of the column in silo table, storing the domain.
Default value is “domain”.
...modparam("msilo", "sc_uri_host", "domain")...sc_body (string)
Section titled “sc_body (string)”The name of the column storing the message body in silo table.
Default value is “body”.
...modparam("msilo", "sc_body", "message_body")...sc_ctype (string)
Section titled “sc_ctype (string)”The name of the column in silo table, storing content type.
Default value is “ctype”.
...modparam("msilo", "sc_ctype", "content_type")...sc_exp_time (string)
Section titled “sc_exp_time (string)”The name of the column in silo table, storing the expire time of the message.
Default value is “exp_time”.
...modparam("msilo", "sc_exp_time", "expire_time")...sc_inc_time (string)
Section titled “sc_inc_time (string)”The name of the column in silo table, storing the incoming time of the message.
Default value is “inc_time”.
...modparam("msilo", "sc_inc_time", "incoming_time")...sc_snd_time (string)
Section titled “sc_snd_time (string)”The name of the column in silo table, storing the send time for the reminder.
Default value is “snd_time”.
...modparam("msilo", "sc_snd_time", "send_reminder_time")...snd_time_avp (str)
Section titled “snd_time_avp (str)”The name of an AVP which may contain the time when to sent the received message as reminder.The AVP is used ony by m_store().
If the parameter is not set, the module does not look for this AVP. If the value is set to a valid AVP name, then the module expects in the AVP to be a time value in format YYYYMMDDHHMMSS (e.g., 20060101201500).
Default value is “null”.
...modparam("msilo", "snd_time_avp", "$avp(snd_time)")...add_date (int)
Section titled “add_date (int)”Wheter to add as prefix the date when the message was stored.
Default value is “1” (1==on/0==off).
...modparam("msilo", "add_date", 0)...max_messages (int)
Section titled “max_messages (int)”Maximum number of stored message for an AoR. Value 0 equals to no limit.
Default value is 0.
...modparam("msilo", "max_messages", 0)...Exported Functions
Section titled “Exported Functions”m_store([owner])
Section titled “m_store([owner])”The method stores certain parts of the current SIP request (it should be called when the request type is MESSAGE and the destination user is offline or his UA does not support MESSAGE requests). If the user is registered with a UA which does not support MESSAGE requests you should not use mode=“0” if you have changed the request uri with the contact address of user’s UA.
Meaning of the parameters is as follows:
- owner - is a string that must contain a SIP URI in whose inbox the message will be stored. It can have any pseudo variable. If “owner” is missing, the SIP address is taken from R-URI.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
...m_store();m_store("$tu");...m_dump([owner])
Section titled “m_dump([owner])”The method sends stored messages for the SIP user that is going to register to his actual contact address. The method should be called when a REGISTER request is received and the “Expire” header has a value greater than zero.
Meaning of the parameters is as follows:
- owner - is a string that must contain a SIP URI whose inbox will be dumped. It can have any pseudo variable. If “owner” is missing, the SIP address is taken from To URI.
This function can be used from REQUEST_ROUTE.
...m_dump();m_dump("$fu");...Exported Statistics
Section titled “Exported Statistics”stored_messages
Section titled “stored_messages”The number of messages stored by msilo.
dumped_messages
Section titled “dumped_messages”The number of dumped messages.
failed_messages
Section titled “failed_messages”The number of failed dumped messages.
dumped_reminders
Section titled “dumped_reminders”The number of dumped reminder messages.
failed_reminders
Section titled “failed_reminders”The number of failed reminder messages.
Samples
Section titled “Samples”OpenSIPS Config Script - Msilo Usage
Section titled “OpenSIPS Config Script - Msilo Usage”# $Id$## MSILO usage example##
debug=9 # debug level (cmd line: -dddddddddd)fork=no # don't forklog_stderror=yes # log to stderr (cmd line: -E)
children=2 # number of childrencheck_via=no # (cmd. line: -v)dns=off # (cmd. line: -r)rev_dns=off # (cmd. line: -R)port=5060
listen=10.0.0.2 # listen address
# ------------------ module loading ----------------------------------mpath="/usr/local/lib/opensips/modules/"
loadmodule "textops.so"
loadmodule "sl.so"loadmodule "mysql.so"loadmodule "maxfwd.so"loadmodule "msilo.so"loadmodule "tm.so"loadmodule "registrar.so"loadmodule "usrloc.so"
# ----------------- setting module-specific parameters ---------------
# -- registrar params --
modparam("registrar", "default_expires", 120)
# -- registrar params --
modparam("usrloc", "db_mode", 0)
# -- msilo params --
modparam("msilo","db_url","mysql://opensips:opensipsrw@localhost/opensips")modparam("msilo","from_address","sip:registrar@opensips.org")modparam("msilo","contact_hdr","Contact: registrar@192.168.1.2:5060;msilo=yes\r\n")modparam("msilo","content_type_hdr","Content-Type: text/plain\r\n")modparam("msilo","offline_message","*** User $rU is offline!")
# -- tm params --
modparam("tm", "fr_timer", 10 )modparam("tm", "fr_inv_timer", 15 )modparam("tm", "wt_timer", 10 )
route{ if ( !mf_process_maxfwd_header("10") ) { sl_send_reply("483","To Many Hops"); exit; };
if (uri==myself) { { # for testing purposes, simply okay all REGISTERs if (method=="REGISTER") { save("location"); log("REGISTER received -> dumping messages with MSILO\n");
# MSILO - dumping user's offline messages if (m_dump()) { log("MSILO: offline messages dumped - if they were\n"); }else{ log("MSILO: no offline messages dumped\n"); }; exit; };
# domestic SIP destinations are handled using our USRLOC DB
if(!lookup("location")) { if (! t_newtran()) { sl_reply_error(); exit; }; # we do not care about anything else but MESSAGEs if (!method=="MESSAGE") { if (!t_reply("404", "Not found")) { sl_reply_error(); }; exit; }; log("MESSAGE received -> storing using MSILO\n"); # MSILO - storing as offline message 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; }; # if the downstream UA does not support MESSAGE requests # go to failure_route[1] t_on_failure("1"); t_relay(); exit; };
# forward anything else t_relay();}
failure_route[1] { # forwarding failed -- check if the request was a 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"); };}Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Daniel-Constantin Mierla (@miconda) | 133 | 66 | 4452 | 1699 |
| 2. | Bogdan-Andrei Iancu (@bogdan-iancu) | 36 | 27 | 278 | 344 |
| 3. | Jan Janak (@janakj) | 20 | 11 | 282 | 324 |
| 4. | Andrei Pelinescu-Onciul | 18 | 10 | 117 | 384 |
| 5. | Stefan Darius (@dariusstefan) | 14 | 4 | 890 | 104 |
| 6. | Henning Westerholt (@henningw) | 11 | 6 | 127 | 123 |
| 7. | Jiri Kuthan (@jiriatipteldotorg) | 9 | 6 | 188 | 41 |
| 8. | Juha Heinanen (@juha-h) | 8 | 3 | 252 | 100 |
| 9. | Andrea Giordana | 8 | 1 | 558 | 93 |
| 10. | Ancuta Onofrei | 6 | 1 | 136 | 171 |
All remaining contributors: Razvan Crainea (@razvancrainea), Elena-Ramona Modroiu, Vlad Paiu (@vladpaiu), Aron Rosenberg, John Riordan, Konstantin Bokarius, UnixDev, Sergio Gutierrez, Edson Gellert Schubert, Stanislaw Pitucha.
(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
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2011 - Jun 2026 |
| 3. | Vlad Paiu (@vladpaiu) | Aug 2011 - Aug 2014 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Sep 2002 - Jan 2013 |
| 5. | Stanislaw Pitucha | Jul 2010 - Jul 2010 |
| 6. | John Riordan | May 2009 - May 2009 |
| 7. | UnixDev | Feb 2009 - Feb 2009 |
| 8. | Sergio Gutierrez | Nov 2008 - Nov 2008 |
| 9. | Henning Westerholt (@henningw) | Aug 2007 - Jun 2008 |
| 10. | Daniel-Constantin Mierla (@miconda) | Aug 2002 - May 2008 |
All remaining contributors: Konstantin Bokarius, Edson Gellert Schubert, Ancuta Onofrei, Aron Rosenberg, Elena-Ramona Modroiu, Juha Heinanen (@juha-h), Andrea Giordana, Andrei Pelinescu-Onciul, Jan Janak (@janakj), Jiri Kuthan (@jiriatipteldotorg).
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Juha Heinanen (@juha-h), Andrea Giordana, Jan Janak (@janakj).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0