BeamOS – SMS Gateway
Summary
The SMS Gateway service is used to set up various SMS related (mostly automated) functions. This chapter is a summary of the SMS Gateway service of BEAM routers.
Post/Get
The Post/Get Configuration section is used to turn ON and configure SMS related post/get settings. When the function is enabled, it provides you with the possibility to perform SMS related action requests by writing them in the URL field of your web browser.
The figure below is an example of the Post/Get Configuration page and the table below provides information on fields contained in that page:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns SMS post/get ON or OFF |
Username | string; Default: user1 | User name used for authorization when sending post/get requests |
Password | string; Default: user_pass | Password used for authorization when sending post/get requests |
SMS Post/Get usage examples
Use a web browser or any other compatible software to send HTTP post/get strings to the router. The router must be connected to a GSM network when using the Send SMS feature. Below you will find a table with possible actions and examples on how to use them:
Action | Post/get URL examples |
|---|---|
View mobile messages list | http://192.168.1.1/cgi-bin/sms_list?username=user1&password=user_pass |
Read mobile message | http://192.168.1.1/cgi-bin/sms_read?username=user1&password=user_pass&number=1 |
Send mobile message | http://192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage |
View mobile messages total | http://192.168.1.1/cgi-bin/sms_total?username=user1&password=user_pass |
Delete mobile message | http://192.168.1.1/cgi-bin/sms_delete?username=user1&password=user_pass&number=1 |
- 192.168.1.1 – router’s IP address. (Replace it with your LAN IP or WAN IP (when connecting remotely))
- SMS related post/get commands. Possible values are:
- sms_list – view all SMS messages in storage
- sms_read – read a single SMS message by specified SMS index (number)
- sms_send – send an SMS message to specified recipient
- sms_total – display SMS storage statistics
- sms_delete – delete a single SMS message by specified SMS index (number)
- & – separation symbol. After specifying the SMS command, other parameters must be separated by an ampersand (&) symbol
- username – SMS post/get configuration user name
- password – SMS post/get configuration password
- number – SMS message index or (depending on context) recipient’s phone number. SMS message indexes can be viewed with the sms_list command.
Correct phone number format is:- 00 – number must be preceded by two zeros
- – the next following element is the number holder’s country code
- – phone number of the recipient
For example, a valid number would be 0037012345678 (370 is country code and 12345678 is the receiver’s phone number, all preceded by 00)
- text – SMS message text
Email to SMS
Email to SMS is a function that connects to your email account and checks its inbox at the specified frequency. If it finds any new received emails with a specific subject (phone number in email subject), it sends the body of the email as an SMS message(s) to the recipient specified in the email subject field.
Important note: all POP3 server email messages from inbox will be deleted when using this service.
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns Email to SMS ON or OFF |
POP3 server | host | ip; Default: none | Email service provider’s POP3 server address (can be looked up online) |
Server port | integer [0..65535]; Default: none | Email service provider’s POP3 server port (can be looked up online) |
Username | string; Default: none | Email account user name. This is information is used by router in order to atuhenticate itself when connecting to the email client |
Password | string; Default: none | Email account password. This is information is used by router in order to authenticate itself when connecting to the email client |
Secure connection (SSL) | yes | no; Default: no | SSL is a protocol for transmitting private documents via the Internet. SSL uses a cryptographic system that uses two keys to encrypt data − a public key known to everyone and a private or secret key known only to the recipient of the message |
Max. email symbol count | integer; Default: 160 | Limit of symbols that can be contained in the email body of text. Emails that contain more symbols than it is specified in this field will not be sent as SMS messages |
Check email every | time [1 minute to 15 days]; Default: 1 minute | Email inbox check interval |
Additional note: you may have noticed that there is no option where you can specify the recipient’s phone number. As mentioned earlier, Email to SMS doesn’t forward all emails, only the ones that are meant to be forwarded. Only emails with the recipient’s phone number in the subject will be forwarded to SMS
Correct phone number format is:
- 00 – number must be preceded by two zeros
- <country_code> – the next following element is the number holder’s country code
- <receivers_number> – phone number of the recipient
For example, a valid number would be 0037012345678 (370 is country code and 12345678 is the receiver’s phone number, all preceded by 00)
Scheduled SMS
Scheduled SMS allows you to set up the router to periodically send SMS messages to a specified number. Scheduled messages are managed in rule form. Therefore, to configure a new Scheduled Message, we must first create a rule. To create a new rule, type in a phone number in the Phone number field located in the Scheduled Messages Configuration section and click the Add button located next to it.
After this you will be redirected to the Scheduled Messages Configuration window where you can configure all parameters related to the rule. Once you save the configuration, you will be redirected back to the Scheduled SMS page, where you will see your new rule in the Messages To Send section:
Scheduled Messages Configuration
The figure below is an example of the Scheduled Messages Configuration window and the table below provides information on the field contained in that window:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns the rule ON or OFF |
Recipient’s phone number | phone number; Default: none | Phone number of the recipient that will receive the scheduled messages |
Message text | string; Default: none | The message that will be sent |
Message sending interval | time; Default: Day, hour 1, minute 1 | The frequency at which scheduled messages will be sent |
Auto Reply
Auto reply is a function that responds to received SMS messages with a user defined automatic response. The figure below is an example of the Auto Reply section and the figure below provides information on the fields contained in that section:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns Auto Reply ON or OFF |
Reply SMS Utilities rules | yes | no; Default: no | When enabled, the router will also reply to messages that trigger SMS Utilities rules |
Don’t save received messages | yes | no; Default: no | When enabled, the router deletes all received SMS messages |
Mode | Everyone | Listed numbers; Default: Everyone | Indicates whether the router should reply to messages from all recipients or just the specified numbers |
Message text | string; Default: none | Text that will be sent in the automatic response |
Recipient’s phone number | phone number; Default: none | Phone number(s) that will trigger Auto Reply. To add multiple numbers, click the ‘green plus’ symbol.
This field becomes visible if the chosen Mode is “From listed numbers only” |
SMS Forwarding
The SMS Forwarding tab contains three sections:
- SMS Forwarding To HTTP
- SMS Forwarding To SMS
- SMS Forwarding To Email
Each of which can be used to set up forwarding of incoming SMS message to either HTTP, email or or another phone number.
SMS Forwarding to HTTP
The SMS Forwarding To HTTP function forwards received SMS messages to HTTP by using either Post or Get methods. The figure below is an example of the SMS Forwarding To HTTP section and the table below provides information on the configuration fields contained in that section:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns SMS Forwarding To HTTP ON or OFF |
Forward SMS Utilities rules | yes | no; Default: no | When checked the router will also forward SMS Utilities rules (the default action is to not forward SMS messages that SMS Utilities rule) |
Use HTTPS | yes | no; Default: no | Check to use the HTTPS protocol instead of HTTP |
HTTPS Certificate verification | Ignore | Verify; Default: Ignore | Indicates whether the server’s certificate will be ingored or verified. |
Method | Post | Get; Default: Get | Defines the HTTP transfer method |
URL | host | ip | host:port | ip:port; Default: none | URL or IP address to which the messages will be forwarded. By default, the router forward messages to the default HTTP port (port 80). To specify a different port add a colon (:) symbol followed by the port number (for example, 192.168.1.1:81) |
Number value name | string; Default: none | Name to assign to sender’s phone number value in query string |
Message value name | string; Default: none | Name to assign to message text value in query string |
Extra data pair 1 / Extra data pair 2 | string; Default: none | Transfers extra information through the HTTP request. Enter variable name on the left field and its value on the right.
For example, when using the Post method, one may enter some static information about the device, like ‘Router name’ on the left and ‘RUT240’ on the right.
This can also be utilized when using the Get method to request data from an HTTP server |
Mode | All messages | From listed numbers; Default: All messages | Specifies whether all messages should be forwarded or only those received from specific numbers |
Sender’s phone number | phone number; Default: none | Phone number(s) that will qualify for forwarding. To add multiple numbers, click the Services sms gateway auto reply plus symbol. This field becomes visible when the “Mode” field value is set to ‘From listed numbers’ |
SMS Forwarding to HTTP
This example will atempt to explain how to use the data fields in SMS forwarding to HTTP configuration. The fields in question are Number & Message value name and Extra data pair 1 & 2 fields. The figure below is the configuration we’ll be using for this example:
Sender=%2B37012345678&Text=Hello%21&Name=RUT240&Code=RUT240%2006E000
The & symbol separates the the key-value pairs, while certain characters (like +, ! and the space symbol) are encoded in UTF-8.
When decoded it might look something like this:
Sender: +37012345678
Text: Hello!
Name: BEAM
Code: BEAM 06E000SMS Forwarding To SMS
The SMS Forwarding To SMS function forwards received SMS messages to one or several other phone numbers. The figure below is an example of the SMS Forwarding To SMS section and the table below provides information on the configuration fields contained in that section:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns SMS Forwarding To SMS ON or OFF |
Forward SMS Utilities rules | yes | no; Default: no | When checked the router will also forward SMS Utilities rules (the default action is to not forward SMS messages that SMS Utilities rule) |
Add sender’s number | yes | no; Default: no | Adds the original sender’s number to the forwarded message |
Mode | All messages | From listed numbers; Default: All messages | Specifies whether all messages should be forwarded or only those received from specific numbers |
Sender’s phone number | phone number; Default: none | Phone number(s) that will qualify for forwarding. To add multiple numbers, click the Services sms gateway auto reply plus symbol. This field becomes visible when the “Mode” field value is set to ‘From listed numbers’ |
Recipient’s phone number(s) | phone number; Default: ” “ | Phone number(s) to which messages are going to be forwarded to. To add multiple numbers, click the Services sms gateway auto reply plus symbol |
SMS Forwarding To SMS
The SMS Forwarding To Email function forwards received SMS messages to one or several email addresses. If this service is enabled and configured correctly, when the router receives an SMS message it will automatically login to the specified email account and send the text message as an email to another specified recipient(s)
The figure below is an example of the SMS Forwarding To Email section and the table below provides information on the configuration fields contained in that section:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns SMS Forwarding To Email ON or OFF |
Forward SMS Utilities rules | yes | no; Default: no | When checked the router will also forward SMS Utilities rules (the default action is to not forward SMS messages that SMS Utilities rule) |
Add sender’s number | yes | no; Default: no | Adds the original sender’s number to the forwarded message |
Subject | string; Default: none | Text that will be inserted into the email’s Subject field |
SMTP server | host | ip; Default: none | Your email service provider’s SMTP server address. If you don’t know this address, you can look it up online |
SMTP port | integer [0..65535]; Default: none | Your email service provider’s SMTP server port. If you don’t know the port number, you can look it up online |
Secure connection | yes | no; Default: no | Enables the use of cryptographic protocols. Enable only if your SMTP server supports SSL or TLS |
User name | string; Default: none | Your email account’s login user name |
Password | string; Default: none | Your email account’s login password |
Sender’s email address | email address; Default: none | The address that will be used to send emails from |
Recipient’s email address | email address; Default: none | The address(es) to which incoming SMS messages will be forwarded. To add multiple addresses, click the Services sms gateway auto reply plus symbol |
Mode | All messages | From listed numbers; Default: All messages | Specifies whether all messages should be forwarded or only those received from specific numbers |
Sender’s phone number | phone number; Default: none | Phone number(s) that will qualify for forwarding. To add multiple numbers, click the Services sms gateway auto reply plus symbol. This field becomes visible when the “Mode” field value is set to ‘From listed numbers’ |
SMPP
Short Message Peer-to-Peer (SMPP) is a protocol used for exchanging SMS messages between Short Message Service Centers (SMSC) and/or External Short Messaging Entities (ESME). The figure below is an example of the SMPP section and the table below provides information on the configuration fields contained in that section:
Field Name | Value | Description |
|---|---|---|
Enable | yes | no; Default: no | Turns SMPP ON or OFF |
User name | yes | no; Default: admin | User name used for authentication on the SMPP server |
Password | string; Default: admin01 | Password used for authentication on the SMPP server |
Server port | integer [0..65535]; Default: 7777 | SMPP server port |
