SMS Valve

Delivers a text-message (SMS).

Use this valve to send messages via SMS.

Configuration

Valve name: SendBySms | SmsSender

Properties

Name	Description	Default value	Mandatory	Expanded
http_destination	ID of the internal http client used to talk with the SMS backend.	"default"
api_username	Username for the API backend.	N/A
api_password	Password for the API backend.	N/A
api_identifier	Identifier. This value is presented as the "sender" of the text-message.	N/A
username_parameter	Only used for logging and events.	"${request.User-Name}"
message_parameter	Parameter containing the message.	"Your otp is: ${item.generated_otp_value}"
mobile_parameter	Parameter containing the receiving mobile number.	"${item.mobile}"
use_flash_message	To send message as flash.	false
clean_mobile	Removes unwanted characters.	true
recipient_prefix	Prefixes mobile number if it starts with '0'.	"+46"
force_prefix	Always add prefix.	true
remove_leading_plus	Remove +	false

Example

{
    "name": "SendBySms",
    "enabled": true,
    "config": {
        "api_username": "<api_username>",
        "api_password": "<api_password>",
        "api_identifier": "<api_identifier>",
        "username_parameter": "${request.username}",
        "message_parameter": "Your otp is: ${item.generated_otp_value}",
        "mobile_parameter": "${item.mobile}",
        "use_flash_message": true
    }
}