Description

Feature name

SipPrefixAndSuffixAnalysis

Applicable contexts

SIP Service

SAS Support

No

Prerequisite features

Determine Call Type Feature

The SIP prefix and suffix analysis feature performs prefix and suffix digit analysis on the request-URI of the received INVITE request.

Note

The SipPrefixAndSuffixAnalysis feature will only do analysis if;

  • the request-URI is a tel URL

  • the request-URI is a SIP URI, where the user part of the URI is a digit string.

Addresses may contain the digits allowed in a global phone number as per RFC 2806.

Sentinel has a set of configurable prefix and suffix address lists, scoped by Sentinel selection key, which are used for this digit analysis.

  • If a prefix or suffix matches an address in the request-URI, then the directive associated with the prefix (or suffix) is applied.

    • The directives are: strip prefix/suffix or retain prefix/suffix, and set session parameter with configured value.

  • If the directive is strip, then the request-URI is updated in the outgoing INVITE.

Note

The SipPrefixAndSuffixAnalysis feature will not do any analysis if the CallType is EmergencyCall or MobileTerminating.

Subsequent features may make additional changes to the request URI, so the final address sent in the INVITE will be dependent on those features.
Parameter Description

Address

Prefix or suffix to match

Description

ListId

  • ${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialPrefixList

  • ${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialSuffixList

ParameterName

Session state field to set (for example, AnnouncementID). Field name is in Java identifier format, and follows the rules of Java identifiers (such as not being a Java keyword).

ParameterType

boolean, integer, long, string

ParameterValue

Value to write to session state. Must be formatted correctly for the value specified in the Parameter Type field

PrefixDirective

strip, retain

Example of prefix analysis configuration:

Prefix/suffix address Directive Session Parameter Parameter Type Parameter Value Description

1234

STRIP

CLI

String

SUPPRESS

555

STRIP

TARIFF

String

Cheap-International-Calling

*591

STRIP

PROFILE

Integer

1

Profile selection

*592

STRIP

PROFILE

Integer

2

Profile selection

*593

STRIP

PROFILE

Integer

3

Profile selection

*594

STRIP

PROFILE

Integer

4

Profile selection

.

STRIP

Strip ST (end of pulsing) digit
Note Prefixes and suffixes may contain the digits allowed in a global phone number as per RFC 2806.

Leg Manager inputs

Leg Name Type Format Description Behaviour if null/invalid

calledParty

InviteRequest

org.jainslee.resources.sip.SipRequest

See Easysip javadoc

INVITE sent to the called party

Runtime exception handled by feature runner
Note

The Called Party INVITE request is fetched from the called party Leg via the LegManager API.

The Called Party INVITE request is updated via the LegManager API.

Session state inputs and outputs

Inputs

Name Type Format Description Behaviour if null/invalid

SentinelSelectionKey

com.opencloud.sentinel.common.SentinelSelectionKey

selection key (for example, <platform>::::)

For selecting configuration data

Report featureCannotStart, featureHasFinished

CallType

com.opencloud.sentinel.common.CallType

One of: MobileOriginating, MobileTerminating, MobileForwarded, NetworkInitiated, EmergencyCall

Session type of this call for determining whether to analyse the INVITE

Report featureCannotStart, featureHasFinished

Outputs

Name Type Format Description

Other session state fields

see Description

see Description

This feature can update other session state fields according to configuration data when a prefix or suffix match is found

Error scenarios

Scenario Handling

Sessionstate SentinelSelectionKey is null

Report featureCannotStart

Attempt to set non-existent SessionState parameter

Report featureFailedToExecute

Feature responses

Response Reason

featureCannotStart

SessionState SentinelSelectionKey is not set

featureFailedToExecute

Attempt to set non-existent SessionState parameter

featureHasFinished

feature has finished

Configuration

Prefix and Suffix Analysis uses Sentinel AddressLists for configuration data. See Address Lists on how to provide the configuration data.

Configuration profile naming

Configuration Profile Table Name Description Profile Naming

${PLATFORMOPERATOR}_PrefixAndSuffixAnalysisFeature_AddressListConfigurationTable

Address list configuration

${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialPrefixList or ${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialSuffixList

${PLATFORMOPERATOR}_PrefixAndSuffixAnalysisFeature_AddressListEntryTable

Feature specific Address List entry table

${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialPrefixList:${ADDRESS} or ${SELECTIONKEY}:SipPrefixAndSuffixAnalysis:SipSpecialSuffixList:${ADDRESS}
Note The SipPrefixAndSuffixAnalysis feature address list configuration uses the same profile tables as the SS7 version of the feature. The names of the address lists are, however, particular to the SipPrefixAndSuffixAnalysis feature.

Provisioning interfaces

The feature is provisioned using the Sentinel Features REST API or web interface.

Previous page Next page
Sentinel Express Version 3.1.0