Product Documentation

SIP_REQ_T

Sep 12, 2016

Operates on SIP Request.

This topic lists the expressions that are provided by this class.

BODY (uint i)

Operate as Text on the SIP request body. The length of the body is equal to the number in the argument. If there aren't enough characters in the body then the entire body is selected.

Parameters:

i - Body length

Returns: text_t

CALLID

Returns the content of the "Callid" header

Returns: sip_callid_header_t

CONTENT_LENGTH

Returns the length of the SIP request as a number.

Returns: sip_content_length_t

CSEQ

Returns the SIP Cseq number

Returns: num_t

CS_VSERVER

Returns the CS vserver serving the current request.

Returns: vserver_t

FROM

Returns the content of the "From" header

Returns: sip_from_header_t

FULL_HEADER

Returns the entire request header (including the terminating \r\n\r\n)

Returns: text_t

HEADER (text_t header_name)

Returns the contents of the SIP header specified by the String argument. The header name cannot be longer than 32 characters.

Parameters (expressions not allowed):

header_name - Header Name

Returns: sip_header_t

IS_VALID

Returns TRUE if the SIP request is properly formed.

Returns: bool_at

LB_VSERVER

Returns the LB vserver serving the current request.

Returns: vserver_t

METHOD

Returns the SIP method object from the request.

Returns: sip_method_t

TO

Returns the content of the "To" header

Returns: sip_to_header_t

URL

Obtain the SIP URL object from the request. The Text object backing the SIP URL object has the Text Mode set to URLENCODED by default.

Returns: sip_url_t

VERSION

Returns the SIP version.

Returns: sip_version_t

VIA

Returns the content of the "Via" header

Returns: sip_via_header_t