SMS gateways
To view a list of the configured SMS gateways, go to System > Messaging > SMS Gateways.
The following information is shown:
Create New | Select to create a new SMS gateway. |
Delete | Select to delete the selected SMS gateway or gateways. |
Edit | Select to edit the selected SMS gateway. |
Set as Default | Set the selected SMS gateway as the default SMS gateway. |
Name | The name of the SMS gateway. |
Protocol | The protocol used by the gateway. |
SMTP Server | The SMTP server associated with the gateway. |
API URL | The gateway’s API URL, if it has one. |
Default | Shows a green circle with a check mark for the default SMS gateway. To change the default gateway, select the gateway you would like to use as the default, then select Set as Default in the toolbar. |
You can also configure the message that you will send to users. You can use the following tags for user-specific information:
Tag | Information |
---|---|
{{:country_code}} | Telephone country code, e.g. 01 for North America. |
{{:mobile_number}} | User’s mobile phone number. |
{{:message}} | “Your authentication token code is ” and the code. |
{{:null}} | Empty string or null value. |
To create a new SMTP SMS gateway:
- Go to System > Messaging > SMS Gateways and select Create New. The Create New SMS Gateway window opens.
- Enter the following information:
Name Enter a name for the new gateway. Protocol Select SMTP. SMTP server Select the SMTP server you use to contact the SMS gateway. The SMTP server must already be configured, see SMTP servers. Mail-to-SMS gateway Change domain.com
to the SMS provider’s domain name. The default entry{{:mobile_number}}@domain.com
assumes that the address is the user’s mobile number followed by @ and the domain name. In the Email Preview section, check the To field to ensure that the format of the address matches the information from your provider.Email Preview View a preview of the email message. To Format of the email address, as determined by the Mail-to-SMS gateway field. Subject Optionally, enter a subject for the message. Body Optionally, enter body text for the message. - Optionally, select Test Settings to send a test SMS message to the user.
- Select OK to create a new SMTP SMS gateway.
To create a new HTTP or HTTPS SMS gateway:
- Go to System > Messaging > SMS Gateways and select Create New. The Create New SMS Gateway window opens.
- Expand the HTTP/HTTPS section, then enter the following information:
HTTP/HTTPS HTTP method Select the method to use, either GET or POST. API URL Enter the gateway URL, omitting the protocol prefix http://
orhttps://
. Also omit the parameter string that begins with?
.CA certificate Select CA certificate that validates this SMS provider from the dropdown menu. Content-Type Select a content type from the dropdown menu. Authorization Type Enter the Username and Password for Basic Auth.
For Client Certificate, use the dropdown to select a client certificate.
Send Mobile Number as
Select the format to use, either JSON String or JSON Number.
This option is only available when the Content-Type is application/json.
HTTP Parameters Field Enter the parameter names that the SMS provider’s URL requires, such as user
andpassword
.Value Enter the values or tags corresponding to the fields. Delete Delete the field and its value. - If you need more parameter entries, select Add another SMS Gateway HTTP Parameter.
- Optionally, select Test Settings to send a test SMS message to the user.
- Select OK to create a new HTTP or HTTPS SMS gateway.