<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;

]>
<!-- Module User's Guide -->

<chapter>

	<title>&adminguide;</title>

	<section>
	<title>Overview</title>
	<para>
		This module collects the Transformations for 3GPP-SMS.
	</para>
	</section>
	<section>
	<title>Dependencies</title>
	<section>
		<title>&kamailio; Modules</title>
		<para>
		The following modules must be loaded before this module:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>No dependencies on other &kamailio; modules</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	<section>
		<title>External Libraries or Applications</title>
		<para>
		The following libraries or applications must be installed before running
		&kamailio; with this module loaded:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>None</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	</section>
	<section>
	<title>Parameters</title>
	<section>
		<para>There are no configurable Parameters yet</para>
	</section>
	</section>
	<section>
	<title>Functions</title>
		<section id="smsops.f.isRPDATA">
		<title><function moreinfo="none">isRPDATA()</function></title>
		<para>
			Returns true, if the message contains RP-Data in its body.
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>isRPDATA()</function> usage</title>
		<programlisting format="linespecific">
...
if (isRPDATA())
{
    ...
}
...
</programlisting>
		</example>
		</section>
		<section id="smsops.f.smsdump">
		<title><function moreinfo="none">smsdump()</function></title>
		<para>Dumps the content of a 3GPP-SMS message to the Debug-Log.</para>
		<para>Please make sure, to have debug-Log enabled. Otherwise, you won't see anything.</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>smsdump()</function> usage</title>
		<programlisting format="linespecific">
...
smsdump();
...
</programlisting>
		</example>
		</section>
	</section><!-- end of functions -->

	<section>
	<title>Variables</title>
	<para>Several variables are exported by the module to access the
	attributes of the SMS.</para>
	<itemizedlist>
	<listitem>
		<para><emphasis>$smsack</emphasis></para>
		<para><emphasis>$smsbody</emphasis></para>
		<para><emphasis>$rpdata(key)</emphasis></para>
		<para><emphasis>$tpdu(key)</emphasis></para>
	</listitem>
	</itemizedlist>
	</section>

</chapter>

