[sr-dev] git:master:43ef2b33: smsops: More documentation, more coming soon

Carsten Bock carsten at ng-voice.com
Thu Jun 11 12:44:00 CEST 2015


Module: kamailio
Branch: master
Commit: 43ef2b33dfe1f494a9caba10e4c9440df55fe743
URL: https://github.com/kamailio/kamailio/commit/43ef2b33dfe1f494a9caba10e4c9440df55fe743

Author: Carsten Bock <carsten at ng-voice.com>
Committer: Carsten Bock <carsten at ng-voice.com>
Date: 2015-06-11T11:43:49+01:00

smsops: More documentation, more coming soon

---

Modified: modules/smsops/doc/smsops_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/43ef2b33dfe1f494a9caba10e4c9440df55fe743.diff
Patch: https://github.com/kamailio/kamailio/commit/43ef2b33dfe1f494a9caba10e4c9440df55fe743.patch

---

diff --git a/modules/smsops/doc/smsops_admin.xml b/modules/smsops/doc/smsops_admin.xml
index 73b41b9..0772b43 100644
--- a/modules/smsops/doc/smsops_admin.xml
+++ b/modules/smsops/doc/smsops_admin.xml
@@ -16,7 +16,7 @@
 	<section>
 	<title>Overview</title>
 	<para>
-		This module collects the Transformations for 3GPP-SMS-V2.
+		This module collects the Transformations for 3GPP-SMS.
 	</para>
 	</section>
 	<section>
@@ -49,5 +49,51 @@
 		</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 it's 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.isRPDATA">
+		<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 -->
+
 </chapter>
 




More information about the sr-dev mailing list