SMM Action Operation Types

add

Add a header, parameter, token or message body using configured value.

addDigits

This operation only applies to parameters calling party number, called party number, called IN number, location number, redirection number, original called number, redirecting number, connected number of generic number. This operation can be used to either add or replace the digits within these parameters. The operator needs to create a variable containing the ASCII string of characters; this can either be hardcoded or populated based on the contents of a SIP header, e.g. R-URI.

As part of this operation, the ASCII string of digits are converted into Binary Coded Decimal (BCD) format so the odd/even indicator field within the ISUP parameter is set correctly. If the parameter already contains digits, they are replaced with the new information.

These parameters can be created in two step:

1. use the add action to create the fixed part of the parameter
2. use the addDigits action to add in the digits.

If the addDigits operation is attempted and the associated parameter does not already exist in the message then it will fail. If the ASCII string contains a + then this will be dropped as part of the conversion as there is no mapping into the ISUP parameter.

For examples and additional details, refer to SIP-I Support.

append

Append a configured value to a variable.

For examples and additional details, refer to SIP-I Support.

createuri

Create a SIP URI using following sub-parameters. The SIP URI is stored in the specified variable. The "to" type for this operation is a variable.

uriDisplayName

URI display name (string or variable)
[optional]

uriHostName

URI host name (string, variable or global variable).

uriHostPort

URI host port (string, variable or global variable)
[optional]

uriScheme

URI scheme (string or variable).

uriUserName

URI user name (string or variable).

delete

Delete a header, parameter or a token.

For examples and additional details, refer to SIP-I Support.

NOTE: The "delete" operation type is not applicable for the Action type variable.

getDigits

This operation only applies to parameters calling party number, called party number, called IN number, location number, redirection number, original called number, redirecting number, and connected number of generic number. The operation is used to convert ISUP BCD format to regular number format (i.e., can be used to retrieve the digits in ASCII string format for the specified parameter to a variable).

For examples and additional details, refer to SIP-I Support.

ignore

Drop a message silently on inbound leg, do not send on the outbound leg.

modify

Modify header value, parameter, and token using configured value or regular expression-based text manipulation, or else modify messageBody content using regular expression based text manipulation only.

For examples and additional details, refer to SIP-I Support.

regappend

Insert configured value after the matching substring.

regdel

Delete the matching substring.

regpostdel

Delete the part after the matching substring.

regpostsub

Replace part after matching substring using configured value.

regpredel

Delete the part before the matching substring.

regprepend

Insert configured value before the matching substring.

regpresub

Replace part before matching substring using configured value.

regstore

Store the matching substring to a variable or the regular expression sub-expression matches into a range of variables.

regsub

Replace the matching substring using configured value.

reject message

Reject a message by the value configured in the response code (applies to request messages only).

reject responseCode

100-699

rename

Rename a header.

store

Store a parameter, a variable or header value into a variable.

For examples and additional details, refer to SIP-I Support.

Tear down the call on both the legs (egress and ingress) by sending the necessary request or response based on the current call state. Once the SMM rule is applied and the action command teardown is selected, the action is propagated to User-Agent Server (UAS) and User-Agent Client (UAC) layers with the required data. The appropriate response or request is initiated on both the legs to tear down the call based on the call state.

NOTE: The tear down action is applicable only for the message type.

NOTE: Once the call is tear down on both the legs, the disconnect value 203 is added to the CDR. This signifies that the call is disconnected by the SMM.

undefined

Default setting.