> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/manual/english/administration/settings/sms-gateway.md).

# SMS Gateway (BETA)

{% hint style="warning" %}
**Please note**: This view is currently in **Beta status**. User interface and functionalities can change at any time.

<i class="fa-eye">:eye:</i> This view is only visible if you have enabled the **Enable beta features** option under **Settings** → [User Account](/docs/manual/english/administration/settings/user-account.md).
{% endhint %}

***

Setting up an SMS gateway is required so that you can, for example, receive SMS notifications about alerts or use two-factor authentication.

***

## Important Notes

**Legacy Configuration**

* If you have already configured an SMS gateway for your organization in the Enginsight configuration file on the Application Server, this configuration remains available as a fallback.

{% hint style="success" icon="lightbulb" %}
For more information about the legacy feature, see our Knowledge Base: [How do I configure SMS notifications for alerts in Enginsight (Legacy)?](https://docs.enginsight.com/docs/knowledge-base/english/alerting/how-do-i-configure-sms-notifications-for-alerts-in-enginsight)
{% endhint %}

**Inheritance of SMS Gateway Configurations**

* [Administrator organizations](/docs/manual/english/administration/organization-management.md) can define an SMS gateway configuration as the global default configuration. This means that the configuration is applied globally to all managed organizations.
* If no custom SMS gateway configuration is defined for an organization, it inherits the settings of its parent organization by default. If no configuration is defined there either, the global default configuration is used.

***

## Creating a new SMS Gateway Configuration

<i class="fa-compass">:compass:</i> Navigate to **Settings** → **SMS Gateway** to configure an SMS gateway for Enginsight.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FgGGqCaGYbW24ziPtpE2Y%2FEnginsight-EN-Settings-SMS%20Gateway-Start%20Page.jpg?alt=media&amp;token=c5926f27-4f4a-41ed-aa6d-a6daa1148448" alt=""><figcaption></figcaption></figure>

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Add Configuration** to set up a dedicated SMS gateway for the organization you are currently logged in to.

{% hint style="warning" %}
**Please note**: Setting up a dedicated SMS gateway configuration overrides all settings inherited from a parent organization or defined globally.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Edit** if you have already configured an SMS gateway in this view and want to change the settings.

The [setup wizard](#setup-wizard) opens.

***

## Setup Wizard

The SMS gateway settings consist of four steps that the setup wizard guides you through:

{% columns %}
{% column width="33.33333333333333%" %}

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FCdDKXP8saIuZpKt972lW%2FEnginsight-EN-Settings-SMS%20Gateway-Menu.jpg?alt=media&amp;token=e370208c-60e8-48af-aae2-06d9d23eafc0" alt=""><figcaption></figcaption></figure></div>
{% endcolumn %}

{% column width="66.66666666666667%" %}

* [Provider](broken://pages/feeab0e0099cddf94c8e76e1c0fa8dd877d39234#step-1-provider)
* [Connection](broken://pages/feeab0e0099cddf94c8e76e1c0fa8dd877d39234#step-2-connection)
* [Advanced Settings](broken://pages/feeab0e0099cddf94c8e76e1c0fa8dd877d39234#step-3-advanced-settings)
* [Overview](broken://pages/feeab0e0099cddf94c8e76e1c0fa8dd877d39234#step-4-overview)
  {% endcolumn %}
  {% endcolumns %}

<i class="fa-compass">:compass:</i> Sections in which you have already entered settings are highlighted in pink. You can also use the navigation bar on the left to switch between these sections.

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Cancel** to return to the start page.

{% hint style="danger" %}
**Please note**: If you leave a view without saving by clicking **Abort**, all settings you entered will be lost and cannot be restored.
{% endhint %}

***

## Step 1: Provider

Here you can select a provider for sending text messages.

{% hint style="info" %}
Currently, only **Amazon Simple Notification Service (SNS)** can be selected as a provider.
{% endhint %}

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FdBAIrcOHri6zhxFPnEy0%2FEnginsight-EN-Settings-SMS%20Gateway-Provider.jpg?alt=media&amp;token=86e16204-60a3-4638-a38f-001b07747f46" alt=""><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Next** to continue to the next settings section.

***

## Step 2: Connection

Here you can configure the connection to the SMS gateway in detail.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FR7TeKbcF3JR93OSWDxvl%2FEnginsight-EN-Settings-SMS%20Gateway-Connection-Full.jpg?alt=media&amp;token=1cbca056-b283-4829-8733-a7e354ca5e9f" alt=""><figcaption></figcaption></figure>

### Requirements

To use Amazon SNS, you first need to create an AWS IAM user with the required access permissions.&#x20;

Follow these steps:

1. Sign in to your AWS account and navigate to IAM (Identity and Access Management).
2. Create an IAM user with access to Amazon SNS. Follow the [official AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html).

{% hint style="warning" %}
**Please note**: Enginsight assumes no liability for the content and topicality of third-party documentation.
{% endhint %}

3. Create an **access key** for the new user that allows access by third-party software. You need this access key and the corresponding **secret access key** to configure the SMS gateway.

### Connection

Define the AWS region from which your Amazon SNS instance should send messages. You can find an overview of all available AWS regions in the [official AWS documentation](https://docs.aws.amazon.com/de_de/general/latest/gr/end-user-messaging.html#end-user-messaging_region).

{% hint style="warning" %}
**Please note**: Enginsight assumes no liability for the content and topicality of third-party documentation.
{% endhint %}

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FctuJq2AXSDSB1lPDFicj%2FEnginsight-EN-Settings-SMS%20Gateway-Connection-AWS%20Region.jpg?alt=media&amp;token=92ea25dd-78d2-407f-910a-dc681e039f3d" alt=""><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **AWS Region** field to open a list of all available AWS regions and select a region. You can also use the free-text search to find a region more quickly.

{% hint style="info" %}
The default region is **eu-central-1**.
{% endhint %}

### Authentication

Here you can define how to authenticate against the SMS gateway provider.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FVD49cxHIA1gvGQ21YxAG%2FEnginsight-EN-Settings-SMS%20Gateway-Connection-Authentication.jpg?alt=media&amp;token=4912736c-eb12-4bea-8b8e-38c0a11177bd" alt="" width="554"><figcaption></figcaption></figure></div>

The following options are available:

<table><thead><tr><th width="200.1953125">Option</th><th>Description</th></tr></thead><tbody><tr><td>Access Key ID</td><td>Enter the access key that you created for your new IAM user.</td></tr><tr><td>Secret Access Key</td><td>Enter the secret access key that was created for your new IAM user.</td></tr><tr><td>Sender ID</td><td>Enter the sender name that should be shown on the mobile device. AWS automatically truncates it after 11 characters.</td></tr></tbody></table>

### Testing the Connection

{% hint style="danger" %}
**Please note**: For a successful connection test, a mobile phone number must be entered in the Enginsight platform under **Settings** → [User Account](/docs/manual/english/administration/settings/user-account.md).
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Test Connection** to check whether a connection to the SMS gateway provider can be established using the specified connection and authentication details. The **Test Connection** window opens.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2Fa1p1MrdPHFr0R48my80J%2FEnginsight-EN-Settings-SMS%20Gateway-Test%20Connection.jpg?alt=media&amp;token=92f8b35b-0ba6-4e16-98f2-017ae57d9380" alt="" width="516"><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Select the checkbox <i class="fa-square">:square:</i> next to **Send Test SMS (Optional)** to send a test SMS to the specified mobile phone number. Deselect the checkbox <i class="fa-square-check">:square-check:</i> to test the connection without sending a test SMS.

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Test Connection** to start the connection test and optionally send a test SMS.

{% hint style="warning" %}
**Please note**: The connection test uses the connection and authentication details you entered previously, even if you have not saved them yet. If you have recently created new credentials with your provider, it may take a few minutes for them to become active. If the connection test fails, try again a little later.
{% endhint %}

If the connection test fails, you have the following options:

* Read the information shown in the **Details** window to find out why the connection could not be established.
* <i class="fa-computer-mouse">:computer-mouse:</i> Click **Retry** to run the test again with the same settings.
* <i class="fa-computer-mouse">:computer-mouse:</i> Click **Back** to review the settings and change them if necessary.

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Next** if the connection test was successful to continue to the next settings section.

***

## Step 3: Advanced Settings

Here you can optionally set the SMS gateway as the global default configuration.

{% hint style="warning" %}
**Please note**: Only an [administrator organization](/docs/manual/english/administration/organization-management.md) can define a global configuration.
{% endhint %}

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2F00JptMaIXBaT6UuOtuQe%2FEnginsight-EN-Settings-SMS%20Gateway-Advanced%20Settings.jpg?alt=media&amp;token=a7b8eabc-6382-442d-8e89-7751696e2499" alt=""><figcaption></figcaption></figure>

### Global configuration

<i class="fa-computer-mouse">:computer-mouse:</i> Select or deselect the checkbox <i class="fa-square">:square:</i> next to **Use SMS gateway configuration globally** to enable or disable the option.

{% hint style="info" %}
If no custom SMS gateway configuration is defined for an organization, it inherits the settings of its parent organization by default. If no configuration is defined there either, the global configuration is used.
{% endhint %}

***

## Step 4: Overview

Here you can review all the settings you entered. Check the information again and save your settings.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FEJWW6twg2exnueXdKHJH%2FEnginsight-EN-Settings-SMS%20Gateway-Overview.jpg?alt=media&amp;token=9e231b73-e22e-4e7e-9cb0-9e7c3b3713c9" alt=""><figcaption></figcaption></figure>

<i class="fa-computer-mouse">:computer-mouse:</i> After reviewing all settings, click **Save Changes** to save the SMS gateway configuration.

{% hint style="danger" %}
**Please note**: If you leave this view without saving, all settings you entered will be lost and cannot be restored.
{% endhint %}

***

## Further Resources

**Knowledge Base**

* [How do I configure SMS notifications for alerts in Enginsight (Legacy)?](https://docs.enginsight.com/docs/knowledge-base/english/alerting/how-do-i-configure-sms-notifications-for-alerts-in-enginsight)
* [How do I set up a main organization as an administrator organization in Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/configuration/how-do-i-set-up-a-main-organization-as-an-administrator-organization-in-enginsight)

***