Description
Feature name |
SipShortCode |
|---|---|
Applicable contexts |
SIP service |
Prerequisite features |
The Short Code feature is a pre-credit check feature that performs number translation of short-codes in the request-URI of the received INVITE request. If the request-URI does include a short-code, then SipShortCode updates the request-URI and To addresses in the received INVITE, using a short-code translation table.
|
The SipShortCode feature will only do analysis if:
Addresses may contain the digits allowed in a global phone number as per RFC 2806. |
Sentinel has a configurable short-code address list, scoped by the Sentinel selection key, which is used for this digit analysis. If a short-code matches an address in the request-URI, then both the request-URI and the To address are updated with a translated address (that corresponds to the short-code).
|
|
The Subsequent features may make additional changes to the request URI, so the final address sent in the |
Leg Manager inputs
| Leg | Name | Type | Format | Description | Behaviour if null/invalid |
|---|---|---|---|---|---|
calledParty |
InviteRequest |
org.jainslee.resources.sip.SipRequest |
See the EasySIP javadoc |
INVITE sent to the called party |
Runtime exception handled by feature runner |
|
The Called Party The Called Party |
Session State and Leg inputs and outputs
Inputs
| Name | Type | Format | Description | Behaviour if null/invalid |
|---|---|---|---|---|
SentinelSelectionKey |
com.opencloud.sentinel.common.SentinelSelectionKey |
selection key (for example, |
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 |
Throw runtime exception, report featureHasFinished |
Error scenarios
| Scenario | Handling |
|---|---|
Sessionstate SentinelSelectionKey is null |
Report featureCannotStart |
Called Party Leg is null |
Throw runtime exception Report featureHasFinished |
Called Party Invite Request is null |
Throw runtime exception Report featureHasFinished |
Sessionstate CallType is null |
Throw runtime exception Report featureHasFinished |
Feature responses
| Response | Reason |
|---|---|
featureCannotStart |
SessionState SentinelSelectionKey is not set |
featureHasFinished |
feature has finished |
Configuration
Short Code feature configuration
| Parameters | Type | Description |
|---|---|---|
MinLength |
Integer |
Minimum short code length |
MaxLength |
Integer |
Maximum short code length |
Example configuration:
| MinLength | MaxLength |
|---|---|
3 |
3 |
Short Code address list configuration
The SipShortCode address list entry is an extension of the standard Address list entry, the addition being the ‘translatedAddress’ field which is used for number translation:
| Parameter | Type | Description |
|---|---|---|
… |
… |
… |
TranslatedAddress |
String |
the value of the short code translated address (in international format) |
Example configuration:
| Address | TranslatedAddress |
|---|---|
100 |
6422987654 |
200 |
6422123456 |
The SipShortCode address is a digit string which can contain any digits valid for the network.
TranslatedAddress is a digit string in international format.
The short code list applies to all subscribers scoped to Sentinel selection key.
Configuration profile naming
| Configuration Profile Table Name | Description | Profile Naming |
|---|---|---|
ShortCodeFeatureConfigProfileTable |
Short code feature configuration |
SentinelSelectionKey (for example, |
${PLATFORMOPERATOR}_SipShortCode_AddressListConfigurationTable |
Address list configuration |
${SELECTIONKEY}:SipShortCode:SipShortCodeAddressList |
${PLATFORMOPERATOR}_SipShortCode_AddressListEntryTable |
Feature specific Address List entry table |
${SELECTIONKEY}:SipShortCode:SipShortCodeAddressList:${ADDRESS} |
|
|
The SipShortCode 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 SipShortCode feature. |
Provisioning interfaces
The feature is provisioned using the Sentinel Features REST API or web interface.
