$Revision: 1.1 $
$Date: 2004/11/15 13:53:55 $
User's Guide
Overview
The module implements the Diversion extensions as per draft-levy-sip-diversion-08. The
diversion extensions are useful in various scenarios involving call
forwarding. Typically one needs to communicate the original recipient of the call to the
PSTN gateway and this is what the diversion extensions can be used for.
Dependencies
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>suffix</varname> (string)
The suffix to be appended to the end of the header field. You can use the parameter
to specify additional parameters to be added to the header field, see the example.
Default value is
(empty string).
<varname>suffix</varname> usage
modparam("diversion", "suffix", ";privacy=full")
Exported Functions
<function moreinfo="none">add_diversion(reason)</function>
The function adds a new diversion header field before any other existing Diversion
header field in the message (the newly added Diversion header field will become the
topmost Diversion header field). The inbound (without any modifications done by the
proxy server) Request-URI will be used as the Diversion URI.
Meaning of the parameters is as follows:
reason - The reason string to be added as the reason
parameter
<function moreinfo="none">add_diversion</function> usage
...
add_diversion("user-busy");
...
Diversion Example
The following example shows a Diversion header field added to INVITE
message. The INVITE message was diverted by the user agent of sip:jiri@iptel.org
because the user was talking to someone else and the new destination is
sip:jan@iptel.org.
INVITE sip:jan@iptel.org SIP/2.0
From: "5060" <sip:5060@iptel.org>;tag=ldgheoihege
To: "Jan Janak" <sip:jan@iptel.org>
Call-ID: adgasdkgjhkjha@1.2.3.4
CSeq: 3 INVITE
Diversion: <sip:jiri@iptel.org>;reason=user-busy
Via: SIP/2.0/UDP 1.2.3.4:5060
Contact: <sip:5060@2.3.4.5>
Content-Length: 0