Changes

Created page with "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{se..."
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} SMS Utilities (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} SMS Utilities (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==

The <b>Mobile Utilities</b> page is used to configure various SMS{{#switch:{{{name}}}| TRB255 | TRB256= | #default=&nbsp;and Call}} related device control options and to read, send and manage SMS messages and SMS storage space.

This manual page provides an overview of the Mobile Utilities page in {{{name}}} devices.

==SMS Utilities==

The <b>SMS Utilities</b> section contains a list of rules that perform certain actions when they are activated by SMS messages.

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_sms_rules.png|border|class=tlt-border]]

The entire list contains more than 20 rules, but it does not include all possible SMS actions. You can also create custom rules or modify existing rules. All possible SMS rule actions, their default SMS texts and descriptions are listed in the table below.

<table class="nd-othertables_2" style="width: 100%;">
<tr>
<th width=20%>Action</th>
<th width=20%>SMS Text</th>
<th width=60%>Description</th>
</tr>{{#ifeq: {{{io}}} | 1 |
<tr>
<td><b>Change I/O state</b></td>
<td><i>ioset</i></td>
<td>Changes the state of a selected output.</td>
</tr>|}}
<tr>
<td><b>Change mobile settings</b></td>
<td><i>cellular</i></td>
<td>Is used to configure the device's mobile data connection. [[#Change_mobile_settings_.28cellular.29_rule|Click here]] for more information on this rule.</td>
<tr>
<td><b>Change profile</b></td>
<td><i>no default text</i></td>
<td>Is used to change profiles on the device. Include the name of the profile that you wish to change to after the rule's SMS text, for example if SMS text is set to <i>changeprof</i>:
<ul>
<li><i>changeprof default</i></li>
<li><i>changeprof custom</i></li>
</ul>
</td>
</tr>
<tr>
<td><b>Execute custom script</b></td>
<td><i>-</i></td>
<td>Executes a custom shell script.</td>
</tr>
</tr>{{#ifeq: {{{dualsim}}} | 1 |{{#ifeq: {{{dualmodem}}} | 0 |
<tr>
<td><b>Force SIM switch</b></td>
<td><i>switch_sim</i></td>
<td>Switches from using one SIM card to another.</td>
</tr>|}}|}}
<tr>
<td><b>Reset moble connection</b></td>
<td><i>reset_conn</i></td>
<td>Resets mobile connection. Useful when you want to reconnect to the best available operator.</td>
</tr>
<tr>
<td><b>Reload config</b></td>
<td><i>config_reload</i></td>
<td>Reloads the config and all affected services.</td>
</tr>
<tr>
<td><b>FW upgrade from server</b></td>
<td><i>fw_upgrade</i></td>
<td>Upgrades the device's firmware (provided a new version is available on the FOTA server).</td>
</tr>
<tr>
<td><b>Get list of profiles</b></td>
<td><i>profdisp</i></td>
<td>Sends a list of configuration profiles existing on the device.</td>
</tr>{{#ifeq: {{{gps}}} | 1 |
<tr>
<td><b>GPS control</b></td>
<td><i>gpson</i></td>
<td>Turns GPS on.</td>
</tr>
<tr>
<td><b>GPS coordinates</b></td>
<td><i>gps</i></td>
<td>Sends the device's current GPS coordinates.</td>
</tr>|}}
<tr>
<td><b>IP unblock</b></td>
<td><i>ipunblock</i></td>
<td>Unblocks Web/SSH access for devices that were blocked for too many unsuccessful connection attempts. Send the SMS text to unblock all blocked devices or include the IP address of a single blocked device after the SMS text. For example:
<ul>
<li><i>ipunblock</i> - clears the block list (unblocks Web/SSH access for all previously blocked devices).</li>
<li><i>ipunblock 192.168.1.2</i> - removes this IP address from the block list (unblocks Web/SSH access for that device).</li>
</ul>
</td>
</tr>{{#ifeq: {{{io}}} | 1 |
<tr>
<td><b>I/O status</b></td>
<td><i>iostatus</i></td>
<td>Sends a status report message on the state of the device's inputs and outputs.</td>
</tr>|}}
<tr>
<td><b>Manage OpenVPN</b></td>
<td><i>vpnon</i></td>
<td>Turns a selected OpenVPN instance on. Include the name of the OpenVPN instance that you wish to turn on after the rule's SMS text:
<ul>
<li><i>vpnon client_name</i></li>
<li><i>vpnon server_name</i></li>
</ul>
</td>
</tr>
<tr>
<td><b>Manage OpenVPN</b></td>
<td><i>vpnoff</i></td>
<td>Turns a selected OpenVPN instance off. Include the name of the OpenVPN instance that you wish to turn off after the rule's SMS text:
<ul>
<li><i>vpnoff client_name</i></li>
<li><i>vpnoff server_name</i></li>
</ul>
</td>
</tr>{{#ifeq:{{{series}}}|TRB5||
<tr>
<td><b>Mobile Data limit status</b></td>
<td><i>no default text</i></td>
<td>Sends a status report message that includes data limit usage information for mobile network interfaces (that have [[{{{name}}}_WAN#Mobile_Data_Limit|Mobile Data Limit]] enabled) </td>
</tr>
<tr>
<td><b>Mobile Data usage reset</b></td>
<td><i>no default text</i></td>
<td>Resets mobile data usage for specified interface.</td>
</tr>}}
<tr>
<td><b>Monitoring status</b></td>
<td><i>monitoring_status</i></td>
<td>Sends a status report message that includes the RMS connection type, state and the device serial number and MAC address.</td>
</tr>
<tr>
<td><b>More</b></td>
<td><i>more</i></td>
<td>Displays next part of a composite response message (more than 160 characters).</td>
</tr>
<tr>
<td><b>OpenVPN status</b></td>
<td><i>vpnstatus</i></td>
<td>Sends a status report message on all OpenVPN connections.</td>
</tr>
<tr>
<td><b>Reboot</b></td>
<td><i>reboot</i></td>
<td>Reboots the device.</td>
</tr>
<tr>
<td><b>Restore to default</b></td>
<td><i>restore</i></td>
<td>Restores factory settings on the device.</td>
</tr>
<tr>
<td><b>RMS action</b></td>
<td><i>rms_on</i></td>
<td>Turns RMS connection on.</td>
</tr>
<tr>
<td><b>RMS action</b></td>
<td><i>rms_off</i></td>
<td>Turns RMS connection off.</td>
</tr>
<tr>
<td><b>RMS connect</b></td>
<td><i>rms_connect</i></td>
<td>Forces the device to connect to RMS. This action is analogous to clicking the 'Connect' button in the Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS page]].</td>
</tr>
<tr>
<td><b>RMS status</b></td>
<td><i>rms_status</i></td>
<td>Sends a status report message on the state of the connection to RMS.</td>
</tr>
<tr>
<td><b>Send status</b></td>
<td><i>status</i></td>
<td>Sends a status report message.</td>
</tr>
<tr>
<td><b>SSH access control</b></td>
<td><i>sshon</i></td>
<td>Turns remote and local (by default) SSH access on. This rule can be modified to only include local SSH access.</td>
</tr>
<tr>
<td><b>SSH access control</b></td>
<td><i>sshoff</i></td>
<td>Turns SSH access off.</td>
</tr>
<tr>
<td><b>Switch mobile data</b></td>
<td><i>mobileon</i></td>
<td>Turns mobile data usage on.</td>
</tr>
<tr>
<td><b>Switch mobile data</b></td>
<td><i>mobileoff</i></td>
<td>Turns mobile data usage off.</td>
</tr>{{#ifeq: {{{wifi}}} | 1 |
<tr>
<td><b>Switch WiFi</b></td>
<td><i>wifion</i></td>
<td>Turns the WiFi radio on.</td>
</tr>
<tr>
<td><b>Switch WiFi</b></td>
<td><i>wifioff</i></td>
<td>Turns the WiFi radio off.</td>
</tr>|}}
<tr>
<td><b>UCI API</b></td>
<td><i>uci</i></td>
<td>Is used to change the configuration settings on the device. [[#UCI_API_rule|Click here]] for more information on the UCI API rule.</td>
</tr>
<tr>
<td><b>Restore to user's defaults</b></td>
<td><i>userdefaults</i></td>
<td>Restores user's default configuration on the device. [[{{{name}}}_Maintenance#Create_default_configuration|Click here]] for more information on User's default configuration.</td>
</tr>{{#switch:{{{name}}}
| TRB141|TRB142|TRB145=
| #default=<tr>
<td><b>Wake on LAN</b></td>
<td><i>wakeup</i></td>
<td>Sends a magic packet that "wakes up" a specified device from standby mode. If you have multiple Wake-on-LAN-capable devices, you will have to create a separate rule with a different SMS text for each one. Configuration for each device must include the MAC address of that device.</td>}}
</tr>
<tr>
<td><b>Web access control</b></td>
<td><i>webon</i></td>
<td>Turns remote and local (by default) HTTP and HTTPS access on. This rule can be modified to only include local HTTP/HTTPS access.</td>
</tr>
<tr>
<td><b>Web access control</b></td>
<td><i>weboff</i></td>
<td>Turns HTTP and HTTPS access off. This rule can also modified to turn of either HTTP or HTTPS separately.</td>
</tr>
<tr>
<td><b>API</b></td>
<td><i>api</i></td>
<td>Is used to change the configuration settings on the device. [[#API_rule|Click here]] for more information on the UCI API rule.</td>
</tr>
</table>

===SMS rule execution syntax===
----
To execute an SMS rule, send an SMS message to your device's SIM card number with the rule's <b><i>SMS Text</i></b> preceded by the selected <b><i>authorization keyword</i></b>, which depends on the selected <i>authorization method</i>:

<ul>
<li><b>No authorization</b> - no special keyword required; simply send a rule's <i>SMS Text</i>. For example, to execute the <i>reboot</i> rule without authorization:<pre>reboot</pre></li>
<li><b>By serial</b> - include the device's serial number before a rule's <i>SMS Text</i>. For example, to execute the <i>iostatus</i> rule with serial authorization:<pre>1111111111 iostatus</pre> <font size="-1"><i>(replace 1111111111 with your device's serial number)</i></font></li>
<li><b>By device admin password</b> - include the device's password before a rule's <i>SMS Text</i>. For example, to execute the <i>vpnon</i> rule with admin password authorization:<pre>admin01 vpnon</pre> <font size="-1"><i>(replace admin01 with your device's admin password)</i></font></li>
<li><b>By password</b> - include the configured custom password before a rule's <i>SMS Text</i>. For example, to execute the <i>sshon</i> rule with password authorization:<pre>Custompw1 sshon</pre> <font size="-1"><i>(replace Custompw1 with your configured custom password)</i></font></li>
</ul>

===Modify SMS Rule===
----
Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button located next to it:

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_edit_button.png|border|class=tlt-border]]

After this you should redirected to configuration page for that rule. Below are examples of what the configuration page for the <i>reboot</i> rule looks like.

<b>General settings</b>
----
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

<ol>
<li>The <b>Enable</b> slider turn the rule on or off. In order to use a rule, this slider must be set to 'on'. By default, all existing SMS rules are turned on.</li>
<li>The <b>Action</b> dropdown selection specifies which action should be performed when the rule is executed.</li>
<li>The <b>SMS text</b> field specifies the text that will trigger the rule upon receiving a message.</li>
<li>The <b>Get status via SMS after reboot</b> slider specifies whether the device should send a status report message after an action is executed. The name of this slider may differ from rule to rule and it is only available for some rules.</li>
<li>The <b>Message forwarding</b> slider specifies whether the device should send a status report message to another number (besides the original sender). Setting this slider to 'on' will prompt you to enter an additional phone number(s) of the status message recipient(s).</li>
{{#ifeq: {{{dualmodem}}} | 1 |<li>The <b>Modem</b> option is used to specify which modem to get<nowiki>/</nowiki>set information to<nowiki>/</nowiki>from.</li>
<li>The <b>Gateway modem</b> option is used to specify which modem to use for sending SMS.</li>|}}
<li>The <b>Text messagetext</b> box is used to modify the text that should be included in an SMS rule's response message.</li>
</ol>

<b>Authorization</b>
----
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_authorization.png|border|class=tlt-border]]

<ol>
<li>The <b>Authorization method</b> dropdown selection specifies the type of authorization an SMS rule requires (device admin password, serial number, password or none). If <b>By password</b> is selected a <b>Password</b> field will appear and a custom password will be required. A custom password must have at least one uppercase letter, one lowercase letter, one number and must be from a minimum of 8 to a maximum of 80 characters in length. </li>
<li>The <b>Allowed number(s)</b> dropdown selection specifies who can execute an SMS rule (based on phone number).</li>
</ol>
----
Most rules are configured in a similar manner. However, the configuration does differ from rule to rule, depending on a rule's purpose (selected 'Action'). If you run into trouble when configuring a rule, hover your mouse cursor over the name of a field to see a hint that explains what that field does.

===Change mobile settings (cellular) rule===
----
The <b>Change mobile settings</b> rule is used to change the configuration settings of the mobile data connection. The usage of this rule is a bit more complex because the SMS text in and of itself does nothing, as you must also specify the parameters and values that you wish to set. For example, you can send a message that will change your APN only or a message that will change multiple parameters at once.

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}_{{{dualmodem}}}.png|border|class=tlt-border]]

Below is the full list of parameters that can be changed with this rule.

<table class="nd-othertables_2" style="width: 100%;">
<tr>
<th width=20%>Parameter</th>
<th width=50%>Description</th>
<th width=30%>SMS text example</th>
</tr>
<tr>
<td><b>apn=</b></td>
<td>Sets APN.</td>
<td><i>cellular apn=internet</i></td>
</tr>
<tr>
<td><b>auto_apn=</b></td>
<td>Turns auto APN on or off. Possible values are 0/1.</td>
<td><i>cellular auto_apn=1</i></td>
</tr>
<tr>
<td><b>dialnumber=</b></td>
<td>Sets Dialing number.</td>
<td><i>cellular dialnumber=*99***1#</i></td>
</tr>
<tr>
<td><b>auth_mode=</b></td>
<td>Sets the authentication method. Possible values are:
<ul>
<li><i>none</i></li>
<li><i>pap</i></li>
<li><i>chap</i></li>
</ul>
</td>
<td><i>cellular auth_method=pap</i></td>
</tr>
<tr>
<td><b>service=</b></td>
<td>Sets the service mode. Possible values are:
<ul>
{{#ifeq:{{{2g}}}|1|<li>2g</li>|}}
{{#ifeq:{{{3g}}}|1|<li>3g</li>|}}
{{#ifeq:{{{4g}}}|1|<li>lte</li>|}}
{{#ifeq:{{{5g}}}|1|<li>nr5g</li>|}}
<li>mixture of any two modes (ex.: 3g_lte)</li>
<li>auto</li>
</ul>
</td>
<td><i>cellular service=auto</i></td>
</tr>
<tr>
<td><b>username=</b></td>
<td>Sets the user name for PAP or CHAP authentication.</td>
<td><i>cellular username=user</i></td>
</tr>
<tr>
<td><b>password=</b></td>
<td>Sets the password for PAP or CHAP authentication.</td>
<td><i>cellular password=pass</i></td>
</tr>
<tr>
<td><b>roaming=</b></td>
<td>Turns mobile data roaming on or off. Possible values are:
<ul>
<li><i>0</i> - for off.</li>
<li><i>1</i> - for on.</li>
</ul>
</td>
<td><i>cellular roaming=0</i></td>
</tr>
</table>

Each example above contains a single parameter but you can also send out multiple parameters in one message. For example:

cellular apn=internet service=3g

This message would set your APN to "internet" and the service mode of the mobile connection to "3G Only". You can also send a message that would include all of the parameters above:

cellular apn=internet auth_mode=pap service=3g username=user password=pass roaming=0

<b>Note:</b> only "apn=" or "auto_apn=" is required in a message. For example, to set custom APN:

cellular apn=internet

or if you want to turn auto APN on:

cellular auto_apn=1

===UCI API rule===
----
The <b>UCI API</b> rule is used to configure any parameters on the device.

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_uci_v2.png|border|class=tlt-border]]
----
The following are syntax examples for the UCI API rule:

<table class="nd-othertables_2" style="width: 100%;">
<tr>
<th width=30%>Structure example</th>
<th width=35%>Description</th>
<th width=30%>SMS text example</th>
</tr>
<tr>
<td>uci <b>get</b> <config>.<section>.<option_name></td>
<td>Returns the value of a single configuration option.</td>
<td><ul><li><i>uci get network.wan.ipaddr</i></li></ul>Returns the router's WAN IP address.</td>
</tr>
<tr>
<td>uci <b>set</b> <config>.<section>.<option_name>="value"</td>
<td>Sets the value of a specified configuration option.</td>
<td><ul><li><i>uci set network.mobile.apn=example</i></li></ul>Changes mobile APN value to "example".</td>
</tr>
<tr>
<td>uci <b>show</b> <config></td>
<td>Returns the contents of a config file</td>
<td><ul><li><i>uci show openvpn</i></li></ul>Returns the contents of the "openvpn" config file.</td>
</tr>
<tr>
<td>uci <b>show</b> <config>.<section></td>
<td>Returns the exact part (section) of a config file.</td>
<td><ul><li><i>uci show network.lan</i></li></ul>Returns the configuration of the "lan" section from the "network" config file.</td>
</tr>
<!--
<tr>
<td>uci <b>delete</b> <config>.<section></td>
<td>Deletes the specified section in a configuration file. To avoid operation issues, please use this command to delete optional configuration sections only (not mandatory ones).</td>
<td><li><i>uci delete network.lan4</i></li>Deletes a network interface called "lan4".</td>
</tr>
<tr>
<td>uci <b>delete</b> <config>.<section>.<option_name></td>
<td>Deletes the specified configuration option. To avoid operation issues, please use this command to delete optional configuration options only (not mandatory ones).</td>
<td><li><i>uci delete dhcp.lan.force</i></li>Deletes the "force" option for DHCP server of the "lan" interface (which in turn disables the "Force DHCP" function of that DHCP server).</td>
</tr>
-->
</table>

The UCI rule requires that you know the names of the configuration files and sections and parameters contained within them. You can find the config file list and some examples of the UCI system usage in our <b>[[UCI command usage]]</b> article.

'''Disclaimer''': do not enclose values in '''escape characters''' like you would when executing UCI commands via CLI. For example: '''uci set network.mobile.apn="example"''' will cause an error in SMS API and your value will be altered, as a result, UCI commands execution will fail. Instead, simply write '''uci set network.mobile.apn=example''' without any escape characters or quotes.

===API rule===
----
API allows creating, reading, updating, or deleting configurations using the allowed API endpoints from a list.

[[File:Networking rutos manual mobile utilities sms utilities modify sms rule api v1.png|border|class=tlt-border]]
----
The following are syntax examples for the API rule:

<table class="nd-othertables_2" style="width: 100%;">
<tr>
<th width=30%>Structure example</th>
<th width=35%>Description</th>
<th width=30%>SMS text example</th>
</tr>
<tr>
<td>api <b>get</b> <method>.<config>.<section></td>
<td>Returns specified config options.</td>
<td><ul><li><i>api get /auto_reboot/periodic/config</i></li></ul>Returns periodic reboot options.</td>
</tr>
<tr>
<td>api <b>post</b><method> <config>.<section>.<option_name>="value"</td>
<td>Sets the value of a specified configuration option.</td>
<td><ul><li><i>api post /auto_reboot/periodic/config {"data": {"action": "1", "period": "week", "days": ["mon"], "time": ["12:00"]}}</i></li></ul>Creates a periodic reboot configuration with options to reboot device every monday on 12:00.</td>
</tr>
<tr>
<td>api <b>put</b> <method> <config>.<section>.<option_name>="value"</td>
<td>Edits a specified config options.</td>
<td><ul><li><i>api put /auto_reboot/periodic/config/{id} {"data": { "enable": "1"}}</i></li></ul>Sets a specified periodic reboot config to enabled.</td>
</tr>
<tr>
<td>api <b>delete</b> <method> <config>.<section>.<config_id></td>
<td>Deletes a specified configuration.</td>
<td><ul><li><i>api delete /auto_reboot/periodic/config/{id}</i></li></ul>Deletes a specified periodic reboot configuration.</td>
</tr>
</table>

===Custom Rules===
----
If none of the default rules suit your purposes, you can also configure custom ones. To do so, scroll down to the very bottom of the SMS Utilities page, where you will find the <b>Add Rule</b> section. Enter a custom SMS text, select an Action and click the 'Add' button:

[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_add_rule.png|border|class=tlt-border]]

==SMS Gateway==

This section provides a summary of the <b>SMS Gateway</b> functions for {{{name}}} devices.

===Post/Get===
----
<b>Post/Get</b> allows you to perform action requests by writing them in the URL after your device’s IP address.

[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_post_get_dualmodem_{{{dualmodem}}}_v3.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Enable SMS management functionality through POST/GET
</td>
</tr>
<tr>
<td>Access</td>
<td>mobile_data | mobile_sim_pin | sms_delete | sms_list | sms_read | sms_send | sms_total; default: <b>mobile_data, sms_delete, sms_list, sms_read, sms_send, sms_total</b></td>
<td>Methods available for Post/Get. All methods are allowed if this list is left empty.</td>
</tr>
{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>
<tr>
<td>Gateway modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>|}}
<tr>
<td>User name</td>
<td>default: '''user1'''</td>
<td>User name used for authorization (5 characters minimum). Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )
</td>
</tr>
<tr>
<td>Password</td>
<td>default: '''user_pass'''</td>
<td>Password used for authorization (5 characters minimum). Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )
</td>
</tr>
</table>

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:

<table class="nd-othertables_2">
<tr>
<th width=300">Action</th>
<th width=852">Post/get URL examples</th>
</tr>
<tr>
<td>View mobile messages list</td>
<td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_list?username=user1&password=user_pass
</td>
</tr>
<tr>
<td>Read mobile message</td>
<td>http://<span>style="color: black;">192.168.1.1</span>/cgi-bin/sms_read?username=user1&password=user_pass&number=1
</td>
</tr>
<tr>
<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>
</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>
<td>View mobile messages total</td>
<td>http://<span style="color: black;">192.168.1.1</span>/cgi-bin/sms_total?username=user1&password=user_pass
</td>
</tr>
<tr>
<td>Delete mobile message</td>
<td>http://<span>style="color: black;">192.168.1.1</span>/cgi-bin/sms_delete?username=user1&password=user_pass&number=1
</td>
</tr>
</table>

<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>SMS related post/get commands. Possible values are:
<ul>
<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_send</i> - send an SMS message to specified recipient</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>
</ul>
</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>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:
<ul>
<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>
</ul>
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>
</ul>
----
To use Post/Get via SSH instead of a browser, you may want to use the <b><i>curl -X</i></b> command. Simply add the same URL command in between quotes and specify the HTTP method.

<b>Examples:</b>

<ul>
<li><b>View SMS list:</b><br><pre>curl -X GET "http://192.168.1.1/cgi-bin/sms_list?username=user1&password=user_pass"</pre></li>
<li><b>Send SMS:</b><br><pre>curl -X GET "http://192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&number=0037000000000&text=testmessage"</pre></li>
</ul>

===Auto Reply===
----
<b>Auto reply</b> allows you to configure automatic replying to SMS messages that the router receives.

[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_auto_reply_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Toggles Auto Reply ON or OFF
</td>
</tr>
<tr>
<td>Reply SMS-Utilities rules</td>
<td>off | on; default: <b>off</b></td>
<td>It will reply to sms rules, from SMS-Utilities</td>
</tr>
<tr>
<td>Don't save received messages</td>
<td>off | on; default: <b>off</b></td>
<td>If enabled, the router will delete received SMS messages</td>
</tr>
{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>
<tr>
<td>Gateway modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>
|}}
<tr>
<td>Mode</td>
<td>default: '''Everyone'''</td>
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options:
<ul>
<li>Everyone</li>
<li>Listed numbers</li>
<li>From user group</li>
</ul>
</td>
</tr>
<tr>
<td>Message text</td>
<td>default: <b>none</b></td>
<td>The message that will be sent in reply
</td>
</tr>
</table>

===SMS Forwarding===
----
This section is a summary of the SMS Forwarding function in {{{name}}} routers.

====SMS Forwarding To HTTP====
----
The SMS Forwarding To HTTP functionality forwards SMS messages to HTTP, using either POST or GET methods.

[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_sms_forwarding_to_http_v2.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable SMS forwarding to HTTP</td>
</tr>
<tr>
<td>Forward SMS-Utilities rules</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable sms-utilities rules forwarding</td>
</tr>
<tr>
<td>Don't save received message</td>
<td>off | on; default: <b>off</b></td>
<td>Select whether you want to save forwarded messages or not</td>
</tr>
<tr>
<td>Include sender's number</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable adding original message sender phone number at the end of message text</td>
</tr>
<tr>
<td>Mode</td>
<td>default: '''Everyone'''</td>
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options:
<ul>
<li>Everyone</li>
<li>Listed numbers</li>
<li>From phone group</li>
</ul>
</td>
</tr>
<tr>
<td>Encode message text to Base64</td>
<td>off | on; default: <b>off</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>default: '''Ignore'''</td>
<td>Select whether to ignore or verify server certificate. Available options: <ul><li>Ignore</li> <li>Verify</li></ul>
</td>
</tr>
<tr>
<td>Method</td>
<td>default: '''Get'''</td>
<td>Choose witch HTTP request method will be used. Available options: <ul><li>Get</li> <li>Post</li></ul>
</td>
</tr>
<tr>
<td>URL</td>
<td>default: <b>none</b></td>
<td>URL to which message is going to be forwarded</td>
</tr>
<tr>
<td>Number value name</td>
<td>default: <b>none</b></td>
<td>Sender phone number code name for query string name/value pair</td>
</tr>
<tr>
<td>Message value name</td>
<td>default: <b>none</b></td>
<td>Message code name for query string name/value pair</td>
</tr>
<tr>
<td>Extra data pair 1</td>
<td>default: <b>none</b></td>
<td>Extra html query name/value pair. Enter name to the left field and value to right</td>
</tr>
<tr>
<td>Extra data pair 2</td>
<td>default: <b>none</b></td>
<td>Extra html query name/value pair. Enter name to the left field and value to right</td>
</tr>
</table>

====SMS Forwarding To SMS====
----
The '''SMS Forwarding To SMS''' function forwards SMS messages to one or several recipients.

[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_sms_forwarding_to_sms_dualmodem_{{{dualmodem}}}_v1.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Enables/disables SMS forwarding to SMS
</td>
</tr>
<tr>
<td>Forward SMS-Utilities rules</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable sms-utilities rules forwarding</td>
</tr>
<tr>
<td>Don't save received message</td>
<td>off | on; default: <b>off</b></td>
<td>Select whether you want to save forwarded messages or not</td>
</tr>
<tr>
<td>Add sender's number</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable adding original message sender phone number at the end of message text. Only added if total
message length is up to 480 characters</td>
</tr>{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>
<tr>
<td>Gateway modem</td>
<td>Modem (primary) {{!}} Modem (secondary); default: '''Modem (primary)'''</td>
<td>Which modem is used</td>
</tr>|}}
<tr>
<td>Mode</td>
<td>default: '''Everyone'''</td>
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options:
<ul>
<li>Everyone</li>
<li>Listed numbers</li>
<li>From user group</li>
</ul>
</td>
</tr>
<tr>
<td>Recipients phone numbers</td>
<td>default: <b>none</b></td>
<td>Number(s) to which received messages will be forwarded to</td>
</tr>
</table>

====SMS Forwarding To Email====
----
The '''SMS Forwarding To Email''' function forwards SMS messages to email.

[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_sms_forwarding_to_email_v2.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Enables/disables SMS forwarding to Email
</td>
</tr>
<tr>
<td>Forward SMS-Utilities rules</td>
<td>off | on; default: <b>off</b></td>
<td>Enables/disables sms-utilities rules forwarding</td>
</tr>
<tr>
<td>Don't save received message</td>
<td>off | on; default: <b>off</b></td>
<td>Select whether you want to save forwarded messages or not</td>
</tr>
<tr>
<td>Include sender's number</td>
<td>off | on; default: <b>off</b></td>
<td>Enable/disable adding sender phone number at the end of email text body</td>
</tr>
<tr>
<td>Mode</td>
<td>default: '''Everyone'''</td>
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options:
<ul>
<li>Everyone</li>
<li>Listed numbers</li>
<li>From user group</li>
</ul>
</td>
</tr>
<tr>
<td>Subject</td>
<td>default: <b>none</b></td>
<td>Subject of an email. Allowed characters (a-zA-Z0-9!@#$%&*+-/=?^_`{|}~. )</td>
</tr>
<tr>
<td>Sender's email account</td>
<td>default: <b>none</b></td>
<td>Sender's email configuration</td>
</tr>
<tr>
<td>Recipient's email address</td>
<td>default: <b>none</b></td>
<td>For whom you want to send an email to. Allowed characters (a-zA-Z0-9._%+-)</td>
</tr>
</table>

===Email To SMS Forwarding===
----
<b>Email to SMS Forwarding</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_rutos_manual_mobile_utilities_sms_gateway_email_to_sms_forwarding_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Email to SMS Forwarding ON or OFF</td>
</tr>
<tr>
<td>POP3 server</td>
<td>host | ip; default: <b>none</b></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: <b>none</b></td>
<td>Email service provider's POP3 server port (can be looked up online)</td>
</tr>
<tr>
<td>User name</td>
<td>string; default: <b>none</b></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: <b>none</b></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 (TLS)</td>
<td>off | on; default: <b>off</b></td>
<td>Enables/diables secure connection (TLS 1.2 and up). <b>TLS</b> (Transport Layer Security) is a cryptographic protocol designed to provide communications security over a computer network. TLS uses a combination of symmetric cryptography (sigle secret key known to both sender and receiver to encrypt data) and asymmetric cryptography (a public key known to everyone and a private or secret key known only to the recipient of the message) to encrypt data.</td>
</tr>
<tr>
<td>Verify TLS certificate validity</td>
<td>off | on; default: <b>off</b></td>
<td>Enables/disables TLS certificate validation. When enabled verifies the validity of the POP3 server certificate</td>
</tr>
<tr>
<td>SMS PDU limit</td>
<td>integer; default: <b>5</b></td>
<td>Longer email text will be sent in multiple PDUs (Protocol Data Units), each of them is approximately 130 characters. Specify maximum allowed PDU count</td>
</tr>
<tr>
<td>Check email every</td>
<td>time; default: <b>1 minute</b></td>
<td>Email inbox check interval</td>
</tr>
<tr>
<td>Interval</td>
<td>Minutes | Hours| Days; default: <b>Minutes</b></td>
<td>Email inbox check interval</td>
</tr>{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Gateway modem</td>
<td>Select which modem you want to use</td>
<td>Which modem is configured</td>
</tr>|}}
</table>

<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

Correct phone number format is:
<ul>
<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>
</ul>

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)

<b>Recommendations note</b>:
<ul>
<li>Email to SMS application can't guarantee best results when working with flooded email inbox. It is recommended to have less than 100 emails in the inbox.</li>
<li>Less emails - better performance.</li>
<li>In most cases it is best to use dedicated inbox. </li>
</ul>

===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). It supports both IPv4 and IPv6 addresses. 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_rutos_manual_mobile_utilities_sms_gateway_smpp_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns SMPP on or off.</td>
</tr>
<tr>
<td>User name</td>
<td>string; default: <b>admin</b></td>
<td>User name used for authentication on the SMPP server.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>admin01</b></td>
<td>Password used for authentication on the SMPP server.</td>
</tr>
<tr>
<td>Server port</td>
<td>integer [0..65535]; default: <b>2775</b></td>
<td>SMPP server port.</td>
</tr>{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Modem</td>
<td>Primary modem <nowiki>|</nowiki> Secondary modem; default: <b>Primary modem</b></td>
<td>Modem that will be used for SMPP server communications.</td>
</tr>|}}
</table>
{{#switch:{{{name}}}| TRB255 | TRB256 = | #default =
==Call Utilities==

Just like SMS Utilities, Call Utilities provide you with the possibility to issue certain commands to the router from your mobile phone. The list of possible rules is of course shorter because you can only make one type of call. Keep that in mind when creating Call Utilities rules because one call will trigger all of the enabled rules at once.

{{#switch: {{{series}}}
| RUT9|RUT2=<b>Note:</b> Devices with <i>EC25-AFxD</i> (where <i>x</i> is any character) modem do not support voice calls. <b>Call Utilities</b> section is not present on devices with these modems. You can find the module present on your device in [[{{{name}}} System]] page.
| #default=
}}

===Call Rules===
----
To create a new rule, select an 'Action' and click the 'Add' button. After this, a new configuration window should appear.

[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_general_{{{dualmodem}}}_v4.png|border|class=tlt-border]]

[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_authorization_v1.png|border|class=tlt-border]]


===Incoming Calls===
----
This option specifies the action to be performed on incoming calls. Call utilities rules will keep getting executed while the call is active.

[[File:Networking_rutos_manual_mobile_utilities_call_utilities_incoming_calls.png|border|class=tlt-border]]
}}

==Messages==

With the help of the <b>Messages</b> window you can read and send SMS messages.

===Read Messages===
----
In the <b>Read Messages</b> section you can read and delete received/stored SMS messages. The layout is simple, there is a list of received SMS messages and you can choose how many entries of that list should be visible at one time with SMS per page drop box in the top left corner of the page and there is a Search field to help you navigate more efficiently through the list of messages in the top right corner of the page.

[[File:Networking_rutos_manual_mobile_utilities_messages_read_messages_dualmodem_{{{dualmodem}}}_v3.png|border|class=tlt-border]]

===Send Messages===
----
The <b>Send Messages</b> section lets you send SMS messages from the router‘s SIM card.

[[File:Networking_rutos_manual_mobile_utilities_messages_send_messages_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]

All you have to do is enter the recipient’s phone number, type in your message and hit the <b>Send</b> button.

===Storage===
----
In the Storage tab you can find settings associated with message storage.

[[File:Networking_rutos_manual_mobile_utilities_messages_storage_dualmodem_{{{dualmodem}}}_v2.png|border|class=tlt-border]]

<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Save messages to</td>
<td>SIM card | Modem storage; default: <b>SIM card</b></td>
<td>Specify location where to save messages</td>
</tr>
<tr>
<td>Memory</td>
<td>-</td>
<td>Information about used/available SIM card memory</td>
</tr>
<tr>
<td>Leave free space</td>
<td>integer; default: <b>5</b></td>
<td>How much memory (number of messages) should be left free</td>
</tr>
</table>

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

Navigation menu