Message (MSPL)

The Message built-in class defines a basic SIP message type, and contains the parsed To and From headers along with the content block and the associated transaction. This class serves as the base parent class for the Request and Response classes.

Syntax

  Copy imageCopy Code 
class Message {
		 string From;
		 string To;
		 string Content;
		 bool Authenticated;
		 Transaction Transaction;
		 string TlsPeer;
		 MessageOrigin Origin;
		 ExternalSourceType ExternalSourceType;
		 ExternalSourceNetwork ExternalSourceNetwork;
		 string Stamp;
		 string StampPool;
}

Fields

The Message class defines the following fields.

Field

Description

From

Data type: string

Contains the value specified in the From header of the SIP message, represented as a Unicode string. This field contains the SIP address of the sender, along with any associated parameters.

To

Data type: string

Contains the value specified in the To header of the SIP message, represented as a Unicode string. This field commonly contains the SIP address (or addresses) of the recipient (or recipients), along with any associated parameters.

Content

Data type: string

Contains the data in the Content header, represented as a string.

Authenticated

Data type: bool

Specifies true if the sender is authenticated; false if it is not.

Transaction

Data type: Transaction

Contains the Transaction class associated with this message.

TlsPeer

Data type: string

Captures the fully qualified domain name (FQDN) of the previous hop from which the message was received.

Origin

Data type: MessageOrigin

Specifies the origin of a SIP message. It may have one of the following values:

Value

Description

LocalMachine

The message was created by this or other local applications or server components.

NetworkInternal

The message arrived at the internal edge of this Access Edge Server.

NetworkExternal

The message arrived at the external edge of this Access Edge Server.

NetworkUnknown

The message came from a connection that was not configured as an internal or external connection.

Only Access Proxies are aware of network edges. For other servers the value for messages received from the network will be "NetworkUnknown".

ExternalSourceType

Data type: ExternalSourceType

Enumeration that indicates the nature of the source of the message. Valid if the message arrived from the external network. Valid on Internal servers only.

ExternalSourceNetwork

Data type: ExternalSourceNetwork

Enumeration that indicates the type of network from which the message originated. Valid if the message arrived from the external network. Valid on Internal servers only.

Stamp

Data type: string

Marks a message with the supplied string, which can be read by either this application or downstream instances of this application.

This property retrieves only the first stamp on a message. If there are multiple stamps on a message, use the GetHeaderValues method to retrieve all the headers, then loop through the headers to find the appropriate stamp.

StampPool

Data type: string

Retrieves the name of the server pool in which the last stamp for this application was set.