Browse Source

textopsx: docs for change_reply_status_code() function

Daniel-Constantin Mierla 5 years ago
parent
commit
dfa1677800
1 changed files with 32 additions and 0 deletions
  1. 32 0
      src/modules/textopsx/doc/functions.xml

+ 32 - 0
src/modules/textopsx/doc/functions.xml

@@ -82,6 +82,38 @@ reply_route {
         exit;
     }
 }
+...
+	    </programlisting>
+	</example>
+    </section>
+
+    <section id="textopsx.f.change_reply_status_code">
+	<title>
+	    <function>change_reply_status_code(vcode)</function>
+	</title>
+	<para>
+		Change the status code for a SIP reply .
+	</para>
+	<para>Meaning of the parameters is as follows:</para>
+	<itemizedlist>
+	    <listitem>
+		<para><emphasis>vcode</emphasis> - the new status code.
+		</para>
+	    </listitem>
+	</itemizedlist>
+   		<para>
+		This function can be used from ONREPLY_ROUTE.
+		</para>
+	<example>
+	    <title><function>change_reply_status_code</function> usage</title>
+	    <programlisting>
+...
+reply_route {
+    if (status == "604") {
+        change_reply_status_code("404");
+        exit;
+    }
+}
 ...
 	    </programlisting>
 	</example>