SSPR sends SMS notifications for the following actions:
Password recovery
New user account verification
You can configure settings of SMS messages. You should configure SMS text for each configured setting and locale. Messages will be delivered using the configured short message service gateway. For enabling SSPR to send SMS notifications, you need to have access to an HTTP or HTTPS based SMS gateway service.
To configure SMS notification, perform the following steps:
In Configuration Editor, click Settings > SMS.
Click View > Always Show Advanced Settings to see and configure the advanced settings.
Configure the following settings:
Field |
Description |
---|---|
User SMS Number Attribute |
Specify the user LDAP attribute containing the user's mobile phone number for SMS. |
SMS Gateway |
Specify the URL of the SMS service provider. |
SMS Gateway User |
Specify the user name of the SMS gateway. |
SMS Gateway Password |
Click Set Password to configure a password for the SMS gateway. |
HTTP(S) Method |
Specify the HTTP or HTTPS protocol method that you want to use for sending SMS messages. |
SMS Gateway Authentication Method |
Select a method from the list that the SMS gateway will use for authentication. |
SMS Request Data |
Specify the details required to send an SMS message. You can use the following codes:
Example format: user=%USER%&pass=%PASS%&to=%TO%&msg=%MESSAGE% |
SMS Data Content Type |
Specify the content type of the POST data. This is the mime type for the content. This only applies if the HTTP(S) Method is POST. Common values include:
You can also append a character set. For example, application/x-www-form-urlencoded; charset=utf-8: HTTP form data in UTF-8 encoding |
SMS Data Content Encoding |
Select the type of encoding for the SMS data. For more information, see Apache Commons JavaDocs. |
SMS Gateway HTTP Request Headers |
Specify any additional HTTP request headers for the SMS request. For example, SOAPAction for SOAP messages. |
Maximum SMS Text Length |
Specify the maximum length for the SMS text. Some services allow texts longer than one message (generally 140 bytes). If the text is longer than the configured maximum, multiple requests will be made. |
Response Regular Expressions |
Specify the regular expression. Using the regular expressions, you can determine whether the SMS has been sent successfully.
NOTE:The string must match an entire line. Use .* to match anything after the required texts. |
SMS Sender ID |
Specify the sender’s identification. You can use alphanumerical values in this identification. If you leave this field blank, the provider uses a default or anonymous sender identification. SMS provider validates the sender ID. Contact your SMS provider for values that you can use as sender identification. |
SMS Phone Number Format |
Select a phone number format from the list that SSPR will use while sending SMS. |
Default SMS Country Code |
Specify the default country code for SMS phone numbers. Set to 0 to disable. For a list of country codes, seehttp://countrycode.org/. |
Request ID Characters |
Specify the characters that you want to be included in the random string generated by SMS Request Data. |
Request ID Length |
Specify the length of the random string generated by SMS Request Data. |
Challenge Token SMS Text |
Customize the text that SSPR sends through SMS during forgotten password token process. |
Challenge New Password SMS Text |
Customize the text that SSPR sends through SMS with new password during the forgotten password process. |
new User Verification SMS Text |
Customize the text that SSPR sends through SMS during new user verification process. |
Activation Token SMS Text |
Customize the text of the token SMS that SSPR sends during the activation process. |
Activation SMS Text |
Customize the text of SMS that SSPR sends after a successful activation. |
Maximum SMS Queue Age |
Specify the maximum age, in seconds, an SMS can wait in the send queue. If an SMS is in the send queue longer than this time, system discards it. SMS messages persist in the send queue if there is an I/O or network error in the SMS gateway server while sending the message. |
Use URL Shortner |
Select this check box to use a URL shortener service such as tinyurl.com, bit.ly, and goo.gl. This enables searching the SMS text for http and https URLs and replaces them with a shortened version. |
Click Actions > Save.