SMS Provider

1. Overview

An SMS Provider is a third-party SMS gateway configuration that enables OCCS to send SMS messages. It stores the provider’s authentication details, API endpoint, HTTP request settings, and field mappings required to communicate with the SMS service.

SMS Providers are managed from Global Settings and are used by the Plugins to actually deliver SMS messages.

2. Prerequisites

Before adding an SMS Provider, make sure that:

  • You are logged in as Super Admin.

  • The Plugins has been imported and enabled.

3. Steps to Add an SMS Provider

  1. Open Global Settings.

    Click Global Settings (gear icon) on the left-hand side of the Super Admin dashboard.

  2. Open SMS Providers.

    Click SMS Providers in the Global Settings menu.

    SMSprovider

  3. Add a new provider.

    Click + ADD SMS PROVIDER in the top right corner.

    addsmsprovider

  4. Fill in the SMS Provider form.

    Complete the fields described below, then click SAVE to create the provider, or CANCEL to discard the changes without saving.

    Add SMS Provider form with all configuration fields

4. SMS Provider Form Fields

Field Description

Name

A label used to identify this SMS Provider in OCCS.

Authentication Type

The authentication method used to connect to the provider’s API, for example API Key.

Credentials (Key-Value Pairs)

The authentication credentials required by the provider, entered as one or more Key / Value pairs (for example, an API key name and its value). Use + ADD CREDENTIAL FIELD to add additional pairs if the provider requires more than one credential.

URL Gateway

The API endpoint (URL) that OCCS sends SMS requests to.

HTTPS Method

The HTTP method used when calling the provider’s API, for example POST.

Recipient Field Name (To)

The name of the request field the provider expects to contain the recipient’s number.

Sender Field Name (From)

The name of the request field the provider expects to contain the sender identity/number.

Message Field Name

The name of the request field the provider expects to contain the SMS message body.

5. Activating a Provider

Once created, an SMS Provider can be switched on or off using the Status toggle on the SMS Providers list.

SMS Providers list showing an active provider with its status toggle switched on

If there are multiple SMS Providers configured, only one provider can be active at a time. Turning on the status toggle for one provider automatically means only that provider is used — multiple providers cannot be active simultaneously.

6. Editing an SMS Provider

  1. Select the checkbox next to the SMS Provider you want to edit.

  2. Click EDIT.

  3. Update the fields as needed.

  4. Click UPDATE to save and apply the changes, or CANCEL to discard them and leave the provider unchanged.

7. Deleting an SMS Provider

  1. Select the checkbox next to the SMS Provider you want to delete.

  2. Click DELETE.

  3. Confirm the deletion when prompted.

  • The EDIT button only becomes active when exactly one checkbox is selected — you can’t bulk-edit multiple providers at once.

  • The DELETE button works with one or more checkboxes selected, so you can remove several providers in a single action.

  • Clicking CANCEL while editing discards all unsaved changes and returns you to the SMS Providers list — the provider keeps its previous configuration.

  • Deleting a provider is permanent. If it was the active provider, remember to enable another one afterward so SMS sending isn’t interrupted.