SIS 3.1.0 :: SIS Overview and Concepts :: SIP-Specific Variables

The conditional expressions included in SIS macros, triggers, and compositions may use any of the following variable names to reference parameters of request events or other values computed during the course of call processing.

Request variables

All requests contain these variables.

method

Description	The SIP method of the request.
Valid values	Any SIP method name, for example INVITE or REGISTER.
Type	String
Assignable?	NO

Description

The SIP method of the request.

Valid values

Any SIP method name, for example INVITE or REGISTER.

Type

String

Assignable?

uri

Description	The Request-URI of the request. Contains additional URI variables.
Valid values	A valid SIP or TEL URI.
Type	String
Assignable?	YES

Description

The Request-URI of the request.
Contains additional URI variables.

Valid values

A valid SIP or TEL URI.

Type

String

Assignable?

YES

<header-name>

Description	Any header name may be used as a variable, for example, `From`, `To`, `Route`, or `Call-ID` (case-insensitive). This evaluates to the string representation of the first header value. Contains additional header variables.
Valid values	A valid SIP header (according to the header’s syntax).
Type	String
Assignable?	YES

Description

Any header name may be used as a variable, for example, From, To, Route, or Call-ID (case-insensitive). This evaluates to the string representation of the first header value.
Contains additional header variables.

Valid values

A valid SIP header (according to the header’s syntax).

Type

String

Assignable?

YES

message-body

Description	The message body of the request, if it has a content-type that can be represented as a string, such as `application/sdp` or `text/plain`.
Valid values	Any SDP or text content.
Type	String
Assignable?	NO

Description

The message body of the request, if it has a content-type that can be represented as a string, such as application/sdp or text/plain.

Valid values

Any SDP or text content.

Type

String

Assignable?

Header variables

Header variables may contain the following attributes. For example, route.uri will return the URI in the Route header. The property from.param.tag will return the tag parameter in the From header.

<header-name>.uri

Description	If the header is an address header, then this evaluates to the URI of the header’s address. Examples of address headers are `From`, `To`, `Route`, `Contact`, and `P-Asserted-Identity`. Contains additional URI variables.
Valid values	A valid SIP or TEL URI.
Type	String
Assignable?	YES

Description

If the header is an address header, then this evaluates to the URI of the header’s address. Examples of address headers are From, To, Route, Contact, and P-Asserted-Identity.
Contains additional URI variables.

Valid values

A valid SIP or TEL URI.

Type

String

Assignable?

YES

<header-name>.display-name

Description	If the header is an address header, then this evaluates to the display-name of the header’s address.
Valid values	Any string.
Type	String
Assignable?	NO

Description

If the header is an address header, then this evaluates to the display-name of the header’s address.

Valid values

Any string.

Type

String

Assignable?

<header-name>.param.<param-name>

Description	If the header contains optional parameters, then this property evaluates to the string value of the named parameter.
Valid values	Any string.
Type	String
Assignable?	YES

Description

If the header contains optional parameters, then this property evaluates to the string value of the named parameter.

Valid values

Any string.

Type

String

Assignable?

YES

<header-name>.count

Description	Returns the number of header values present in the message.
Type	Integer
Assignable?	NO

Description

Returns the number of header values present in the message.

Type

Integer

Assignable?

URI variables

All URI variables may contain the following attributes. For example, uri.host will return the host part of the Request-URI. To extract the user part of the To header, the property used would be to.uri.user.

uri.scheme

Description	The URI scheme.
Valid values	Possible values are `sip`, `sips` or `tel`.
Type	String
Assignable?	NO

Description

The URI scheme.

Valid values

Possible values are sip, sips or tel.

Type

String

Assignable?

uri.user

Description	For SIP URIs, the user part of the URI. For Tel URLs this is undefined.
Valid values	A valid SIP user name.
Type	String
Assignable?	YES

Description

For SIP URIs, the user part of the URI. For Tel URLs this is undefined.

Valid values

A valid SIP user name.

Type

String

Assignable?

YES

uri.host

Description	For SIP URIs, the host part of the URI. For Tel URLs this is undefined.
Valid values	A host name or IP address.
Type	String
Assignable?	NO

Description

For SIP URIs, the host part of the URI. For Tel URLs this is undefined.

Valid values

A host name or IP address.

Type

String

Assignable?

uri.port

Description	For SIP URIs, the port number of the URI. If the URI does not specify a port, the default values are `5060` for UDP and TCP, or `5061` for TLS. For Tel URLs this is undefined.
Valid values	A valid SIP port number.
Type	Integer
Assignable?	YES

Description

For SIP URIs, the port number of the URI. If the URI does not specify a port, the default values are 5060 for UDP and TCP, or 5061 for TLS. For Tel URLs this is undefined.

Valid values

A valid SIP port number.

Type

Integer

Assignable?

YES

uri.tel

Description	For Tel URLs, this is the phone number with visual separators removed. For SIP URIs, this is the value of the user part only if the parameter `user=phone` is present, otherwise it is not defined.
Valid values	A valid RFC2806 phone number.
Type	String
Assignable?	YES

Description

For Tel URLs, this is the phone number with visual separators removed. For SIP URIs, this is the value of the user part only if the parameter user=phone is present, otherwise it is not defined.

Valid values

A valid RFC2806 phone number.

Type

String

Assignable?

YES

uri.param.<param-name>

Description	If the URI contains optional parameters, then this property evaluates to the string value of the named parameter.
Valid values	Any string.
Type	String
Assignable?	YES

Description

If the URI contains optional parameters, then this property evaluates to the string value of the named parameter.

Valid values

Any string.

Type

String

Assignable?

YES

Examples

The following table presents examples of using SIP-specific variables, and what they return.

uri.user

Example	INVITE sip:alice@foo.com SIP/2.0
Returns	`alice` the user part of the Request-URI

Example

 INVITE sip:alice@foo.com SIP/2.0

Returns

alice
the user part of the Request-URI

from.uri.user

Example	From: <sip:joe@abc.com>
Returns	`joe` the user part of the `From` header’s URI.

Example

 From: <sip:joe@abc.com>

Returns

joe
the user part of the From header’s URI.

to.uri.host

Example	To: <sip:fred@acme.com>
Returns	`acme.com` the host part of the `To` header’s URI

Example

 To: <sip:fred@acme.com>

Returns

acme.com
the host part of the To header’s URI

contact.param.expires

Example	Contact: sip:bob@10.0.0.1;expires=3600
Returns	`3600` the value of the `expires` parameter in the `Contact` header

Example

 Contact: sip:bob@10.0.0.1;expires=3600

Returns

3600
the value of the expires parameter in the Contact header

p-asserted-identity.uri

Example	P-Asserted-Identity: <sip:mary@company.com>
Returns	`sip:mary@company.com` the URI in the `P-Asserted-Identity` header

Example

 P-Asserted-Identity: <sip:mary@company.com>

Returns

sip:mary@company.com
the URI in the P-Asserted-Identity header

Previous page Next page