Changes

Template:Networking rut manual sms gateway (view source)

Revision as of 13:51, 16 September 2020

330 bytes added , 13:51, 16 September 2020

no edit summary

Line 1: Line 1: +

{{Template: Networking_rutxxx_manual_fw_disclosure

+

| fw_version = {{{fw_version}}}

+

}}

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

−

~~{{Template: Networking_rutxxx_manual_fw_disclosure~~

−

~~| fw_version = {{{fw_version}}}~~

−

}}

==Post/Get==

Line 13: Line 12:

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

+

[[File:Networking_device_manual_sms_gateway_post_get_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 23: Line 22:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns SMS post/get ON or ~~OFF~~</td>

+

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

</tr>

<tr>

<td>Username</td>

−

<td>string; ~~Default~~: user1</td>

+

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

<td>User name used for authorization when sending post/get requests</td>

</tr>

<tr>

<td>Password</td>

−

<td>string; ~~Default~~: user_pass</td>

+

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

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

</tr>

Line 100: Line 99:

Important note: all POP3 server email messages from inbox will be deleted when using this service.

−

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

+

[[File:Networking_device_manual_sms_gateway_email_to_sms_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 110: Line 109:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns Email to SMS ON or ~~OFF~~</td>

+

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

</tr>

<tr>

<td>POP3 server</td>

−

<td>host | ip; ~~Default~~: none</td>

+

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

<td>Email service provider's POP3 server address (can be looked up online)</td>

</tr>

<tr>

<td>Server port</td>

−

<td>integer [0..65535]; ~~Default~~: none</td>

+

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

<td>Email service provider's POP3 server port (can be looked up online)</td>

</tr>

<tr>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</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>

<td>Password</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</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>

<td>Secure connection (SSL)</td>

−

<td>yes | no; ~~Default~~: no</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>Max. email symbol count</td>

−

<td>integer; ~~Default~~: 160</td>

+

<td>integer; default: 160</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>

<td>Check email every</td>

−

<td>time [1 minute to 15 days]; ~~Default~~: 1 minute</td>

+

<td>time [1 minute to 15 days]; default: 1 minute</td>

<td>Email inbox check interval</td>

</tr>

Line 167: Line 166:

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

+

[[File:Networking_device_manual_sms_gateway_scheduled_sms_v2.png]]

===Scheduled Messages Configuration===

Line 173: Line 172:

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

+

[[File:Networking_device_manual_sms_gateway_scheduled_sms_configuration_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 183: Line 182:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns the rule ON or ~~OFF~~</td>

+

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

</tr>

<tr>

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

−

<td>phone number; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

<td>Message text</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</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>time; default: Day, hour 1, minute 1</td>

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

</tr>

Line 207: Line 206:

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

+

[[File:Networking_device_manual_sms_gateway_auto_reply_v1.png]]

<tr>

−

<th>~~field name~~</th>

+

<th>Field</th>

−

<th>~~value~~</th>

+

<th>Value</th>

−

<th>~~description~~</th>

+

<th>Description</th>

</tr>

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns Auto Reply ON or ~~OFF~~</td>

+

<td>Turns Auto Reply on or off</td>

</tr>

<tr>

<td>Reply SMS Utilities rules</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

<td>When enabled, the router will also reply to messages that trigger [[{{{name}}} SMS Utilities|SMS Utilities]] rules</td>

</tr>

<tr>

<td>Don't save received messages</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

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

</tr>

<tr>

<td>Message text</td>

−

<td>string; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

−

<td>Everyone | Listed numbers; ~~Default~~: Everyone</td>

+

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

<td>Indicates whether the router should reply to messages from all recipients or just the specified numbers</td>

</tr>

<tr>

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

−

<td>phone number; ~~Default~~: none</td>

+

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

<td>Phone number(s) that will trigger Auto Reply. To add multiple numbers, click the [[File:Green_plus.png]] symbol. This field becomes visible if the chosen Mode is "From listed numbers only"</td>

</tr>

Line 257: Line 256:

</ul>

−

Each of which can be used to set up forwarding of incoming SMS message to either HTTP, email or or another phone number.

+

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

Line 263: Line 262:

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:

−

[[File:~~{{{file_forwarding_http}}}~~]]

+

[[File:Networking_device_manual_sms_gateway_sms_forwarding_http_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 273: Line 272:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</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>

<td>Forward SMS Utilities rules</td>

−

<td>yes | no; ~~Default~~: no</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 SMS Utilities rule)</td>

</tr>

<tr>

<td>Use HTTPS</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

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

</tr>

<tr>

<td>Encode message text to Base64</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

+

<td>Ignore | Verify; default: Ignore</td>

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

</tr>

<tr>

<td>Method</td>

−

<td>Post | Get; ~~Default~~: Get</td>

+

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

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

</tr>

<tr>

−

<td>host | ip | host:port | ip:port; ~~Default~~: none</td>

+

<td>host | ip | host:port | ip:port; default: none</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 colon (:) symbol followed by the port number (for example, 192.168.1.1:81) </td>

</tr>

<tr>

<td>Number value name</td>

−

<td>string; ~~Default~~: none</td>

+

<td>string; default: none</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~~: none</td>

+

<td>string; default: none</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~~: none</td>

+

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

<td>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 '{{{name}}}' on the right. This can also be utilized when using the Get method to request data from an HTTP server</td>

</tr>

<tr>

−

<td>All messages | From listed numbers; ~~Default~~: All messages</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>

</tr>

<tr>

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

−

<td>phone number; ~~Default~~: none</td>

+

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

</tr>

Line 337: Line 336:

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:

−

[[File:{{{~~file_forwarding_http_example~~}}}]]

+

[[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 Hello!, from the number +~~37012345678~~, the specified server should reiceve an encoded query string that looks like this:

+

If you configure the router as seen in the image above and send an SMS message to the router containing the text Hello!, from the number +37000000000, the specified server should reiceve an encoded query string that looks like this:

−

Sender=%~~2B37012345678~~&Text=Hello%21&Name={{{name}}}&Code={{{code_encoded}}}

+

Sender=%2B37000000000&Text=Hello%21&Name={{{name}}}&Code={{{code_encoded}}}

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

+

Sender: +37000000000

Text: Hello!

Name: {{{name}}}

Line 354: Line 353:

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:

−

[[File:~~{{{file_forwarding_sms}}}~~]]

+

[[File:Networking_device_manual_sms_gateway_sms_forwarding_sms_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 364: Line 363:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</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>

<td>Forward SMS Utilities rules</td>

−

<td>yes | no; ~~Default~~: no</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 SMS Utilities rule)</td>

</tr>

<tr>

<td>Add sender's number</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

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

</tr>

<tr>

−

<td>All messages | From listed numbers; ~~Default~~: All messages</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>

</tr>

<tr>

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

−

<td>phone number; ~~Default~~: none</td>

+

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

</tr>

<tr>

<td>Recipient's phone number(s)</td>

−

<td>phone number; ~~Default~~: ~~" "~~</td>

+

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

</tr>

Line 400: Line 399:

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:

−

[[File:~~{{{file_forwarding_email}}}~~]]

+

[[File:Networking_device_manual_sms_gateway_sms_forwarding_email_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 410: Line 409:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns SMS Forwarding To Email ON or ~~OFF~~</td>

+

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

</tr>

<tr>

<td>Forward SMS Utilities rules</td>

−

<td>yes | no; ~~Default~~: no</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>

</tr>

<tr>

<td>Add sender's number</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

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

</tr>

<tr>

<td>Subject</td>

−

<td>string; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

<td>SMTP server</td>

−

<td>host | ip; ~~Default~~: none</td>

+

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

<td>Your email service provider's SMTP server address. If you don't know this address, you can look it up online</td>

</tr>

<tr>

−

<td>integer [0..65535]; ~~Default~~: none</td>

+

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

</tr>

<tr>

<td>Secure connection</td>

−

<td>yes | no; ~~Default~~: no</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>string; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

<td>Password</td>

−

<td>string; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

<td>Sender's email address</td>

−

<td>email address; ~~Default~~: none</td>

+

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

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

</tr>

<tr>

<td>Recipient's email address</td>

−

<td>email address; ~~Default~~: none</td>

+

<td>email address; default: none</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>

</tr>

<tr>

−

<td>All messages | From listed numbers; ~~Default~~: All messages</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>

</tr>

<tr>

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

−

<td>phone number; ~~Default~~: none</td>

+

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

</tr>

Line 479: Line 478:

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:

−

[[File:~~{{{file_smpp}}}~~]]

+

[[File:Networking_device_manual_sms_gateway_smpp_v1.png]]

<tr>

−

<th>Field ~~name~~</th>

+

<th>Field</th>

<th>Value</th>

<th>Description</th>

Line 489: Line 488:

<tr>

<td>Enable</td>

−

<td>yes | no; ~~Default~~: no</td>

+

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

−

<td>Turns SMPP ON or ~~OFF~~</td>

+

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

</tr>

<tr>

−

<td>yes | no; ~~Default~~: admin</td>

+

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

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

</tr>

<tr>

<td>Password</td>

−

<td>string; ~~Default~~: admin01</td>

+

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

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

</tr>

<tr>

<td>Server port</td>

−

<td>integer [0..65535]; ~~Default~~: 7777</td>

+

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

<td>SMPP server port</td>

</tr>

Dziugas

Bureaucrats, Interface administrators, Administrators

31,703

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rut manual sms gateway (view source)

Revision as of 13:51, 16 September 2020

Navigation menu

Personal tools

NAVIGATION

Tools

Categories