Template:Networking rut manual sms gateway: Difference between revisions

From Teltonika Networks Wiki
m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) (.*) (.*) (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}")
No edit summary
(38 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
==Summary==
==Summary==


The <b>SMS Gateway</b> service is used to set up various SMS related functions, such SMS control via HTTP Post/Get and automated operations such as Scheduled SMS, Email to SMS and SMS Forwarding to HTTP, Email, SMS.
The <b>SMS Gateway</b> service is used to set up various SMS related (mostly automated) functions. This chapter is a summary of the SMS Gateway service of {{{name}}} routers.


This chapter of the user manual provides an overview of the SMS Gateway page for {{{name}}} devices.
==Post/Get Configuration==
 
==Post/Get==


The <b>Post/Get Configuration</b> 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 <b>Post/Get Configuration</b> 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.
Line 19: Line 9:
The figure below is an example of the Post/Get Configuration page and the table below provides information on fields contained in that page:
The figure below is an example of the Post/Get Configuration page and the table below provides information on fields contained in that page:


[[File:Networking_device_manual_sms_gateway_post_get_v1.png]]
[[File:{{{file_post_get}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Field name</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
Line 29: Line 19:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: <b>no</b></td>
       <td>Turns SMS post/get on or off.</td>
       <td>Turns SMS post/get ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>User name</td>
       <td>Username</td>
       <td>string; default: <b>user1</b></td>
       <td>string; Default: <b>user1</b></td>
       <td>Username used for authorization when sending post/get requests.</td>
       <td>User name used for authorization when sending post/get requests</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Password</td>
     <td>Password</td>
         <td>string; default: <b>user_pass</b></td>
         <td>string; Default: <b>user_pass</b></td>
         <td>Password used for authorization when sending post/get requests.</td>
         <td>Password used for authorization when sending post/get requests</td>
     </tr>
     </tr>
</table>
</table>


===SMS Post/Get usage examples===
===SMS Post/Get usage examples===
----
----
Use a web browser or any other compatible software to send <b>HTTP POST/GET</b> strings to  
Use a web browser or any other compatible software to send <b>HTTP post/get</b> strings to the router. The router must be connected to a GSM network when using the <b>Send SMS</b> feature. Below you will find a table with possible actions and examples on how to use them:
the router. The router must be connected to a GSM network when using the <b>Send SMS</b>  
feature. Below you will find a table with possible actions and examples on how to use them:


<table class="nd-othertables_2">
<table class="nd-othertables_2">
     <tr>
     <tr>
         <th width="300">Action</th>
         <th width=300">Action</th>
       <th width="852">Post/get URL examples</th>
       <th width=852">Post/get URL examples</th>
     </tr>
     </tr>
     <tr>
     <tr>
Line 65: Line 52:
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Send mobile message to a single number</td>
     <td>Send mobile message</td>
         <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage</td>
         <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage</td>
    </tr>
    <tr>
    <td>Send mobile message to a group</td>
        <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&group=group_name&text=testmessage</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 83: Line 66:


<ul>
<ul>
     <li><b>192.168.1.1</b> - router's IP address, replace it with your [[{{{name}}}_LAN#General_Setup|LAN IP]] or [[{{{name}}}_WAN#Operation_Modes|WAN IP]] (when connecting remotely)</li>
     <li><b>192.168.1.1</b> - router's IP address. (Replace it with your [[{{{name}}}_LAN#General_Setup|LAN IP]] or [[{{{name}}}_WAN#Operation_Modes|WAN IP]] (when connecting remotely))</li>
     <li>SMS related post/get commands. Possible values are:
     <li>SMS related post/get commands. Possible values are:
         <ul>
         <ul>
             <li><i>sms_list</i> - view all SMS messages in storage</li>
             <li><i>sms_list</i> - view all SMS messages in storage</li>
             <li><i>sms_read</i> - read a single SMS message by specified SMS index (number)</li>
             <li><i>sms_read</i> - read a single SMS message by specified SMS index (number)</li>
             <li><i>sms_send</i> - send an SMS message to specified number</li>
             <li><i>sms_send</i> - send an SMS message to specified recipient</li>
             <li><i>sms_total</i> - display SMS storage statistics</li>
             <li><i>sms_total</i> - display SMS storage statistics</li>
             <li><i>sms_delete</i> - delete a single SMS message by specified SMS index (number)</li>
             <li><i>sms_delete</i> - delete a single SMS message by specified SMS index (number)</li>
Line 94: Line 77:
     </li>
     </li>
     <li><b>&</b> - separation symbol. After specifying the SMS command, other parameters must be separated by an <i>ampersand</i> (<i>&</i>) symbol</li>
     <li><b>&</b> - separation symbol. After specifying the SMS command, other parameters must be separated by an <i>ampersand</i> (<i>&</i>) symbol</li>
     <li><b>username</b> - SMS POST/GET configuration user name</li>
     <li><b>username</b> - SMS post/get configuration user name</li>
     <li><b>password</b> - SMS POST/GET configuration password</li>
     <li><b>password</b> - SMS post/get configuration password</li>
     <li><b>number</b> - SMS message index or (depending on context) recipient's phone number. SMS message indexes can be viewed with the <i>sms_list</i> command.<br>Correct phone number format is:
     <li><b>number</b> - SMS message index or (depending on context) recipient's phone number. SMS message indexes can be viewed with the <i>sms_list</i> command.<br>Correct phone number format is:
         <ul>
         <ul>
Line 113: Line 96:
<b>Important note</b>: all POP3 server email messages from inbox will be deleted when using this service.
<b>Important note</b>: all POP3 server email messages from inbox will be deleted when using this service.


[[File:Networking_device_manual_sms_gateway_email_to_sms_v1.png]]
[[File:{{{file_email_to_sms}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Field name</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
Line 123: Line 106:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: <b>no</b></td>
       <td>Turns Email to SMS on or off.</td>
       <td>Turns Email to SMS ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>POP3 server</td>
       <td>POP3 server</td>
       <td>host | ip; default: <b>none</b></td>
       <td>host | ip; Default: <b>none</b></td>
       <td>Email service provider's POP3 server address (can be looked up online).</td>
       <td>Email service provider's POP3 server address (can be looked up online)</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Server port</td>
     <td>Server port</td>
         <td>integer [0..65535]; default: <b>none</b></td>
         <td>integer [0..65535]; Default: <b>none</b></td>
         <td>Email service provider's POP3 server port (can be looked up online).</td>
         <td>Email service provider's POP3 server port (can be looked up online)</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>User name</td>
     <td>User name</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: <b>none</b></td>
         <td>Email account username, used in authentication when connecting to the email client.</td>
         <td>Email account user name. This is information is used by router in order to atuhenticate itself when connecting to the email client</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Password</td>
       <td>Password</td>
       <td>string; default: <b>none</b></td>
       <td>string; Default: <b>none</b></td>
       <td>Email account password, used in authentication when connecting to the email client.</td>
       <td>Email account password. This is information is used by router in order to atuhenticate itself when connecting to the email client</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Secure connection (SSL)</td>
     <td>Secure connection (SSL)</td>
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; Default: <b>no</b></td>
         <td><b>SSL</b> 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>
         <td><b>SSL</b> 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>
     <tr>
     <tr>
     <td>Max. email symbol count</td>
     <td>Max. email symbol count/td>
         <td>integer; default: <b>160</b></td>
         <td>integer; Default: <b>160</b></td>
         <td>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 be ignored.</td>
         <td>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</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Check email every</td>
     <td>Check email every</td>
         <td>time [1 minute to 15 days]; default: <b>1 minute</b></td>
         <td>time [1 minute to 15 days]; Default: <b>1 minute</b></td>
         <td>Email inbox check interval.</td>
         <td>Email inbox check interval</td>
     </tr>
     </tr>
</table>
</table>


<b>Additional note</b>: you may have noticed that there is no option where you can specify  
<b>Additional note</b>: you may have noticed that there is no option where you can specify the recipient's phone number. As mentioned earlier, <b>Email to SMS</b> 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
the recipient's phone number. As mentioned earlier, <b>Email to SMS</b> doesn't forward all  
emails, just 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:
Correct phone number format is:
Line 175: Line 155:
</ul>
</ul>


For example, a valid number would be <b>0037000000000</b> (370 is country code and 00000000 is the receiver's phone number, all preceded by 00).
For example, a valid number would be <b>0037012345678</b> (370 is country code and 12345678 is the receiver's phone number, all preceded by 00)


==Scheduled SMS==
==Scheduled SMS==
Line 183: Line 163:
After this you will be redirected to the <b>Scheduled Messages Configuration</b> 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 <b>Messages To Send</b> section:
After this you will be redirected to the <b>Scheduled Messages Configuration</b> 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 <b>Messages To Send</b> section:


[[File:Networking_device_manual_sms_gateway_scheduled_sms_v2.png]]
[[File:{{{file_scheduled_sms}}}]]


===Scheduled Messages Configuration===
===Scheduled Messages Configuration===
Line 189: Line 169:
The figure below is an example of the <b>Scheduled Messages Configuration</b> window and the table below provides information on the field contained in that window:
The figure below is an example of the <b>Scheduled Messages Configuration</b> window and the table below provides information on the field contained in that window:


[[File:Networking_rut_manual_sms_gateway_scheduled_sms_configuration.png|border|class=tlt-border]]
[[File:{{{file_scheduled_sms_conf}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>Field name</th>
       <th>Value</th>
       <th>Value</th>
       <th>Description</th>
       <th>Description</th>
Line 199: Line 179:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: <b>no</b></td>
       <td>Turns the rule on or off.</td>
       <td>Turns the rule ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Recipient's phone number</td>
       <td>Recipient's phone number</td>
       <td>phone number; default: <b>none</b></td>
       <td>phone number; Default: <b>none</b></td>
       <td>Phone number of the recipient that will receive the scheduled messages.</td>
       <td>Phone number of th erecipient that will receive the scheduled messages</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Message text</td>
     <td>Message text</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: <b>none</b></td>
         <td>The message that will be sent.</td>
         <td>The message that will be sent</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Message sending interval</td>
     <td>Message sending interval</td>
         <td>time; default: <b>Day, hour 1, minute 1</b></td>
         <td>time; Default: <b>Day, hour 1, minute 1</b></td>
         <td>The frequency at which scheduled messages will be sent.</td>
         <td>The frequency at which scheduled messages will be sent</td>
     </tr>
     </tr>
</table>
</table>
Line 223: Line 203:
<b>Auto reply</b> 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:
<b>Auto reply</b> 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:


[[File:Networking_device_manual_sms_gateway_auto_reply_v1.png]]
[[File:{{{file_auto_reply}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>field name</th>
       <th>Value</th>
       <th>value</th>
       <th>Description</th>
       <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: <b>no</b></td>
       <td>Turns Auto Reply on or off.</td>
       <td>Turns Auto Reply ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Reply SMS Utilities rules</td>
       <td>Reply SMS Utilities rules</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: <b>no</b></td>
       <td>When enabled, the router will also reply to messages that trigger [[{{{name}}} SMS Utilities|SMS Utilities]] rules.</td>
       <td>When enabled, the router will also reply to messages that trigger [[{{{name}}} SMS Utilities|SMS Utilities]] rules</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Don't save received messages</td>
     <td>Don't save received messages</td>
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; Default: <b>no</b></td>
         <td>When enabled, the router deletes all received SMS messages.</td>
         <td>When enabled, the router deletes all received SMS messages</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Message text</td>
     <td>Mode</td>
         <td>string; default: <b>none</b></td>
         <td>Everyone | Listed numbers; Default: <b>Everyone</b></td>
         <td>Text that will be sent in the automatic response.</td>
         <td>Indicates whether the router should reply to messages from all recipients or just the specified numbers</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Mode</td>
     <td>Message text</td>
         <td>Everyone | Listed numbers; default: <b>Everyone</b></td>
         <td>string; Default: <b>none</b></td>
         <td>Indicates whether the router should reply to messages from all recipients or just the specified numbers.</td>
         <td>Text that will be sent in the automatic response</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Recipient's phone number</td>
     <td>Recipient's phone number</td>
         <td>phone number; default: <b>none</b></td>
         <td>phone number; Default: <b>none</b></td>
         <td>Phone number(s) that will trigger Auto Reply. To add multiple numbers, click the [[File:Green_plus.png]] symbol.<br>This field becomes visible if the chosen <i>Mode</i> is "From listed numbers only".</td>
         <td>Phone number(s) that will trigger Auto Reply. To add more numbers, click the [[File:Green_plus.png]] symbol.<br>This field becomes visible if the chosen <i>Mode</i> is "From listed numbers only"</td>
     </tr>
     </tr>
</table>
</table>
 
<!--
==SMS Forwarding==
==SMS Forwarding==
The <b>SMS Forwarding</b> tab contains three sections:
<ul>
    <li>[[{{{name}}} SMS Gateway#SMS_Forwarding_To_HTTP|SMS Forwarding To HTTP]]</li>
    <li>[[{{{name}}} SMS Gateway#SMS_Forwarding_To_SMS|SMS Forwarding To SMS]]</li>
    <li>[[{{{name}}} SMS Gateway#SMS_Forwarding_To_Email|SMS Forwarding To Email]]</li>
</ul>
Each of which can be used to set up forwarding of incoming SMS message to either HTTP, email or another phone number.


===SMS Forwarding To HTTP===
===SMS Forwarding To HTTP===
----
----
The <b>SMS Forwarding To HTTP</b> 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:
The SMS Forwarding To HTTP functionality forwards SMS messages to HTTP, using either POST or GET methods.


[[File:Networking_device_manual_sms_gateway_sms_forwarding_http_v1.png]]
[[Image:Services sms gateway forwarding http.PNG]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>field name</th>
       <th>Value</th>
       <th>value</th>
       <th>Description</th>
       <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>Turns SMS Forwarding To HTTP on or off.</td>
       <td>Turns SMS Forwarding To HTTP ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Forward SMS Utilities rules</td>
       <td>Forward SMS Utilities rules</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>When checked, the router will also forward SMS Utilities rules. By default router will not forward SMS messages which are SMS Utilities rules.</td>
       <td>If enabled, the router will also forward SMS Utilities rules to HTTP</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Use HTTPS</td>
     <td>Use HTTPS</td>
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; Default: '''no'''</td>
         <td>Check to use the HTTPS protocol instead of HTTP.</td>
         <td>ses the HTTPS protocol instead of HTTP</td>
    </tr>
    <tr>
    <td>Encode message text to Base64</td>
        <td>yes | no; default: <b>no</b></td>
        <td>Message text will be encoded to a Base64 string. Enable this to preserve Unicode characters in the message text.</td>
    </tr>
    <tr>
    <td>HTTPS Certificate verification</td>
        <td>Ignore | Verify; default: <b>Ignore</b></td>
        <td>Indicates whether the server's certificate will be ignored or verified.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Method</td>
     <td>Method</td>
         <td>Post | Get; default: <b>Get</b></td>
         <td>Post | Get; Default: '''Get'''</td>
         <td>Defines the HTTP transfer method.</td>
         <td>Defines the HTTP transfer method</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>URL</td>
       <td>URL</td>
       <td>host | ip | host:port | ip:port; default: <b>none</b></td>
       <td>host | ip; Default: " "</td>
       <td>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 <b>colon</b> (<b>:</b>) symbol followed by the port number (for example, 192.168.1.1:81).</td>
       <td>URL address to forward messages to</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Number value name</td>
       <td>Number value name</td>
       <td>string; default: <b>none</b></td>
       <td>string; Default: " "</td>
       <td>Name to assign the sender’s phone number value in query string.</td>
       <td>Name to assign to sender’s phone number value in query string</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Message value name</td>
     <td>Message value name</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: " "</td>
         <td>Name to assign the message text value in query string.</td>
         <td>Name to assign to message text value in query string</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Extra data pair 1 / Extra data pair 2</td>
     <td>Extra data pair 1 / Extra data pair 2</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: " "</td>
         <td>Transfers extra information through the HTTP request. Enter variable name on the left field and its value on the right.<br>For example, when using the Post method, one may enter some static information about the device, like 'Router name' on the left and '{{{name}}}' on the right.<br>This can also be utilized when using the Get method to request data from an HTTP server.</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>
     <tr>
     <tr>
     <td>Mode</td>
     <td>Mode</td>
         <td>All messages | From listed numbers; default: <b>All messages</b></td>
         <td>All messages | From listed numbers; Default: '''All messages'''</td>
         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>
         <td>Specifies which messages to forward</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Sender's phone number</td>
     <td>Sneder's phone number</td>
         <td>phone number; default: <b>none</b></td>
         <td>phone number; Default: " "</td>
         <td>Phone number(s) that will qualify for forwarding. To add multiple numbers, click the [[File:Services sms gateway auto reply plus symbol.PNG]] symbol. This field becomes visible when the "Mode" field value is set to 'From listed numbers'.</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>
</table>
</table>


====Forwarding To HTTP example====
===SMS Forwarding To SMS Configuration===
----
----
This example will atempt to explain how to use the data fields in SMS forwarding to HTTP configuration. The fields in question are <i>Number & Message value name</i> and <i>Extra data pair 1 & 2</i> fields. The figure below is the configuration we'll be using for this example:
The '''SMS Forwarding To SMS''' function forwards SMS messages to one or several recipients.
 
[[File:Networking_{{lc:{{{name}}}}}_manual_sms_gateway_sms_forwarding_http_example_v1.png]]
 
If you configure the router as seen in the image above and send an SMS message to the router containing the text <i>Hello!</i>, from the number <i>+37000000000</i>, the specified server should reiceve an encoded query string that looks like this:


Sender=%2B37000000000&Text=Hello%21&Name={{{name}}}&Code={{{code_encoded}}}
[[Image:Services sms gateway forwarding sms.PNG]]
 
The <i>&</i> symbol separates the the key-value pairs, while certain characters (like <i>+</i>, <i>!</i> and the <i>space</i> symbol) are encoded in UTF-8. When decoded it might look something like this:
 
Sender: +37000000000
Text: Hello!
Name: {{{name}}}
Code: {{{code_decoded}}}
 
===SMS Forwarding To SMS===
----
The <b>SMS Forwarding To SMS</b> 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:
 
[[File:Networking_device_manual_sms_gateway_sms_forwarding_sms_v1.png]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>field name</th>
       <th>Value</th>
       <th>value</th>
       <th>Description</th>
       <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>Turns SMS Forwarding To SMS on or off.</td>
       <td>Turns SMS Forwarding To SMS ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Forward SMS Utilities rules</td>
       <td>Forward SMS Utilities rules</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>When checked the router will also forward SMS Utilities rules. By default router will not forward SMS messages which are SMS Utilities rules.</td>
       <td>If enabled, the router will also forward SMS Utilities rules to SMS</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Add sender's number</td>
     <td>Add sender number</td>
         <td>yes | no; default: <b>no</b></td>
         <td>yes | no; Default: '''no'''</td>
         <td>Adds the original sender’s number to the forwarded message.</td>
         <td>Adds original sender’s number of the forwarded message</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Mode</td>
     <td>Mode</td>
         <td>All messages | From listed numbers; default: <b>All messages</b></td>
         <td>All messages | From listed numbers; Default: '''All messages'''</td>
         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>
         <td>Specifies which messages to forward</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Sender's phone number</td>
     <td>Sender's phone number(s)</td>
         <td>phone number; default: <b>none</b></td>
         <td>phone number; Default: " "</td>
         <td>Phone number(s) that will qualify for forwarding. To add multiple numbers, click the [[File:Services sms gateway auto reply plus symbol.PNG]] symbol. This field becomes visible when the "Mode" field value is set to 'From listed numbers'.</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>
     <tr>
     <tr>
     <td>Recipient's phone number(s)</td>
     <td>Recipient's phone number(s)</td>
         <td>phone number; default: <b>none</b></td>
         <td>phone number; Default: " "</td>
         <td>Phone number(s) to which messages are going to be forwarded to. To add multiple numbers, click the [[Image:Services sms gateway auto reply plus symbol.PNG]] symbol.</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>
     </tr>
</table>
</table>


===SMS Forwarding To Email===
===SMS Forwarding To Email Configuration===
----
----
The <b>SMS Forwarding To Email</b> function forwards received SMS messages to one or several
The '''SMS Forwarding To Email''' function forwards SMS messages to email.
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
[[Image:Services sms gateway forwarding email.PNG]]
below provides information on the configuration fields contained in that section:
 
[[File:Networking_device_manual_sms_gateway_sms_forwarding_email_v1.png]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>field name</th>
       <th>Value</th>
       <th>value</th>
       <th>Description</th>
       <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>Turns SMS Forwarding To Email on or off.</td>
       <td>Turns SMS Forwarding To SMS ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Forward SMS Utilities rules</td>
       <td>Forward SMS Utilities rules</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>When checked the router will also forward SMS Utilities rules (the default action is to not forward SMS messages that are SMS Utilities rule).</td>
       <td>If enabled, the router will also forward SMS Utilities rules to Email</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td>Add sender's number</td>
      <td>Add sender number</td>
        <td>yes | no; default: <b>no</b></td>
      <td>yes | no; Default: '''no'''</td>
        <td>Adds the original sender’s number to the forwarded message.</td>
      <td>Adds original sender’s number of the forwarded message</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Subject</td>
     <td>Subject</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: " "</td>
         <td>Text that will be inserted into the email's Subject field.</td>
         <td>Text that will be inserted in the email’s Subject field</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>SMTP server</td>
     <td>SMTP server</td>
         <td>host | ip; default: <b>none</b></td>
         <td>host | ip; Default: " "</td>
         <td>Your email service provider's SMTP server address. If you don't know this address, you can look it up online.</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>
     <tr>
     <tr>
       <td>SMTP port</td>
       <td>SMTP port</td>
       <td>integer [0..65535]; default: <b>none</b></td>
       <td>integer [0..65535]; Default: " "</td>
       <td>Your email service provider's SMTP server port. If you don't know the port number, you can look it up online.</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>
     <tr>
     <tr>
       <td>Secure connection</td>
       <td>Secure connection</td>
       <td>yes | no; default: <b>no</b></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>
       <td>Enables the use of cryptographic protocols. Enable only if your SMTP server supports SSL or TLS</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>User name</td>
     <td>User name</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: " "</td>
         <td>Your email account's login user name.</td>
         <td>Your email account's login user name</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Password</td>
     <td>Password</td>
         <td>string; default: <b>none</b></td>
         <td>string; Default: " "</td>
         <td>Your email account's login password.</td>
         <td>Your email account's login password</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Sender's email address</td>
       <td>Sender's email address</td>
       <td>email address; default: <b>none</b></td>
       <td>email; Default: " "</td>
       <td>The address that will be used to send emails from.</td>
       <td>The address that will be used to send emails from</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Recipient's email address</td>
     <td>Recipient's email address</td>
         <td>email address; default: <b>none</b></td>
         <td>email; Default: " "</td>
         <td>The address(es) to which incoming SMS messages will be forwarded. To add multiple addresses, click the [[File:Services sms gateway auto reply plus symbol.PNG]] symbol.</td>
         <td>Address to which messages will be forwarded to</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Mode</td>
     <td>Mode</td>
         <td>All messages | From listed numbers; default: <b>All messages</b></td>
         <td>All messages | From listed numbers; Default: '''All messages'''</td>
         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>
         <td>Specifies which messages to forward</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Sender's phone number</td>
     <td>Sender's phone number(s)</td>
         <td>phone number; default: <b>none</b></td>
         <td>phone number; Default: " "</td>
         <td>Phone number(s) that will qualify for forwarding. To add multiple numbers, click the [[File:Services sms gateway auto reply plus symbol.PNG]] symbol. This field becomes visible when the "Mode" field value is set to 'From listed numbers'.</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>
</table>
</table>


==SMPP==
==SMPP==


<b>Short Message Peer-to-Peer</b> (<b>SMPP</b>) 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:
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).


[[File:Networking_device_manual_sms_gateway_smpp_v1.png]]
[[Image:Services sms gateway smpp.PNG]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <th>field name</th>
       <th>Value</th>
       <th>value</th>
       <th>Description</th>
       <th>description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>yes | no; default: <b>no</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>Turns SMPP on or off.</td>
       <td>Turns SMPP ON or OFF</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>User name</td>
       <td>User name</td>
       <td>yes | no; default: <b>admin</b></td>
       <td>yes | no; Default: '''no'''</td>
       <td>User name used for authentication on the SMPP server.</td>
       <td>User name used for authentication on the SMPP server</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Password</td>
     <td>Password</td>
         <td>string; default: <b>admin01</b></td>
         <td>string; Default: " "</td>
         <td>Password used for authentication on the SMPP server.</td>
         <td>Password used for authentication on the SMPP server</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Server port</td>
     <td>Server port</td>
         <td>integer [0..65535]; default: <b>7777</b></td>
         <td>integer [0..65535]; Default: " "</td>
         <td>SMPP server port.</td>
         <td>SMPP server's port</td>
     </tr>
     </tr>
</table>
</table>


[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} WebUI]]
-->

Revision as of 15:30, 29 March 2019

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 {{{name}}} routers.

Post/Get Configuration

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:

[[File:{{{file_post_get}}}]]

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 [[{{{name}}}_LAN#General_Setup|LAN IP]] or [[{{{name}}}_WAN#Operation_Modes|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
    • <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)

  • 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.

[[File:{{{file_email_to_sms}}}]]

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)
User name 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 atuhenticate 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/td> 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:

[[File:{{{file_scheduled_sms}}}]]

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:

[[File:{{{file_scheduled_sms_conf}}}]]

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 th erecipient 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:

[[File:{{{file_auto_reply}}}]]

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 [[{{{name}}} SMS Utilities|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 more numbers, click the symbol.
This field becomes visible if the chosen Mode is "From listed numbers only"