Contribute in GitHub:

Setting up a multi-tenant SMS Gateway JSON configuration

In a multi-tenant JSON configuration, a single SMS Gateway instance can host multiple tenants, or phone numbers provisioned from your SMS provider that customers can send SMS messages to. For example, from a single SMS Gateway instance, an insurance provider might provide one phone number for car insurance and another phone number for homeowners insurance. Because there's only a single deployment, a multi-tenant JSON configuration offers simpler, centralized administration over deploying multiple single-tenant environments, where each instance corresponds with a particular phone number.

Configure the tenants

In a multi-tenant JSON configuration, tenant configuration is specified and stored in a separate JSON file, which is then referenced in the SMS Gateway configuration. Configuration that isn't related to a tenant, such as server configuration, continues to be specified in the core SMS Gateway configuration. By separately specifying the tenant configuration as JSON objects, distinct configuration settings can be mapped to each individual tenant.

For detailed information and a list of all JSON tenant configuration properties, see Configuring tenants in a multi-tenant SMS Gateway environment and Advanced JSON configuration properties for SMS Gateway.

Deploy your multi-tenant JSON configuration

You can deploy your multi-tenant JSON configured environment on-premises with Docker Engine or in the public cloud with IBM Cloud Kubernetes Service. For more information, see Deploying a multi-tenant SMS Gateway environment.

After you deploy SMS Gateway, each tenant is available at the configured tenant phone number. In a multi-tenant JSON configuration, only messages to the specified tenants can go through, effectively whitelisting the configured tenants.