Product Documentation

SIP_RES_T

Sep 12, 2016

Operates SIP Response.

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

BODY (uint i)

Operate as Text on the SIP response 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: text_t

CONTENT_LENGTH

Returns the length of the SIP response as a number.

Returns: sip_content_length_t

CSEQ

Returns the SIP Cseq number

Returns: num_t

FROM

Returns the content of the "From" header

Returns: sip_from_header_t

FULL_HEADER

Returns the entire response 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_GLOBAL_FAILURE

Returns True if response code is 6xx.

Returns: bool_at

IS_PROVISIONAL

Returns True if response code is 1xx.

Returns: bool_at

IS_REDIRECT

Returns True if response code is 3xx

Returns: bool_at

IS_REQUEST_FAILURE

Returns True if response code is 4xx.

Returns: bool_at

IS_SERVER_FAILURE

Returns True if response code is a 5xx.

Returns: bool_at

IS_SUCCESSFUL

Returns True if response code is 2xx.

Returns: bool_at

IS_VALID

Returns TRUE if the SIP response is properly formed.

Returns: bool_at

METHOD

Returns the SIP method. this is extracted from the Cseq header in the response.

Returns: sip_method_t

STATUS

Returns the SIP response status code.

Returns: num_t

STATUS_MSG

Returns the SIP response status message.

Returns: text_t

TO

Returns the content of the "To" header

Returns: sip_to_header_t

VERSION

Returns the SIP version.

Returns: sip_version_t

VIA

Returns the content of the "Via" header

Returns: sip_via_header_t