Configuring SMS based Authentication

SMA allows OTP to be delivered through SMS along with the Email. SMS authentication is supported on Active Directory, AD-Advanced, LDAP, and Local Authentication servers. All the SMS Gateways that support HTTP/REST APIs are supported.

Configuring SMS Gateway

1. In the AMC, navigate to System Configuration > Services > SMS > Configure.

   

2. Click Enable SMS.

3. In the Provider drop-down, select the SMS gateway provider and provide account details.

   If your SMS service provider is not listed, you can manually configure the options by choosing Manual option from the Provider list. Refer the HTTP/API/developer guide provided by your SMS Gateway to configure manually.

Configuration Procedure

1. Select GET/POST/PUT method based on the Gateway API guide.

   GET method:

   1. Enter the URL endpoint to submit SMS
   2. In place of actual destination number, use the placeholder key {to}

   3. In place of actual message, use the placeholder key {message}

      Example: If the URL endpoint provided by your gateway is:

      https://api.smsgateway.com/sendsms.php?user=test&password=Pass&recipient=33781723&text=This%20is%20a%20test%20message

      Configure it as

      https://api.smsgateway.com/sendsms.php?user=test&password=Pass&recipient={to}&text={message}

      

      POST/PUT method:

      1. Enter the URL endpoint to submit SMS.
      2. Select the Content type as Form/JSON/XML.
      3. Enter the message to be shared.
      4. In place of actual destination number, use the placeholder key {to}

      5. In place of actual message, use the placeholder key {message}

         Example: If the URL endpoint provided by your gateway is

         https://api.smsgateway.com/sendsms.php

         with content type as application/x-www-form-urlencoded and body as user=test&password=Pass&recipient=33781723&text=This%20is%20a%20test%20message

         Configure it as:

         • Select POST/PUT method
         • Enter URL as https://api.smsgateway.com/sendsms.php
         • Select Content type as Form

         • Enter Body as user=test&password=Pass&recipient={to}&text={message}

           

      6. In case of JSON content type, if original content to be sent is,

         {

         "user": "test",

         "password": "Pass",

         "text": "This is a test message",

         "recipient": ["9239183"]

         }

         Provide replaced content as below

         {

         "user": "test",

         "password": "Pass",

         "text": "{message}",

         "recipient": ["{to}"]

         }

         

      7. In case of XML content type, if original content to be sent is,

         <message>

         <user>test</user>

         <password>Pass</password>

         <text>This is a test message</text>

         <recipient>9239183</recipient>

         </message>

         Provide replaced content as below:

         <message>

         <user>test</user>

         <password>Pass</password>

         <text>{message}</text>

         <recipient>{to}/recipient>

         </message>

         

2. Configure Verification settings to identify whether SMS gateway has accepted the message for submission. By default the HTTP status response code is considered for validation - all response status code between 200 and 299 is considered successful submission.

   To change this behavior:

   • Choose Status code and mention the specific status response code that should be considered as successful submission. All other response code from SMS Gateway will be considered as failure to submit SMS.
   • Choose Contains text option if your SMS gateway responds with specific response body on success. For Example, enter the text “OK”. If response body contains no instance of “OK”, it will be considered as failure to submit SMS.
3. In case your SMS Gateway expects account credentials over Basic HTTP authentication header, enable “Authentication” and provide the user details.
4. If SMS gateway expects account-id and password over HTTP header, use Additional headers option to add them.
5. To test the configuration:
   1. In the Phone number field, enter the phone number to which the OTP needs to be delivered.
   2. In the Message field, type in the message. For example: Test message.

   3. Click Send text message.

      The text message is delivered to the entered phone number.

6. Click Save.

   

   Once you have configured the SMS authentication, enable the SMS services in the authentication service to log in to the SMA using OTP. For more details, refer to the respective authentication server section in this guide.