Template:Networking rut manual sms gateway: Difference between revisions

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.

 

==Post/Get==

[[File:Networking_device_manual_sms_gateway_post_get_v1.png]]

         <th>Field</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns SMS post/get on or off.</td>

       <td>User name</td>

       <td>string; default: <b>user1</b></td>

       <td>Username used for authorization when sending post/get requests.</td>

         <td>string; default: <b>user_pass</b></td>

         <td>Password used for authorization when sending post/get requests.</td>

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:

         <th width="300">Action</th>

       <th width="852">Post/get URL examples</th>

       <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_list?username=user1&password=user_pass</td>

       <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_read?username=user1&password=user_pass&number=1</td>

     <td>Send mobile message to a single number</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&group=group_name&text=testmessage</td>

         <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_total?username=user1&password=user_pass</td>

         <td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_delete?username=user1&password=user_pass&number=1</td>

     <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><b>username</b> - SMS POST/GET configuration user name</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><i>00</i> - number must be preceded by two zeros</li>

            <li><i><country_code></i> - the next following element is the number holder's country code</li>

            <li><i><receivers_number></i> - phone number of the recipient</li>

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)

    </li>

     <li><b>text</b> - SMS message text</li>

 

<b>Email to SMS</b> 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.

<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]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns Email to SMS on or off.</td>

       <td>host | ip; default: <b>none</b></td>

       <td>Email service provider's POP3 server address (can be looked up online).</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>string; default: <b>none</b></td>

         <td>Email account username, used in authentication when connecting to the email client.</td>

       <td>string; default: <b>none</b></td>

       <td>Email account password, used in authentication when connecting to the email client.</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>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>time [1 minute to 15 days]; default: <b>1 minute</b></td>

         <td>Email inbox check interval.</td>

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

 

    <li><i><country_code></i> - the next following element is the number holder's country code</li>

    <li><i><receivers_number></i> - phone number of the recipient</li>

 

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

<b>Scheduled SMS</b> 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 <b>Phone number</b> field located in the Scheduled Messages Configuration section and click the <b>Add</b> button located next to it.

 

[[File:Networking_device_manual_sms_gateway_scheduled_sms_v2.png]]

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_device_manual_sms_gateway_scheduled_sms_configuration_v1.png]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns the rule on or off.</td>

       <td>phone number; default: <b>none</b></td>

       <td>Phone number of the recipient that will receive the scheduled messages.</td>

         <td>string; default: <b>none</b></td>

         <td>The message that will be sent.</td>

         <td>time; default: <b>Day, hour 1, minute 1</b></td>

         <td>The frequency at which scheduled messages will be sent.</td>

<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]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns Auto Reply on or off.</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>yes | no; default: <b>no</b></td>

         <td>When enabled, the router deletes all received SMS messages.</td>

     <td>Message text</td>

         <td>string; default: <b>none</b></td>

         <td>Text that will be sent in the automatic response.</td>

     <td>Mode</td>

         <td>Everyone | Listed numbers; default: <b>Everyone</b></td>

         <td>Indicates whether the router should reply to messages from all recipients or just the specified numbers.</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>

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:

[[File:Networking_device_manual_sms_gateway_sms_forwarding_http_v1.png]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns SMS Forwarding To HTTP on or off.</td>

       <td>yes | no; default: <b>no</b></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>yes | no; default: <b>no</b></td>

         <td>Check to use the HTTPS protocol instead of HTTP.</td>

        <td>Indicates whether the server's certificate will be ignored or verified.</td>

         <td>Post | Get; default: <b>Get</b></td>

         <td>Defines the HTTP transfer method.</td>

       <td>host | ip | host:port | ip:port; default: <b>none</b></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>string; default: <b>none</b></td>

       <td>Name to assign the sender’s phone number value in query string.</td>

         <td>string; default: <b>none</b></td>

         <td>Name to assign the message text value in query string.</td>

         <td>string; default: <b>none</b></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>All messages | From listed numbers; default: <b>All messages</b></td>

         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>

     <td>Sender's phone number</td>

         <td>phone number; default: <b>none</b></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>

====Forwarding To HTTP example====

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:

 

[[File:Networking_{{lc:{{{name}}}}}_manual_sms_gateway_sms_forwarding_http_example_v1.png]]

 

 

 

 

 

[[File:Networking_device_manual_sms_gateway_sms_forwarding_sms_v1.png]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns SMS Forwarding To SMS on or off.</td>

       <td>yes | no; default: <b>no</b></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>Add sender's number</td>

         <td>yes | no; default: <b>no</b></td>

         <td>Adds the original sender’s number to the forwarded message.</td>

         <td>All messages | From listed numbers; default: <b>All messages</b></td>

         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>

     <td>Sender's phone number</td>

         <td>phone number; default: <b>none</b></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; default: <b>none</b></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>

===SMS Forwarding To Email===

The <b>SMS Forwarding To Email</b> function forwards received SMS messages to one or several

email addresses. If this service is enabled and configured correctly, when the router receives

 

[[File:Networking_device_manual_sms_gateway_sms_forwarding_email_v1.png]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns SMS Forwarding To Email on or off.</td>

       <td>yes | no; default: <b>no</b></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>Add sender's number</td>

        <td>yes | no; default: <b>no</b></td>

        <td>Adds the original sender’s number to the forwarded message.</td>

         <td>string; default: <b>none</b></td>

         <td>Text that will be inserted into the email's Subject field.</td>

         <td>host | ip; default: <b>none</b></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>integer [0..65535]; default: <b>none</b></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>yes | no; default: <b>no</b></td>

       <td>Enables the use of cryptographic protocols. Enable only if your SMTP server supports SSL or TLS.</td>

         <td>string; default: <b>none</b></td>

         <td>Your email account's login user name.</td>

         <td>string; default: <b>none</b></td>

         <td>Your email account's login password.</td>

       <td>email address; default: <b>none</b></td>

       <td>The address that will be used to send emails from.</td>

         <td>email address; default: <b>none</b></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>All messages | From listed numbers; default: <b>All messages</b></td>

         <td>Specifies whether all messages should be forwarded or only those received from specific numbers.</td>

     <td>Sender's phone number</td>

         <td>phone number; default: <b>none</b></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>

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

[[File:Networking_device_manual_sms_gateway_smpp_v1.png]]

         <th>Field</th>

       <th>Value</th>

       <th>Description</th>

       <td>yes | no; default: <b>no</b></td>

       <td>Turns SMPP on or off.</td>

       <td>yes | no; default: <b>admin</b></td>

       <td>User name used for authentication on the SMPP server.</td>

         <td>string; default: <b>admin01</b></td>

         <td>Password used for authentication on the SMPP server.</td>

         <td>integer [0..65535]; default: <b>7777</b></td>

         <td>SMPP server port.</td>

[[Category:{{{name}}} Services section]]