sipcapture: docs for sip_capture_forward(uri)
authorDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 2 May 2018 10:18:57 +0000 (12:18 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 2 May 2018 10:18:57 +0000 (12:18 +0200)
src/modules/sipcapture/doc/sipcapture_admin.xml

index 5f7055a..0dbfafa 100644 (file)
@@ -651,6 +651,36 @@ $var(res) = float2int("10.5", "1");
 </programlisting>
                </example>
        </section>
+       <section id="sipcapture.f.sip_capture_forward">
+               <title>
+               <function moreinfo="none">sip_capture_forward(uri)</function>
+               </title>
+               <para>
+               Forward the HEP packet to an address specified by the parameter uri
+               (it has to be a sip uri format). The function should be used inside
+               event_route[sipcapture:request]. After using this function, add a
+               return 0 in order to stop processing further the packet in the local
+               &kamailio; instance.
+               </para>
+               <para>
+               This function can be used from ANY_ROUTE.
+               </para>
+               <example>
+               <title><function>sip_capture_forward()</function> usage</title>
+               <programlisting format="linespecific">
+...
+    event_route[sipcapture:request] {
+        ...
+        if(src_ip==1.2.3.4) {
+            sip_capture_forward("sip:2.3.4.5:5090");
+            return 0;
+        }
+        ...
+    }
+...
+</programlisting>
+               </example>
+       </section>
        </section>
 
     <section>