Documentation based on repostory git version commit 1.0.12-487-g7669680

Module Router

The ModuleRouter module routes requests for domains it manages.

Configuration options:

NameDescriptionDefault ValueType
enabledIndicate whether the module is activated. trueBoolean
filterA request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains '', from.uri.domain in '', (to.uri.domain in '') && (user-agent == 'Linphone v2') BooleanExpr
use-global-domainStore and retrieve contacts without using the domain. falseBoolean
forkFork messages to all registered devices trueBoolean
statefulForce forking and thus the creation of an outgoing transaction even when only one contact found trueBoolean
fork-lateFork invites to late registers falseBoolean
fork-no-global-declineAll the forked have to decline in order to decline the caller invite falseBoolean
treat-decline-as-urgentTreat 603 Declined answers as urgent. Only relevant if fork-no-global-decline is set to true. falseBoolean
treat-all-as-urgentDuring a fork procedure, treat all failure response as urgent falseBoolean
call-fork-timeoutMaximum time for a call fork to try to reach a callee, in seconds. 90Integer
call-fork-urgent-timeoutMaximum time before delivering urgent responses during a call fork, in seconds. The typical fork process requires to wait the best response from all branches before transmitting it to the client. However some error responses are retryable immediately (like 415 unsupported media, 401, 407) thus it is painful for the client to need to wait the end of the transaction time (32 seconds) for these error codes. 5Integer
call-fork-current-branches-timeoutMaximum time before trying the next branches with lower priotiries 10Integer
call-push-response-timeoutOptional timer to detect lack of push response, in seconds. 0Integer
message-fork-lateFork messages to client registering lately.  trueBoolean
message-delivery-timeoutMaximum duration for delivering a text message. This property applies only if message-fork-late if set to true, otherwise the duration can't exceed the normal transaction duration. 3600Integer
message-accept-timeoutMaximum duration for accepting a text message if no response is received from any recipients. This property is meaningful when message-fork-late is set to true. 15Integer
allow-target-factorizationDuring a call forking, allow several INVITEs going to the same next hop to be grouped into a single one. A proprietary custom header 'X-target-uris' is added to the INVITE to indicate the final targets of the INVITE. falseBoolean
generated-contact-routeGenerate a contact from the TO header and route it to the above destination. [sip:host:port] String
generated-contact-expected-realmRequire presence of authorization header for specified realm. [Realm] String
generate-contact-even-on-filled-aorGenerate a contact route even on filled AOR. falseBoolean
remove-to-tagRemove to tag from 183, 180, and 101 responses to workaround buggy gateways falseBoolean
prerouteRewrite username with given value. String
resolve-routesWhether or not to resolve all routes and forward the event to it if it's not us falseBoolean
fallback-routeDefault route to apply when the recipient is unreachable. [sip:host:port] String
parent-domain-fallbackWhether or not to fallback to the parent domain if there is no fallback route set and the recipient is unreachable falseBoolean
Created by Buildbot on 2017/01/16 10:02