← Back to plugin index

Number-based Selection SMS Gateway

Description

SMS gateway selection based on phone number.

Allows selecting an SMS gateway based on phone number pattern matching.

Type name
NumberBasedSelectionSmsGateway
Class
com.airlock.iam.core.misc.impl.sms.NumberBasedSelectionSmsGateway
May be used by
Properties
Sms Gateway Selection Options (smsGatewaySelectionOptions)
Description

Defines the mapping between phone numbers and SMS gateways.

When sending an SMS, the phone number is checked against the regex patterns defined in this map, and the first gateway whose corresponding pattern matches the phone number is selected to send the SMS. If no SMS gateway matches the phone number, the default gateway is used.

Note that the phone number is always normalized before checking it against the configured regex patterns meaning all whitespace is removed and the country code is added if it is missing, e.g. "+411234567".

Attributes
Plugin-List
Optional
Assignable plugins
Visible Phone Number Digits In Log (visiblePhoneNumberDigitsInLog)
Description

Defines the number of phone number digits visible in log statements.

Thus, if the value is zero, all digits are masked, if it is large enough, all digits are visible. If set to 3, for example, the logged number looks like ********965.

The default is 100, i.e. showing all digits.

Attributes
Integer
Optional
Default value
100
YAML Template (with default values)

type: NumberBasedSelectionSmsGateway
id: NumberBasedSelectionSmsGateway-xxxxxx
displayName: 
comment: 
properties:
  defaultGateway:
  smsGatewaySelectionOptions:
  visiblePhoneNumberDigitsInLog: 100