git:master: dialplan: rpc commands documented - sr-dev

17 Apr 2011

Module: sip-router
Branch: master
Commit: e9c660ef2ced5c479deeddac75c499f7bfabfa47
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e9c660ef...
Author: Daniel-Constantin Mierla miconda@gmail.com
Committer: Daniel-Constantin Mierla miconda@gmail.com
Date:   Sun Apr 17 14:28:00 2011 +0200
dialplan: rpc commands documented
---
modules/dialplan/README                 |   47 +++++++++++++++++++++++++++--
 modules/dialplan/doc/dialplan_admin.xml |   50 +++++++++++++++++++++++++++++-
 2 files changed, 92 insertions(+), 5 deletions(-)

diff --git a/modules/dialplan/README b/modules/dialplan/README
index e03067d..466d034 100644
--- a/modules/dialplan/README
+++ b/modules/dialplan/README
@@ -56,7 +56,12 @@ Juha Heinanen
               7.1. dp_reload
               7.2. dp_translate
-        8. Installation
+        8. Exported RPC Commands
+
+              8.1. dialplan.reload
+              8.2. dialplan.translate
+
+        9. Installation
2. Developer's Guide
@@ -113,7 +118,12 @@ Chapter 1. Admin Guide
         7.1. dp_reload
         7.2. dp_translate
-   8. Installation
+   8. Exported RPC Commands
+
+        8.1. dialplan.reload
+        8.2. dialplan.translate
+
+   9. Installation
1. Overview
@@ -410,7 +420,38 @@ xlog("translated to var $var(y) \n");
             input
                 _empty_line_
-8. Installation
+8. Exported RPC Commands
+
+   8.1. dialplan.reload
+   8.2. dialplan.translate
+
+8.1. dialplan.reload
+
+   Forces an update of the translation rules from the database.
+
+   Name: dialplan.reload
+
+   Parameters: none
+
+   Example:
+                sercmd dialplan.reload
+
+8.2. dialplan.translate
+
+   Will apply a translation rule identified by a dialplan id and an input
+   string.
+
+   Name: dialplan.translate
+
+   Parameters: 2
+     * Dial plan ID
+     * Input String
+
+   Example:
+        # sercmd dp_translate dpid "input"
+        sercmd dp_translate 1 "abcdxyz"
+
+9. Installation
The modules requires one table in Kamailio database: dialplan. The SQL
    syntax to create them can be found in dialplan-create.sql script in the
diff --git a/modules/dialplan/doc/dialplan_admin.xml b/modules/dialplan/doc/dialplan_admin.xml
index 43c418b..24b2597 100644
--- a/modules/dialplan/doc/dialplan_admin.xml
+++ b/modules/dialplan/doc/dialplan_admin.xml
@@ -511,8 +511,56 @@ xlog("translated to var $var(y) \n");
    	</programlisting>
    	</section>
    </section>
+
+	<section>
+	<title>Exported RPC Commands</title>
+
+		<section>
+			<title><varname>dialplan.reload</varname></title>
+			<para>
+			Forces an update of the translation rules from the database.
+			</para>
+		<para>
+		Name: <emphasis>dialplan.reload</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis></para>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+		sercmd dialplan.reload
+		</programlisting>
+		</section>
<section>
+			<title><varname>dialplan.translate</varname></title>
+			<para>
+                Will apply a translation rule identified by a dialplan
+                id and an input string.
+			</para>
+		<para>
+		Name: <emphasis>dialplan.translate</emphasis>
+		</para>
+        <para>Parameters: <emphasis>2</emphasis></para>
+        <itemizedlist>
+                <listitem>
+                <para><emphasis>Dial plan ID</emphasis></para>
+                </listitem>
+                <listitem>
+                <para><emphasis>Input String</emphasis></para>
+                </listitem>
+		</itemizedlist>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+        # sercmd dp_translate dpid "input"
+        sercmd dp_translate 1 "abcdxyz"
+		</programlisting>
+		</section>
+	</section>
+
+    <section>
        <title>Installation</title>
        <para>
         The modules requires one table in &kamailio; database: dialplan. The SQL 
@@ -523,6 +571,4 @@ xlog("translated to var $var(y) \n");
         </para>
     </section>
-
-
 </chapter>

    