Parameters
<varname>route</varname> (string)
Name of the route called for XMLRPC messages.
This route will be called only for HTTP messages whose method is
either GET or POST. The message visible inside the route
will be a HTTP request converted to SIP (the uri will be fixed and
a fake via will be added).
The route should perform additional security checks to
ensure the client is authorized to execute management/RPC functions
and then it should call the dispatch_rpc().
Default: the main route is used.
Set <varname>route</varname> parameter
modparam("xmlrpc", "route", "route_for_xmlrpcs")
<varname>autoconversion</varname> (string)
Enable or disable automatic parameter type conversion globally,
for all the methods parameters.
If on, a type mismatch in a method parameter
will not cause a fault if it is possible to automatically
convert it to the type expected by the method.
Default: off.
It is recommended to leave this parameter to its default off value
and fix instead the client application (which should use the
proper types) or to modify the target rpc to accept any type
(see the rpc scan '.' modifier).
Set the <varname>autoconversion</varname> parameter
modparam("xmlrpc", "autoconversion", 1)
<varname>escape_cr</varname> (integer)
Enable CR ('\r') escaping in replies. If enabled each '\r' in the
xmlrpc reply will be replaced with "
", according to the
xml spec.
It should be turned off only if you suspect interoperability problems
with older clients.
Default: on.
Set the <varname>escape_cr</varname> parameter
modparam("xmlrpc", "escape_cr", 1)
<varname>double_lf_to_crlf</varname> (integer)
When enabled double LFs ('\n\n') in the input xmlrpc strings
will be replaced with CR LF ('\r\n'). This makes LF LF behave like
an escape character for CR LF and is needed for compatibility with
kamailio tools and to work around buggy xmlrpc clients that don't
escape the CR in CR LF ('\r' should be escaped to "
"
otherwise according to the xml spec "\r\n" will be transformed to
'\n'), but need to send CR LF in the strings (e.g. they use
tm.t_uac_wait).
Note: when this option is turned on, there is no way to send a double
LF ('\n\n'), it will always be transformed in CR LF ('\r\n').
Default: off.
Set the <varname>double_lf_to_crlf</varname> parameter
modparam("xmlrpc", "double_lf_to_crlf", 1)
<varname>mode</varname> (integer)
When set to 1, xmlrpc module does not register to core the callback
functions for non-SIP messages. Useful when other module register
a callback for HTTP request, being the decision of admin when to
call the XMLRPC route (or functions).
Default: 0.
Set the <varname>mode</varname> parameter
modparam("xmlrpc", "mode", 1)
<varname>url_skip</varname> (str)
Regular expression to match the HTPP URL. If there is match,
then xmlrpc route is not executed.
Default value is null (don't skip).
Set <varname>url_skip</varname> parameter
...
modparam("xmlrpc", "url_skip", "^/sip")
...
<varname>url_match</varname> (str)
Regular expression to match the HTPP URL. If there is no match,
then xmlrpc route is not executed. This check is done after
url_skip, so if both url_skip and url_match would match then
the xmlrpc route is not executed (url_skip has higher priority).
Default value is null (match everything).
Set <varname>url_match</varname> parameter
...
modparam("xmlrpc", "url_match", "^/RPC2")
...