MSPL built-in functions
Applies to: Lync 2013 | Lync Server 2013
MSPL built-in functions
The Microsoft SIP Processing Language (MSPL) provides several built-in functions that are useful for common SIP application tasks, such as message forking, the creation of proxy objects, and parameter parsing.
Certain functions, such as BeginFork/Fork/EndFork, must be called in a certain order; otherwise, an error is generated. Other functions must be called only when the message being processed is a request or a response; otherwise, a critical error is also generated. If 10 critical errors of this type are generated during runtime, the application is be disabled.
MSPL defines the built-in functions described in the following table.
Function |
Description |
|---|---|
Adds a header to the current SIP message. |
|
Initializes a forking operation for the current message. |
|
Indicates whether the user is enabled for a specified option. |
|
Concatenates a sequence of supplied string values, in parameter order. |
|
Searches for an occurrence of one specified string within another. |
|
Dispatches an event to a supplied event handler within the application. |
|
Indicates whether a message was successfully queued. |
|
Indicates whether a specified domain is supported by the registrar on the Microsoft Lync Server 2013 computer that runs this script. |
|
Sends the current set of forked messages using the forking proxy initialized with BeginFork. |
|
Determines whether two supplied strings are equal. |
|
Creates a forked copy of the current message with its request URI field set to the supplied URI string. |
|
Returns the display name associated with a supplied SIP address. |
|
Returns a string representation of the instance ID from the GRUU. |
|
Returns a collection of strings containing the values associated with the supplied header name in the current SIP message. |
|
Returns the hostname portion of a supplied SIP URI. |
|
Returns the value of a named parameter within a SIP header string. |
|
Returns the port specified in a SIP URI. |
|
Returns the scheme associated with the SIP URI. |
|
Returns the URI portion of a SIP address, such as the address found in the From or To header field of a SIP message. |
|
Returns the named parameter value found in a supplied SIP URI. |
|
Extracts user@hostname from a URL. |
|
Returns the user name portion of a SIP URI. |
|
Computes a hash value from a string. |
|
Returns an index of the first occurrence of a specified string. |
|
Indicates whether a specified URI is formatted as a GRUU. |
|
Indicates whether a specified FQDN points to a local Lync Server 2013 Standard Edition (SE) or Enterprise Edition (EE) (true) or not (false). |
|
Introduced in Microsoft Lync Server 2010, this function indicates whether the Presence Agent Server is online (true) or not (false). The Presence Agent Server provides the presence and conferencing service. |
|
Indicates whether a specified URI points to a phone. |
|
Returns the number of characters in a string. |
|
Writes an entry or entries to the specified server log. |
|
Proxies the current SIP request to the supplied URI. |
|
Proxies the current SIP response to the next destination in its route. |
|
Fetches an item published in a specified enhanced presence container. |
|
Fetches an item published in a specified enhanced presence container, which is selected based on the access control lists associated with the indicated Subscriber and ExternalSourceNetwork. |
|
Indicates whether a specified domain belongs to a specified domain type. |
|
Queries the server registrar for the network endpoints associated with a specified user and hostname combination. |
|
Returns the fully qualified domain name of the home server for a specified SIP user. |
|
Returns an XML fragment containing the policy assigned to the specified user based on server configuration. |
|
Generates a SIP response to the current request message with the supplied status code and reason phrase. |
|
Adds or sets a specific parameter value in a SIP header. |
|
Splits a string on a specified separator substring and returns a string collection. |
|
Tests whether one domain is a subdomain of another specified domain. |
|
Extracts a specified string from a larger string. |
|
Determines whether a specific SIP method is supported by the application. |