Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Knowing the separate parts of the SIP packet will help you use the correct section of the SMM Web UI. Request Line, Status Line, Headers, Header Parameters, URI and URI parameters are all portions of a SIP packet.

 


Panel
borderStylenone

Caption
0Figure
1SIP Lines and Headers

...

Image Added


 

Panel
borderStylenone

Caption
0Figure
1

Align
aligncenter
Image Removed

SIP Packet Parameters

...

align

aligncenter

Image Modified

The 4 SIP Message Rules

Now that we're familiar with the anatomy of a SIP packet, let's examine the SMM Rules.

This diagram shows each type of SMM Rule and what portion of the SIP packet that type of rule affects.A mapping

Panel
borderStylenone

Caption
0Figure
1Mapping of SMM Rule

...

Types to

...

Portions of SIP

...

center
Align
align

Messages

Image Modified

 

Tip
  • Use Request Rules to change the Request URI Line
  • Status Rules to change the Status Line
  • Header Rules to change SIP headers
  • Raw Rules to change SDP, or any portion of the SIP message not affected by other rules.

...

After selecting the appropriate Rule type, the Rule itself must be configured. Using the diagrams below, you can see which section of each rule corresponds with portions of a SIP message. Once you've identified what needs to be changed, consult the diagrams below to determine which configuration entry to employ to create the desired change.

Request Rule Mapping

 


alignalign
Panel
borderStylenone

Caption
0Figure
1Request Rule Configuration Options

Image Added


 

...

Status Rule Mapping

Panel
borderStylenone

Caption
0Figure
1Status Rule Configuration Options

...

center
Align
align

Image Modified

Header Rule Mapping

Panel
borderStylenone

Caption
0Figure
1SIP Header Rule Configuration Options

...

align

aligncenter

Image Modified

The Raw Rule

Normally used to change the SDP, the Raw Rule will change any regex match found within the entire SIP packet. If a Raw Rule was created to match on sip: and change it to sips:, then every sip: that appears in a packet would be changed to sips: using a single Raw Rule.The

Panel
borderStylenone

...

Align
aligncenter

Caption
0Figure
1Raw Rule

...

Performs a Straight Regex Replacement

Image Modified

Tokens

Tokens are basically variable names which have been pre-assigned to different portions of a SIP Message. Just like the numbers in an incoming SIP packet are mapped into Tranformation Table IEs (Called Number, Calling Number, etc.), various portions of a SIP Packet are mapped into SMM Tokens.

Tokens make it easier for you to know what's being changed. For instance, if you're making a SMM Rule to change the diversion number to be the same as the the calling number, you would use the SMM Rules menu to change the diversion value from the token from.user.userinfo.user (as that is the token that contains the calling number).

Panel
borderStylenone

...

Align
aligncenter

Caption
0Figure
1Tokens are

...

Selected From Various SMM Configuration Items

Image Modified

Token Mapping

Below find a sample mapping of SIP messages sections to their corresponding tokens; x represents a SIP Request Line, Status Line or Header name. For example:

  • The Display Name in a FROM header would be recorded in the from.displayname token.
  • The TO number would be recorded in the to.uri.userinfo.usertoken.

 

Panel
borderStylenone

Caption
0Figure
1Tokens

...

Align
aligncenter

Mapped to

...

Their Corresponding SIP Packet Elements

Image Modified

Image Modified

 

Some of the available tokens are listed below.

...

When you want an SMM to operate only if something specific occurs, then you create a Condition Rule. Condition Rules, which are applied with the Message Rule, can be configured to match specific numbers, tokens, or by regex.

 

Panel
borderStylenone

Caption
0Figure
1Literal Condition Match

...

Image Added

Panel
borderStylenone

Caption
0Figure
1

Align
aligncenter
Image Removed

Token Condition Match

Align
aligncenter

Image Added

Panel
borderStylenone

Caption
0Figure
1

Image Removed

Regex Condition Match

...

center
Align
align

Image Modified

More Information

Info

The SMM feature cannot be used to create a SIP packet. As indicated above, the SMM feature handles a SIP packet either just before or just after the SIP Engine. In either case, an already-existing SIP packet is presented to the SMM function. The SMM function only works on packet it receives--it cannot create a packet.