Chapter 1. Admin Guide

1.1. 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'.

1.2. Dependencies

1.2.1. 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.

1.2.2. External libraries or applications

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

1.3.1. db_url (string)

1.3.2. db_table (string)

The name of table where to store the messages.

Default value is “silo”.

Example 1.2. Set the “db_table” parameter

...
modparam("msilo", "db_table", "silo")
...

1.3.3. 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.

1.3.7. 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”.

Example 1.7. Set the “reminder” parameter

...
modparam("msilo", "reminder", "sip:registrar@example.org")
...

1.3.8. 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.

1.3.9. 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)”.

Example 1.9. Set the “expire_time” parameter

...
modparam("msilo", "expire_time", 36000)
...

1.3.10. 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”.

Example 1.10. Set the “check_time” parameter

...
modparam("msilo", "check_time", 10)
...

1.3.11. 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”.

Example 1.11. Set the “send_time” parameter

...
modparam("msilo", "send_time", 60)
...

1.3.12. clean_period (int)

Number of “check_time” cycles when to check if
there are expired messages in database.

Default value is “5”.

Example 1.12. Set the “clean_period” parameter

...
modparam("msilo", "clean_period", 3)
...

1.3.13. 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)”.

Example 1.13. Set the “use_contact” parameter

...
modparam("msilo", "use_contact", 0)
...

1.3.14. sc_mid (string)

The name of the column in silo table, storing message id.

Default value is “mid”.

Example 1.14. Set the “sc_mid” parameter

...
modparam("msilo", "sc_mid", "other_mid")
...

1.3.15. sc_from (string)

The name of the column in silo table, storing the source address.

Default value is “src_addr”.

Example 1.15. Set the “sc_from” parameter

...
modparam("msilo", "sc_from", "source_address")
...

1.3.16. sc_to (string)

The name of the column in silo table, storing the destination address.

Default value is “dst_addr”.

Example 1.16. Set the “sc_to” parameter

...
modparam("msilo", "sc_to", "destination_address")
...

1.3.17. sc_uri_user (string)

The name of the column in silo table, storing the user name.

Default value is “username”.

Example 1.17. Set the “sc_uri_user” parameter

...
modparam("msilo", "sc_uri_user", "user")
...

1.3.18. sc_uri_host (string)

The name of the column in silo table, storing the domain.

Default value is “domain”.

Example 1.18. Set the “sc_uri_host” parameter

...
modparam("msilo", "sc_uri_host", "domain")
...

1.3.19. sc_body (string)

The name of the column storing the message body in silo table.

Default value is “body”.

Example 1.19. Set the “sc_body” parameter

...
modparam("msilo", "sc_body", "message_body")
...

1.3.20. sc_ctype (string)

The name of the column in silo table, storing content type.

Default value is “ctype”.

Example 1.20. Set the “sc_ctype” parameter

...
modparam("msilo", "sc_ctype", "content_type")
...

1.3.21. sc_exp_time (string)

The name of the column in silo table, storing the expire time of the message.

Default value is “exp_time”.

Example 1.21. Set the “sc_exp_time” parameter

...
modparam("msilo", "sc_exp_time", "expire_time")
...

1.3.22. sc_inc_time (string)

The name of the column in silo table, storing the incoming time of the message.

Default value is “inc_time”.

Example 1.22. Set the “sc_inc_time” parameter

...
modparam("msilo", "sc_inc_time", "incoming_time")
...

1.3.23. sc_snd_time (string)

The name of the column in silo table, storing the send time for the reminder.

Default value is “snd_time”.

Example 1.23. Set the “sc_snd_time” parameter

...
modparam("msilo", "sc_snd_time", "send_reminder_time")
...

1.3.24. 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”.

Example 1.24. Set the “snd_time_avp” parameter

...
modparam("msilo", "snd_time_avp", "$avp(snd_time)")
...

1.3.25. add_date (int)

Wheter to add as prefix the date when the message was stored.

Default value is “1” (1==on/0==off).

Example 1.25. Set the “add_date” parameter

...
modparam("msilo", "add_date", 0)
...

1.3.26. max_messages (int)

Maximum number of stored message for an AoR. Value 0
equals to no limit.

Default value is 0.

Example 1.26. Set the “max_messages” parameter

...
modparam("msilo", "max_messages", 0)
...

1.4. Exported Functions

1.4.1. 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.

Example 1.27. m_store usage

...
m_store();
m_store("$tu");
...

1.4.2. 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.