uri Module

Jan Janak

FhG FOKUS

Edited by

Jan Janak

Bogdan-Andrei Iancu


Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.4. Exported Functions
1.4.1. is_user(username)
1.4.2. has_totag()
1.4.3. uri_param(param)
1.4.4. uri_param(param,value)
1.4.5. add_uri_param(param)
1.4.6. tel2sip()
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. is_user usage
1-2. has_totag usage
1-3. uri_param usage
1-4. uri_param usage
1-5. add_uri_param usage
1-6. tel2sip usage

Chapter 1. User's Guide

1.1. Overview

Various checks related to SIP URI.


1.2. Dependencies


1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSER with this module loaded:

  • None.


1.4. Exported Functions

1.4.1. is_user(username)

Check if the username in credentials matches the given username.

Meaning of the parameters is as follows:

  • username - Username string.

This function can be used from REQUEST_ROUTE.

Example 1-1. is_user usage

...
if (is_user("john")) {
	...
};
...

1.4.2. has_totag()

Check if To header field uri contains tag parameter.

This function can be used from REQUEST_ROUTE.

Example 1-2. has_totag usage

...
if (has_totag()) {
	...
};
...

1.4.3. uri_param(param)

Find if Request URI has a given parameter with no value

Meaning of the parameters is as follows:

  • param - parameter name to look for.

This function can be used from REQUEST_ROUTE.

Example 1-3. uri_param usage

...
if (uri_param("param1")) {
	...
};
...

1.4.4. uri_param(param,value)

Find if Request URI has a given parameter with matching value

Meaning of the parameters is as follows:

  • param - parameter name to look for.

  • value - parameter value to match.

This function can be used from REQUEST_ROUTE.

Example 1-4. uri_param usage

...
if (uri_param("param1","value1")) {
	...
};
...

1.4.5. add_uri_param(param)

Add to RURI a parameter (name=value);

Meaning of the parameters is as follows:

  • param - parameter to be appended in "name=value" format.

This function can be used from REQUEST_ROUTE.

Example 1-5. add_uri_param usage

...
add_uri_param("nat=yes");
...

1.4.6. tel2sip()

Converts RURI, if it is tel URI, to SIP URI. Returns true, only if conversion succeeded or if no conversion was needed (like RURI was not tel URI.

This function can be used from REQUEST_ROUTE.

Example 1-6. tel2sip usage

...
tel2sip();
...

Chapter 2. Developer's Guide

The module does not provide any API to use in other OpenSER modules.


Chapter 3. Frequently Asked Questions

3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?

3.1. Where can I find more about OpenSER?

Take a look at http://openser.org/.

3.2. Where can I post a question about this module?

First at all check if your question was already answered on one of our mailing lists:

E-mails regarding any stable OpenSER release should be sent to and e-mails regarding development versions should be sent to .

If you want to keep the mail private, send it to .

3.3. How can I report a bug?

Please follow the guidelines provided at: http://openser.org/bugs.