8.9 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.9.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.

Self Service Password Reset allows you to configure multiple SMS gateway services. You would do this if the first service is not available for any reason.

For security reasons, we recommend that you always use an HTTPS bases SMS gateway. Self Service Password Reset imports the trusted certificate for the SMS gateway for you through the SMS Gateway Certificates setting in the Configuration Editor.

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. Specify the following details:

    Parameter

    Description

    SMS Gateway

    Specify the SMS gateway URL in the following format:

    https://<api-of-sms-provider>/<api-doc-creation-date>/Accounts/<account-SID>/Messages.xml

    For example: https://api.twilio.com/2019-07-01/Accounts/AMwqeiu0283749cabgg81283/Messages.xml

    SMS Gateway Certificates

    After providing the valid URL in SMS Gateway, click Import From Server to automatically fetch the certificate's details.

    SMS Gateway User

    Specify the account SID of your account from the SMS provider.

    SMS Gateway Password

    Click Store Value and specify the auth token of your account and confirm it.

    HTTP(S) Method

    By default, POST is set for secured connection.

    SMS Gateway Authentication Method

    By default, HTTP - Use HTTP basic connection is set as the authentication method.

    SMS Request Data

    Specify the following details in SMS Request Data using the following parameters:

    To=%user's mobile number%&

    From=%sender id or mobile number%&

    Body=%Message body that you want to deliver%&

    USER=%authentication user name(account id)%&

    PASS=%authentication password%

    NOTE:The ampersand symbol (&) is used as the separator between parameters.

    For example:

    To=%+911234567890%&From=%+19876543210%&Body=%Hi{user}, This is to notify that your corporate password expires in 7 days.%&USER=%AMwqeiu0283749cabgg81283%&PASS=%aj437987349857jlkfj%

    SMS Data Content Type

    By default, the value application/x-www-form-urlencoded is set as the Data Content Type. You can retain the same value.

    SMS Data Content Encoding

    Select the encoding format to transmit the SMS content. By default, URL - recommended for GET requests and POST with form data is set as the encoding format.

    SMS Gateway HTTP Request Headers

    Specify the SSPR host address in the format - https://dns-name/sspr

    Maximum SMS Text Length

    Specify the number of characters in the SMS. By default, 140 is set as the maximum text length

    SMS Sender ID

    Specify the sender ID that is displayed as from address in SMS. Include the country code if required.

    SMS Phone Number Format

    Select the phone number format for both sending and receiving the SMS. Zeros - Same as plain, but prefixed with double zero: 00112312345 is set as the default format.

    Default SMS Country Code

    Specify the default country code of the receiver’s phone number. Set to 0 if you want to disable the country code.

    Request ID Characters

    Specify the request ID characters required for SMS transmission.

    Request ID Length

    Specify the length of the request ID.

    Response Regular Expression

    Specify the regular expression to determine whether SSPR sent the SMS successfully to the gateway. If the response matches any of the expressions, SSPR considers the transmission successful. If you do not specify any expressions, SSPR assumes that all transmissions are successful.

    Successful HTTP Result Codes

    HTTP result status codes indicate whether a specific HTTP request has been successfully completed. You can define the following result codes:

    • 201: Represents that the request has succeeded and SMS is delivered successfully. This is typically the response sent after POST requests, or some PUT requests.

    • 400: Represents that the SMS transmission is not successful due to invalid configuration.

    • 404: Represents that the SMS is not delivered due to the invalid number of the recipient.

    Maximum SMS Queue Age

    Specify the maximum age (in seconds) an SMS can wait in the queue. If an SMS is in the send queue longer than the specified time, the system discards it.

  6. In the toolbar, click Save changes.

8.9.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.

For example, you can configure Self Service Password Reset to automatically send SMS when a user changes the password by configuring the Change Password SMS text template.

Before configuring the SMS messages, ensure to add your SSPR setup meets the following prerequisites:

  • Configure SMS gateway details to deliver SMS.

  • Set SMS Destination Address LDAP Attribute to telephoneNumber in Configuration Editor > LDAP > LDAP Directories > default > User Attributes.

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.

  5. Use the help to configure the SMS messages to send to your users.

    • Change Password SMS Text: Displays the default SMS text sent to users on changing their password. Click the Edit icon to customize the SMS text as per your requirement.

    • Update Profile SMS Text: Displays the default SMS text sent to users on updating their profile. Click the Edit icon to customize the SMS text as per your requirement.

  6. In the toolbar, click Save changes.