Message Parameter Syntax

The following table describes the syntax used for SIP message parameters.

Message Parameter Syntax

Subject

Description

param.message.sdp.ip

Specifies the address in the SDP.

Note: The parameter can be used for read-write operations in all message-syntax based tables.

param.message.sdp.originusername

Specifies the username in the Origin ('o=') field of the SDP.

Note: The parameter can be used for read-write operations in all message-syntax based tables.

param.message.sdp.ip-for-url

Specifies the address in the SDP. IPv6 addresses are enclosed in square brackets while IPv4 addresses appear without.

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.sdp.rtpmode

Specifies the RTP mode in the SDP.

Note: The parameter can be used for read-write operations in all message-syntax based tables.

param.message.sdp.originaddress

Specifies the origin address in the SDP.

Note: The parameter can be used for read-write operations in all message-syntax based tables.

param.message.sdp.port

Specifies the port in the SDP.

Note: The parameter can be used for read-write operations in all message-syntax based tables.

message.incoming.remote-port

Specifies the remote (peer) port for the source of the message, as a string.

Note:

■ The parameter replaces the old "param.message.address.src.port" parameter.
■ The parameter can only be used for read-only operations in the message-syntax based tables.

message.outgoing.remote-port

Specifies the remote (peer) port for the destination of the message, as a string.

Note:

■ The parameter replaces the old "param.message.address.dst.port" parameter.
■ The parameter can only be used for read-only operations in the message-syntax based tables.

message.incoming.local-port

Specifies the local port for the source of the message, as a string (port on which the message is received).

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

message.outgoing.local-port

Specifies the local port for the destination of the message, as a string (port from which the message is sent).

Note:

■ The parameter can be used for write operations in the Call Setup Rules table and read-only operations in the other message-syntax based tables.
■ It has a non-zero value for the relevant message only after being modified by Call Setup Rules for that message.

param.message.address.src.ip

Specifies the IP address as a string for the source of the message. The IP address is returned as is.

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.dst.ip

Specifies the IP address as a string for the destination of the message. The IP address is returned as is.

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.src.ip-for-url

Specifies the IP address as a string for the source of the message. IPv6 addresses are enclosed in square brackets while IPv4 addresses appear without.

An example of a returned IPv6 address is [2620:0:2ef0:7070:250:60ff:fe03:32b7]. This is useful for creating a SIP URI, which would look like "sip:6000@[2620:0:2ef0:7070:250:60ff:fe03:32b7]:5060;transport=tcp"

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.dst.ip-for-url

Specifies the IP address as a string for the destination of the message. IPv6 addresses are enclosed in square brackets while IPv4 addresses appear without.

An example of a returned IPv6 address is [2620:0:2ef0:7070:250:60ff:fe03:32b7]. This is useful for creating a SIP URI, which would look like "sip:6000@[2620:0:2ef0:7070:250:60ff:fe03:32b7]:5060;transport=tcp"

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.src.<transporttype>

Specifies the transport type as a string for the source of the message, where <transporttype> can be  one of the following:

■ UDP
■ TCP
■ TLS

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.dst.<transporttype>

Specifies the transport type as a string for the destination of the message, where <transporttype> can be one of the following:

■ UDP
■ TCP
■ TLS

Note: The parameter can only be used for read-only operations in the message-syntax based tables.

param.message.address.src.sipinterface

Specifies the SIP Interface ID on which the message is received (source).

Note: The parameter can only be used for read-only operations ('Action Value' and 'Condition' fields only) in the message-syntax based tables.

param.message.address.dst.sipinterface

Specifies the SIP Interface ID on which the message is sent (destination).

Note: The parameter can only be used for read-only operations ('Action Value' and 'Condition' fields only) in the message-syntax based tables.