Configuring SMS Providers

We are introducing a new feature that enables you to define multiple SMS providers in GpsGate Server, and use them for different applications and country calling codes.


This new feature will let you categorize SMS providers for different applications and geographical locations. This way, you can let the system pick the most advantageous provider based on the recipient phone number.

This guide gives you a walkthrough of how you can create, configure and sort SMS providers for your needs.

Setup
  1. Upgrade the plugin
  2. Defining new SMS providers

Upgrade the plugin

  1. Login to SiteAdmin.
  2. Go to Plugins tab.
  3. Set the Repository URL to http://update.gpsgate.com
  4. Under My Plugins tab, make sure Patch.v4 plugin is installed and up to date.
  5. Again, under My Plugins tab, make sure Terminal plugin is installed and up to date.
  6. Navigate to the “Settings” tab in SiteAdmin. You can access SMS configuration page by clicking “SMS” link from the side menu.

Defining new SMS providers

Once you get to the SMS configuration page, all existing providers will be displayed in the list view under “Configure Providers” section. If you think that any of your existing SMS providers is missing from this list, please take a look at “Troubleshooting” section of this post.

To create a new provider:

  1. Select a provider type from the dropdown list.
  2. A form is displayed to let you input provider information. The fields you have to fill in varies depending on the provider type. For more information, please check how to enable a SMS provider in this forum post. The image below shows the form for defining a new proxy message provider: Create Proxy Message Provider
  3. For each new provider you define, you can also specify one or more application tags the provider should be picked for. If you don’t specify any application tags, this provider will be available for all outgoing messages under any application.
  4. You can also limit the availability of the SMS provider to certain country calling codes by specifying phone number initials in “Phone numbers” field. If you do not specify any country calling code, this provider will be available for any recipient number.
  5. Click “Save” to create and activate the new provider. The new provider will be appended to the existing providers list.
  6. You can then change the order of providers, enable or disable (start/stop) them in the list view.

Providers List View

Block message provider

Block Message Provider is a new type of provider to block outgoing messages. If any outgoing message matches the criteria of a block provider in the list, that message is not sent.

How it works

For each outgoing SMS, the list of active (running) providers is checked. The first provider that matches the criteria is picked as the service to be used for that particular message. This process is repeated for every outgoing SMS.

Providers List View

Considering the list above, assume that an event rule tries to send an SMS notification to phone number +4670xxxxxx, and this number belongs to a device under an application with “Europe” tag. In this case, Proxy Message Provider will be picked.

Now, another event rule tries to send an SMS to phone number +6112xxxxx, and this number is of a device under an application with “Australia” tag. “Clickatel Provider” matches the critearia, but it will be ignored since it’s disabled (i.e. not running). As there won’t be any other matching providers, this message will be blocked by default.

Again, any phone number that belong to a device under an application with “South America” tag will be blocked, since there is a Block Message Provider defined for this purpose.

What happens to my existing SMS providers?

After upgrading to the latest Patch.v4, your existing proxy message provider will be moved from “Service → Providers” to “Settings → SMS” menu. As you upgrade each plugin for pluginable SMS providers (such as Clickatell, HSL or WebSMS. See the full list here), they will also be moved under “Settings → SMS” menu. Please check the new list to make sure all providers are well defined and are in the order you want.

Please note that a Proxy Message Provider is installed by default during GpsGate Server setup. If you still have the default proxy message provider without any settings defined in the new SMS configuration page, please click “Edit” in the list view, and specify settings for the proxy message provider or delete if it’s not used. Otherwise, all the outgoing SMS will try to use the default proxy message provider, which will fail to send any messages.
Troubleshooting

You can always preview which provider is selected for a particular number by clicking “Preview Matching Provider” button under “Send Test SMS” section. You can also try to send a test SMS by clicking “Send SMS” button.

To view which provider is used for an outgoing SMS, go to “System Tools → Queue Viewer” and list all SMS messages.

If you think that any of your existing providers is missing from this list, please navigate to “Service” tab, and click “Providers” from the side menu. If the provider you are looking for is there in the list, you need to upgrade the plugin for the provider in question. Please refer to this forum post for how to install/upgrade SMS providers on your GpsGate server.

Related guides

  Discuss this blog post on the forum please



Download free GpsGate Server

Install it on your own server. The installation is free for 5 users.

Download Now