Forward

Last modified by Buildbot on 2021/06/11 04:37

 Documentation based on repostory git version commit 2.0.4-19-gdf524709 

Module Forward

This module executes the basic routing task of SIP requests and pass them to the transport layer. It must always be enabled.
----

Configuration options:

NameDescriptionDefault ValueType
enabled

Indicate whether the module is activated.

 trueBoolean
filter

A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')

 BooleanExpr
route

A route header value where to send all requests not already resolved by the Router module (ie for which contact information has been found from the registrar database). This is the typical way to setup a Flexisip proxy server acting as a front-end for backend SIP server.Pay attention that is not just a SIP URI, but a route. As a result, when the URI has parameters, brakets must enclose the URI, otherwise the parameters will be parsed as route parameters.
For example:
route=<sip:192.168.0.10;transport=tcp>

 String
add-path

Add a path header of this proxy

 trueBoolean
rewrite-req-uri

Rewrite request-uri's host and port according to above route

 falseBoolean
default-transport

For SIP URIs, in asbsence of transport parameter, assume the given transport is to be used. Possible values are udp, tcp or tls.

 udpString
params-to-remove

List of URL and contact params to remove

 pn-tok pn-type app-id pn-msg-str pn-call-str pn-call-snd pn-msg-snd pn-timeout pn-silent pn-provider pn-prid pn-paramStringList