Use this function to apply changes performed on SIP request content. Be careful when using this function; due to special handling of changes to the SIP message buffer so far, using this function might change the behaviour of your config. Do test your config properly!

This function can be used from REQUEST_ROUTE.

...
append_hf("My-Header: yes\r\n");
if(msg_apply_changes())
{
    # msg buffer has a new content
    if(is_present_hf("My-Header"))
    {
        # will get here always
    }
}
...

Intercept a SIP reply (in an onreply_route) and change its status code and reason phrase prior to forwarding it.

Meaning of the parameters is as follows:

This function can be used from ONREPLY_ROUTE.

...
onreply_route {
    if (@status == "603") {
        change_reply_status(404, "Not Found");
        exit;
    }
}
...

Use this function to remove the body of SIP requests or replies.

This function can be used from ANY_ROUTE.

...
remove_body();
...

Remove headers that don't match the regular expression regexp. Several header are ignored always (thus not removed): Via, From, To, Call-ID, CSeq, Content-Lenght, Content-Type, Max-Forwards, Contact, Route, Record-Route -- these can be removed one by one with remove_hf().

This function can be used from ANY_ROUTE.

...
keep_hf("User-Agent");
...

Match the value against the expr using shell-style pattern for file name matching (see man page for C function fnmatch()). It is known to be faster and use less-memory than regular expressions.

Parameter 'flags' is optional and can be 'i' to do case insensitive matching.

This function can be used from ANY_ROUTE.

...
if(fnmatch("$rU", "123*"))
{
    ...
}
...

Append new header value after an existing header, if no index acquired append at the end of list. Note that a header may consist of comma delimited list of values.

Meaning of the parameters is as follows:

...
append_hf_value("foo", "gogo;stamp=$Ts")   # add new header
append_hf_value("foo[1]", "gogo")  # add new value behind first value
append_hf_value("foo[-1]", "$var(Bar)") # try add value to the last header, if not exists add new header
...

Insert new header value before an existing header, if no index acquired insert before first hf header. Note that a header may consist of comma delimited list of values. To insert value behing last value use appenf_hf_value.

Meaning of the parameters is as follows:

...
insert_hf_value("foo[2]", "gogo")
insert_hf_value("foo", "$avp(foo)")   # add new header at the top of list
insert_hf_value("foo[1]", "gogo") # try add to the first header
...

Remove the header value from existing header, Note that a header may consist of comma delimited list of values.

Meaning of the parameters is as follows:

...
remove_hf_value("foo")  # remove foo[1]
remove_hf_value("foo[*]")  # remove all foo's headers
remove_hf_value("foo[-1]") # last foo
remove_hf_value("foo.bar")  # delete parameter
remove_hf_value("foo[*].bar") # for each foo delete bar parameters
...

Remove specified header or parameter. It is expected header in Authorization format (comma delimiters are not treated as multi-value delimiters).

Meaning of the parameters is as follows:

...
remove_hf_value2("foo")  # remove foo[1]
remove_hf_value2("foo[*]")  # remove all foo's headers, the same as remove_hf_header("foo[*]");
remove_hf_value2("foo[-1]") # last foo
remove_hf_value2("foo.bar")  # delete parameter
remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
...

Assign value to specified header value / param.

Meaning of the parameters is as follows:

...
assign_hf_value("foo", "gogo")  # foo[1]
assign_hf_value("foo[-1]", "gogo")  # foo[last_foo]

assign_hf_value("foo.bar", "")
assign_hf_value("foo[3].bar", "")
assign_hf_value("foo[*]", "")  # remove all foo's, empty value remains
assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
...

Assign value to specified header. It is expected header in Authorization format (comma delimiters are not treated as multi-value delimiters).

Meaning of the parameters is as follows:

...
assign_hf_value2("Authorization.integrity-protected", "\"yes\"")
assign_hf_value2("foo[-1]", "gogo")  # foo[last_foo]
assign_hf_value2("foo[*].bar", "")  # set empty value (ex. lr)
...

Add value in set if not exists, eg. "Supported: path,100rel".

Meaning of the parameters is as follows:

...
include_hf_value("Supported", "path");
...

Remove value from set if exists, eg. "Supported: path,100rel".

Meaning of the parameters is as follows:

...
exclude_hf_value("Supported", "100rel");
...

Check if value exists in set. Alternate select @hf_value_exists.HF.VALUE may be used. It returns one or zero.

Meaning of the parameters is as follows:

...
if (hf_value_exists("Supported", "100rel")) {

}

if (@hf_value_exists.supported.path == "1") {

}
...