Difference between revisions of "RUT900 SMS Gateway"

From Teltonika Networks Wiki
Line 1: Line 1:
==Summary==
+
{{Template: Networking_device_manual_sms_gateway
 
+
| name                         = RUT900
This chapter is a summary of the SMS Gateway function of RUT routers.
+
| series                      = RUT9xx
 
+
| code_decoded                = RUT900 S024E0
==Post/Get Configuration==
+
| code_encoded                = RUT900%20S024E0
 
+
| file_post_get                = Networking_device_manual_sms_gateway_post_get_v1.png
'''Post/Get Configuration''' allows you to perform action requests by writing them in the URL after your device’s IP address.
+
| file_email_to_sms            = Networking_device_manual_sms_gateway_email_to_sms_v1.png
 
+
| file_scheduled_sms          = Networking_device_manual_sms_gateway_scheduled_sms_v2.png
[[Image:Services sms gateway postget.PNG]]
+
| file_scheduled_sms_conf      = Networking_device_manual_sms_gateway_scheduled_sms_configuration_v1.png
 
+
| file_auto_reply              = Networking_device_manual_sms_gateway_auto_reply_v1.png
<table class="nd-mantable">
+
| file_forwarding_http         = Networking_device_manual_sms_gateway_sms_forwarding_http_v1.png
    <tr>
+
| file_forwarding_http_example = Networking_rut900_manual_sms_gateway_sms_forwarding_http_example_v1.png
        <th>field name</th>
+
| file_forwarding_sms          = Networking_device_manual_sms_gateway_sms_forwarding_sms_v1.png
      <th>value</th>
+
| file_forwarding_email        = Networking_device_manual_sms_gateway_sms_forwarding_email_v1.png
      <th>description</th>
+
| file_smpp                    = Networking_device_manual_sms_gateway_smpp_v1.png
    </tr>
+
}}
    <tr>
 
      <td>Enable*</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles Post/Get ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Username</td>
 
      <td>string; Default: " "</td>
 
      <td>User name used for authorization</td>
 
    </tr>
 
    <tr>
 
    <td>Password</td>
 
        <td>tring; Default: " "</td>
 
        <td>Password used for authorization</td>
 
    </tr>
 
</table>
 
'''*Do not forget to change parameters in the URL according to your POST/GET Configuration!'''
 
 
 
===SMS by HTTP POST/GET===
 
----
 
It is possible to read and send SMS messages by using a valid '''HTTP POST/GET''' syntax. Use a web browser or any other compatible software to submit '''HTTP POST/GET''' strings to the router. The router must be connected to a GSM network when using the '''Send SMS''' feature.
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th style="width: 300px">ACTION</th>
 
      <th style="width: 1450px">POST/GET URL EXAMPLE</th>
 
    </tr>
 
    <tr>
 
      <td>View mobile messages list</td>
 
      <td>http://youripaddress/cgi-bin/sms_list?username=admin&password=admin01</td>
 
    </tr>
 
    <tr>
 
      <td>Read mobile message</td>
 
      <td>http://youripaddress/cgi-bin/sms_read?username=admin&password=admin01&number=1</td>
 
    </tr>
 
    <tr>
 
    <td>Send mobile message</td>
 
        <td>http://youripaddress/cgi-bin/sms_send?username=admin&password=admin01&number=0037060000001&text=testmessage</td>
 
    </tr>
 
    <tr>
 
    <td>View mobile messages total</td>
 
        <td>http://youripaddress/cgi-bin/sms_total?username=admin&password=admin01</td>
 
    </tr>
 
    <tr>
 
    <td>Delete mobile message</td>
 
        <td>http://youripaddress/cgi-bin/sms_delete?username=admin&password=admin01&number=1</td>
 
    </tr>
 
</table>
 
 
 
'''youripaddress''' - router's LAN IP address; '''username''' - router's login admin user name; '''password''' - router's login password; '''number''' - SMS message index number or recipient's phone number (phone number must contain country code. Phone number format is: 00{COUNTRY_CODE} {RECEIVER_NUMBER}, e.g., 0037062312345 (370 is country code and 62312345 is receiver's phone number)); '''text''' - SMS message text
 
 
 
==Email to SMS==
 
 
 
Email to SMS is a function that checks your email’s inbox at the specified frequency and, if it finds any new received emails with a specific subject, it converts them to SMS messages.
 
 
 
'''NOTE''': all POP3 server email messages from inbox will be deleted.
 
 
 
 
 
[[Image: Services sms gateway emailtosms.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles Email to SMS ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>POP3 server</td>
 
      <td>host | ip; Default: " "</td>
 
      <td>Your email service provider's POP3 server address. If you don't know this address, simply look it up online</td>
 
    </tr>
 
    <tr>
 
    <td>Server port</td>
 
        <td>integer [0..65535]; Default: " "</td>
 
        <td>Server authentication port. As with POP3 server, your email service provider's POP3 port can be looked up online</td>
 
    </tr>
 
    <tr>
 
    <td>User name</td>
 
        <td>string; Default: " "</td>
 
        <td>Your email account’s user name</td>
 
    </tr>
 
    <tr>
 
      <td>Password</td>
 
      <td>string; Default: " "</td>
 
      <td>Your email account’s password</td>
 
    </tr>
 
    <tr>
 
    <td>Secure connection (SSL)</td>
 
        <td>yes | no; Default: '''no'''</td>
 
        <td>'''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</td>
 
    </tr>
 
    <tr>
 
    <td>Check email every</td>
 
        <td>time; Default: '''1 minute'''</td>
 
        <td>Time interval to check email inbox</td>
 
    </tr>
 
</table>
 
 
 
You may have noticed that there is no option where you can specify recipient's phone number. The reason for that is that '''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 the number specified in the subject). Phone number must contain country code. Phone number format is: 00{COUNTRY_CODE} {RECEIVER_NUMBER}, e.g., 0037062312345 (370 is country code and 62312345 is receiver's phone number)
 
 
 
==Scheduled SMS==
 
 
 
'''Scheduled SMS''' allows you to periodically send automated SMS messages to a specified number. Scheduled messages are managed in rule form, i.e., similar to '''SMS Utilities'''. 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 press the '''Add''' button located next to it.
 
 
 
After this you will be redirected to the '''Scheduled Messages Configuration''' window.
 
 
 
===Scheduled Messages Configuration===
 
----
 
'''Scheduled messages''' provides you with the possibility to set up a rule that sends SMS messages to specified recipients periodically. To create a new rule, enter the recipient's Phone number and Message sending interval and click the "Add" button. The new rule will appear in the "Messages to send" table, but will be disabled and unconfigured. To configure your rule, simply click the "Edit" button located next to it.
 
 
 
 
 
[[Image:Services sms gateway scheduled.PNG ]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles the rule ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Recipient's phone number</td>
 
      <td>phone number; Default: " "</td>
 
      <td>Phone number that will receive the scheduled messages</td>
 
    </tr>
 
    <tr>
 
    <td>Message text</td>
 
         <td>string; Default: " "</td>
 
        <td>The message that will be sent</td>
 
    </tr>
 
    <tr>
 
    <td>Message sending interval</td>
 
        <td>time; Default: '''Day, hour 1, minute 1'''</td>
 
        <td>The frequency at which scheduled messages will be sent</td>
 
    </tr>
 
</table>
 
 
 
==Auto Reply==
 
 
 
'''Auto reply''' allows you to configure automatic replying to SMS messages that the router receives from everyone or from listed numbers only.
 
 
 
[[Image:Services sms gateway auto reply.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles Auto Reply ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Reply SMS Utilities rules</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>If enabled, the router will auto reply even SMS Utilieties rules</td>
 
    </tr>
 
    <tr>
 
    <td>Don't save received messages</td>
 
        <td>yes | no; Default: '''no'''</td>
 
        <td>If enabled, the router will delete received SMS messages</td>
 
    </tr>
 
    <tr>
 
    <td>Mode</td>
 
        <td>Everyone | From listed number only; Default: '''Everyone'''</td>
 
        <td>Specifies whether to auto reply to every phone number or just just specified phone numbers</td>
 
    </tr>
 
    <tr>
 
    <td>Message text</td>
 
        <td>string; Default: " "</td>
 
        <td>The message that will be sent in reply</td>
 
    </tr>
 
    <tr>
 
    <td>Recipient's phone number</td>
 
        <td>phone number; Default: " "</td>
 
        <td>Phone number(s) that will qualify for Auto Reply. To add more numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol. This field only becomes visible if the chosen Mode is '''From listed numbers only'''</td>
 
    </tr>
 
</table>
 
 
 
==SMS Forwarding==
 
 
 
===SMS Forwarding To HTTP===
 
----
 
The SMS Forwarding To HTTP functionality forwards SMS messages to HTTP, using either POST or GET methods.
 
 
 
[[Image:Services sms gateway forwarding http.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles SMS Forwarding To HTTP ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Forward SMS Utilities rules</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>If enabled, the router will also forward SMS Utilities rules to HTTP</td>
 
    </tr>
 
    <tr>
 
    <td>Use HTTPS</td>
 
        <td>yes | no; Default: '''no'''</td>
 
        <td>ses the HTTPS protocol instead of HTTP</td>
 
    </tr>
 
    <tr>
 
    <td>Method</td>
 
        <td>Post | Get; Default: '''Get'''</td>
 
        <td>Defines the HTTP transfer method</td>
 
    </tr>
 
    <tr>
 
      <td>URL</td>
 
      <td>host | ip; Default: " "</td>
 
      <td>URL address to forward messages to</td>
 
    </tr>
 
    <tr>
 
      <td>Number value name</td>
 
      <td>string; Default: " "</td>
 
      <td>Name to assign to sender’s phone number value in query string</td>
 
    </tr>
 
    <tr>
 
    <td>Message value name</td>
 
        <td>string; Default: " "</td>
 
        <td>Name to assign to message text value in query string</td>
 
    </tr>
 
    <tr>
 
    <td>Extra data pair 1 / Extra data pair 2</td>
 
        <td>string; Default: " "</td>
 
        <td>If you want to transfer some extra information through the HTTP query, enter variable name on the left field and its value on the right</td>
 
    </tr>
 
    <tr>
 
    <td>Mode</td>
 
        <td>All messages | From listed numbers; Default: '''All messages'''</td>
 
        <td>Specifies which messages to forward</td>
 
    </tr>
 
    <tr>
 
    <td>Sneder's phone number</td>
 
        <td>phone number; Default: " "</td>
 
        <td>Phone number(s) that will qualify for forwarding. To add more numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol. This field only becomes visible if the chosen Mode is '''From listed numbers'''</td>
 
    </tr>
 
</table>
 
 
 
===SMS Forwarding To SMS Configuration===
 
----
 
The '''SMS Forwarding To SMS''' function forwards SMS messages to one or several recipients.
 
 
 
[[Image:Services sms gateway forwarding sms.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles SMS Forwarding To SMS ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Forward SMS Utilities rules</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>If enabled, the router will also forward SMS Utilities rules to SMS</td>
 
    </tr>
 
    <tr>
 
    <td>Add sender number</td>
 
        <td>yes | no; Default: '''no'''</td>
 
        <td>Adds original sender’s number of the forwarded message</td>
 
    </tr>
 
    <tr>
 
    <td>Mode</td>
 
        <td>All messages | From listed numbers; Default: '''All messages'''</td>
 
        <td>Specifies which messages to forward</td>
 
    </tr>
 
    <tr>
 
    <td>Sender's phone number(s)</td>
 
        <td>phone number; Default: " "</td>
 
        <td>Phone number(s) that will qualify for forwarding. To add more numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol. This field only becomes visible if the chosen Mode is '''From listed numbers'''</td>
 
    </tr>
 
    <tr>
 
    <td>Recipient's phone number(s)</td>
 
        <td>phone number; Default: " "</td>
 
        <td>Phone number(s) to which messages are going to be forwarded to. To add more numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol</td>
 
    </tr>
 
</table>
 
 
 
===SMS Forwarding To Email Configuration===
 
----
 
The '''SMS Forwarding To Email''' function forwards SMS messages to email.
 
 
 
[[Image:Services sms gateway forwarding email.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles SMS Forwarding To SMS ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>Forward SMS Utilities rules</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>If enabled, the router will also forward SMS Utilities rules to Email</td>
 
    </tr>
 
    <tr>
 
      <td>Add sender number</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Adds original sender’s number of the forwarded message</td>
 
    </tr>
 
    <tr>
 
    <td>Subject</td>
 
        <td>string; Default: " "</td>
 
        <td>Text that will be inserted in the email’s Subject field</td>
 
    </tr>
 
    <tr>
 
    <td>SMTP server</td>
 
        <td>host | ip; Default: " "</td>
 
        <td>Your email service provider's SMTP server’s address. If you don't know this address, you can look it up online</td>
 
    </tr>
 
    <tr>
 
      <td>SMTP port</td>
 
      <td>integer [0..65535]; Default: " "</td>
 
      <td>Your email service provider's SMTP server’s port. If you don't know the port number, you can look it up online</td>
 
    </tr>
 
    <tr>
 
      <td>Secure connection</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Enables the use of cryptographic protocols. Enable only if your SMTP server supports SSL or TLS</td>
 
    </tr>
 
    <tr>
 
    <td>User name</td>
 
        <td>string; Default: " "</td>
 
        <td>Your email account's login user name</td>
 
    </tr>
 
    <tr>
 
    <td>Password</td>
 
        <td>string; Default: " "</td>
 
        <td>Your email account's login password</td>
 
    </tr>
 
    <tr>
 
      <td>Sender's email address</td>
 
      <td>email; Default: " "</td>
 
      <td>The address that will be used to send emails from</td>
 
    </tr>
 
    <tr>
 
    <td>Recipient's email address</td>
 
        <td>email; Default: " "</td>
 
        <td>Address to which messages will be forwarded to</td>
 
    </tr>
 
    <tr>
 
    <td>Mode</td>
 
        <td>All messages | From listed numbers; Default: '''All messages'''</td>
 
        <td>Specifies which messages to forward</td>
 
    </tr>
 
    <tr>
 
    <td>Sender's phone number(s)</td>
 
        <td>phone number; Default: " "</td>
 
        <td>Phone number(s) that will qualify for forwarding. To add more numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol. This field only becomes visible if the chosen Mode is '''From listed numbers'''</td>
 
    </tr>
 
</table>
 
 
 
==SMPP==
 
 
 
The 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).
 
 
 
[[Image:Services sms gateway smpp.PNG]]
 
 
 
<table class="nd-mantable">
 
    <tr>
 
        <th>field name</th>
 
      <th>value</th>
 
      <th>description</th>
 
    </tr>
 
    <tr>
 
      <td>Enable</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>Toggles SMPP ON or OFF</td>
 
    </tr>
 
    <tr>
 
      <td>User name</td>
 
      <td>yes | no; Default: '''no'''</td>
 
      <td>User name used for authentication on the SMPP server</td>
 
    </tr>
 
    <tr>
 
    <td>Password</td>
 
        <td>string; Default: " "</td>
 
        <td>Password used for authentication on the SMPP server</td>
 
    </tr>
 
    <tr>
 
    <td>Server port</td>
 
        <td>integer [0..65535]; Default: " "</td>
 
        <td>SMPP server's port</td>
 
    </tr>
 
</table>
 
 
 
[[Category:RUT900 WebUI]]
 

Revision as of 17:21, 9 April 2019

Main Page > RUT Routers > RUT900 > RUT900 Manual > RUT900 WebUI > RUT900 Services section > RUT900 SMS Gateway