8.5 Configuring SMS Notification Settings

Self Service Password Reset sends SMS notifications many different user actions. For example, Self Service Password Reset sends SMS messages for password recovery and new user account verification.

You must have an SMS gateway to send SMS messages to the users and you must configure Self Service Password Reset to communicate to the SMS gateway service for SMS messages to be sent to the users. By default, Self Service Password Reset does not contain any configured SMS messages. You must configure the SMS messages to have the messages automatically sent to the users. If you do not configure both items, the system cannot send SMS messages.

8.5.1 Configuring the SMS Gateway

For Self Service Password Reset to send SMS notifications, you must have access to an HTTP or HTTPS based SMS gateway service. You must configure Self Service Password Reset to communicate to the SMS gateway service before you can send SMS messages.

To configure the SMS gateway:

  1. Log in to Self Service Password Reset at https://dns-name/sspr as an administrator.

  2. In the toolbar, click your name.

  3. Click Configuration Editor.

  4. Click Settings > SMS > SMS Gateway.

  5. Configure the following settings:

    Maximum SMS Queue Age

    Specify the maximum age (in seconds) an SMS can wait in the local send queue. If an SMS is in the send queue longer than this time, the system discards it. SMS messages only persist in the send queue if there is an IO or network error to the SMS gateway server while sending the message.

    SMS Gateway

    Specify the URL of the SMS service provider.

    SMS Gateway User

    Specify the user name of the SMS gateway.

    SMS Gateway Password

    Specify the password for the SMS gateway user.

    HTTP(S) Method

    Specify the HTTP or HTTPS protocol method that you want to use for sending SMS messages. It is either POST or GET.

    SMS Gateway Authentication Method

    Select a method from the list that the SMS gateway uses for authentication.

    SMS Request Data

    Specify the details required to send an SMS message. You can use the following codes:

    • %USER%: authentication user name

    • %PASS%: authentication password

    • %SENDERID%: sender’s identification

    • %TO%: recipient’s phone number

    • %REQUESTID%: randomly generated request identifier

    • %MESSAGE%: the SMS message

    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:

    • application/x-www-form-urlencoded: HTTP form data

    • text/plain: Plain ASCII data

    • text/xml: XML document

    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. The SMS data might need encoding or escaping.

    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 of the SMS text. Some services allow texts longer than one message (generally 140 bytes). If the text is longer than the configured maximum, the system makes multiple requests.

    Response Regular Expressions

    Specify the regular expression that you can use to determine whether the system sent the SMS successfully to the gateway. If the response matches any of the expressions, Self Service Password Reset considers the transmission successful. If you do not specify any expressions, Self Service Password Reset assumes that all transmissions are successful.

    If the response matches none of the expressions, Self Service Password Reset retries the SMS later (default 30 seconds). Use the Maximum SMS Queue Age option to limit the number of retries.

    NOTE:The string must match an entire line. Use .* to match anything after the required texts.

    SMS Sender ID

    Specify the ID of the sender for the SMS message. 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 Self Service Password Reset uses 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, see.

    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.

    Use URL Shortener

    Select this option 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.

    Successful HTTP Result Codes

    Specify the HTTP result codes that are considered successful send attempts.

    Enable URL Shortening Service Class

    Specify the URL Shortening Service class name. This is the Java full class name that implements a short URL service. The corresponding JAR or ZIP file must be included in the classpath, typically in the WEB-INF/lib directory or the lib directory of the application server.

    Configuration Parameters for URL Shortening Service

    Specify the Name/Value settings used to configure the selected URL shortening service. For example, use an API key, a user name, a password or a domain name. The settings must be in name=value format, where name is the key value of a valid service setting.

  6. In the toolbar, click Save changes.

8.5.2 Configuring the SMS Messages

After you have configured the SMS gateway service to communicate with Self Service Password Reset, you must configure the SMS messages to be sent to the users. You must configure the SMS text for each setting and locale you want to use.

To configure the SMS messages:

  1. Log in to Self Service Password Reset at https://dns-name/sspr as an administrator.

  2. In the toolbar, click your name.

  3. Click Configuration Editor.

  4. Click Settings > SMS > SMS Messages.

    NOTE:You can also configure all of the SMS message settings in a different language. Click Add Locale, then select the required language from the list.

    Forgotten Password SMS Text

    Specify the text of the SMS message Self Service Password Reset sends during the forgotten password token process.

    Forgotten Password New Password SMS Text

    Specify the text of SMS message Self Service Password Reset sends when the users create new passwords during forgotten password process.

    New User Verification SMS Text

    Customize the text of the SMS messages Self Service Password Reset sends during the new user verification process.

    Help Desk Verification SMS Text

    Specify the text of SMS message Self Service Password Reset sends during the Help Desk token verification process.

    Activation Token SMS Text

    Customize the text of the SMS message that contains the token Self Service Password Reset sends during the activation process.

    Activation SMS Text

    Customize the text of the SMS message that Self Service Password Reset sends after a successful activation.

    Forgotten User Name SMS Text

    Specify the text of the SMS message Self Service Password Reset sends upon a successful forgotten user name sequence, if you configured the Forgotten User Name setting.

    Update Profile SMS Verification Text

    Specify the text of the SMS message Self Service Password Reset sends during a profile update of the SMS phone number verification.

  5. In the toolbar, click Save changes.