Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

REST SMS Gateway

Adding REST SMS gateway

This feature is available under Network > Connectors > Create New > Email/SMS > SMTP SMS Gateway.

Feature

Description

Name Unique name of the SMS Gateway. A name may only be used once across all types of SMS Gateways.
API URL API URL that is used to send SMS (Example: gateway.provider.com/sms/send).
HTTPS Is the connection to the service HTTPS? If the Scheme is not included in the Gateway Address, the user has to specify it via the Toggle. Default is HTTP
HTTP Method HTTP Method used to send SMS.
User Name The User name that is used for HTTP basic Authentication to the gateway.
Password The password that is used for HTTP basic Authentication to the gateway.
Content Type Content Type used to contact the API URL.

Enabled

If Enabled, this SMS Gateway will appear in the list of Mobile Providers available to a user in both the Admin GUI and Portal. This is only a visual toggle, and the Gateway will still be used if a User has it selected as their Mobile Provider.

Form Parameters

These are various headers that are used to contact the API URL.

 

Note

To make setting up a new gateway easier, FortiNAC ships with Twilio and Vonage based configuration settings under the names Twilio-example-config and Vonage-example-config. These configurations use placeholders which should be filled with details that are specific to the account.

Modifying REST SMS gateway

Once you add a REST SMS gateway, all REST SMS gateways are put under their own card in Network > Service Connectors view under the name you used while creating. To modify the gateway configuration that's been added, right click the Network > Service Connectors > "Name" card and go to the configuration by clicking Edit.

Deleting REST SMS gateway

To delete REST SMS gateway, right click the Network > Service Connectors > Name of the Gateway, and click Delete.

Testing REST SMS gateway connection

To test the REST SMS gateway connection, you can right click the Network > Service Connectors > Name of the Gateway, and test the config by clicking Test Connection.

You can also edit the configuration and test the connection once you are in the configuration window.

Once the test connection overlay is opened, select the user with which you wish to test the connection.

The user has to be configured with the phone number and the messaging gateway that you wish to test the connection with. Remember to include the country code for the phone number.

Note: Remember to save the configuration before actually trying to test the connection.

REST SMS gateway can be used at all places where SMTP SMS gateways are used to send the SMS.

Setting Default REST SMS gateway

To set a REST SMS gateway as Default, right click the Network > Service Connectors > Name of the Gateway, and set the configuration as default by clicking Set as Default.

Debug options

To debug, enable debugging in the CLI and the user should be able to see what the Request was and its corresponding response from output.master.

REST SMS Gateway

Adding REST SMS gateway

This feature is available under Network > Connectors > Create New > Email/SMS > SMTP SMS Gateway.

Feature

Description

Name Unique name of the SMS Gateway. A name may only be used once across all types of SMS Gateways.
API URL API URL that is used to send SMS (Example: gateway.provider.com/sms/send).
HTTPS Is the connection to the service HTTPS? If the Scheme is not included in the Gateway Address, the user has to specify it via the Toggle. Default is HTTP
HTTP Method HTTP Method used to send SMS.
User Name The User name that is used for HTTP basic Authentication to the gateway.
Password The password that is used for HTTP basic Authentication to the gateway.
Content Type Content Type used to contact the API URL.

Enabled

If Enabled, this SMS Gateway will appear in the list of Mobile Providers available to a user in both the Admin GUI and Portal. This is only a visual toggle, and the Gateway will still be used if a User has it selected as their Mobile Provider.

Form Parameters

These are various headers that are used to contact the API URL.

 

Note

To make setting up a new gateway easier, FortiNAC ships with Twilio and Vonage based configuration settings under the names Twilio-example-config and Vonage-example-config. These configurations use placeholders which should be filled with details that are specific to the account.

Modifying REST SMS gateway

Once you add a REST SMS gateway, all REST SMS gateways are put under their own card in Network > Service Connectors view under the name you used while creating. To modify the gateway configuration that's been added, right click the Network > Service Connectors > "Name" card and go to the configuration by clicking Edit.

Deleting REST SMS gateway

To delete REST SMS gateway, right click the Network > Service Connectors > Name of the Gateway, and click Delete.

Testing REST SMS gateway connection

To test the REST SMS gateway connection, you can right click the Network > Service Connectors > Name of the Gateway, and test the config by clicking Test Connection.

You can also edit the configuration and test the connection once you are in the configuration window.

Once the test connection overlay is opened, select the user with which you wish to test the connection.

The user has to be configured with the phone number and the messaging gateway that you wish to test the connection with. Remember to include the country code for the phone number.

Note: Remember to save the configuration before actually trying to test the connection.

REST SMS gateway can be used at all places where SMTP SMS gateways are used to send the SMS.

Setting Default REST SMS gateway

To set a REST SMS gateway as Default, right click the Network > Service Connectors > Name of the Gateway, and set the configuration as default by clicking Set as Default.

Debug options

To debug, enable debugging in the CLI and the user should be able to see what the Request was and its corresponding response from output.master.