Changes

Template:Networking rutos manual mobile utilities (view source)

Revision as of 11:42, 8 March 2024

365 bytes removed , 8 March

m

→‎Post/Get

Line 1: Line 1: −

{{Template: ~~Networking_rutos_manual_fw_disclosure~~

+

{{Template: Networking_device_manual_fw_disclosure

−

| fw_version ={{Template: ~~Networking_rutos_manual_latest_fw~~

+

| series = {{{series}}}

+

| name = {{{name}}}

+

| fw_version ={{Template: Networking_device_manual_latest_fw

| series = {{{series}}}

| name = {{{name}}}

}}

−

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} SMS Utilities (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT9XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT9 | Note: [[{{{name}}} SMS Utilities (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.|}}

−

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} SMS Utilities (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: ~~Networking_rutos_manual_latest_fw~~ | series = RUT2XX}} and earlier) user manual page.|}}

+

{{#ifeq: {{{series}}} | RUT2 | Note: [[{{{name}}} SMS Utilities (legacy WebUI)|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.|}}

==Summary==

−

The Mobile Utilities page is used to configure various SMS{{#~~ifeq~~:{{{name}}}| TRB255| | and Call}} related device control options and to read, send and manage SMS messages and SMS storage space.

+

The Mobile Utilities page is used to configure various SMS{{#switch:{{{name}}}| TRB255 | TRB256= | #default= 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.

Line 17: Line 19:

The SMS Utilities 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 v2.png|border|class=tlt-border]]

+

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

Line 96: Line 98:

</ul>

</td>

−

</tr>

+

</tr>{{#ifeq: {{{io}}} | 1 |

+

<tr>

+

<td>I/O status</td>

+

<td>iostatus</td>

+

<td>Sends a status report message on the state of the device's inputs and outputs.</td>

+

</tr>|}}

<tr>

<td>Manage OpenVPN</td>

Line 120: Line 127:

<td>Mobile Data limit status</td>

<td>no default text</td>

−

<td>Sends a status report message that includes data limit usage information for mobile network interfaces (that have [[{{{name}}}~~_Interfaces~~#Mobile_Data_Limit|Mobile Data Limit]] enabled) </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>

Line 175: Line 182:

<td>Send status</td>

<td>status</td>

−

<td>Sends a status message ~~from router with your chosen information~~.</td>

+

<td>Sends a status report message.</td>

</tr>

<tr>

Line 195: Line 202:

<td>Switch mobile data</td>

<td>mobileoff</td>

−

<td>Turns mobile data usage off~~. After triggering rule, message "Mobile data is turned off using SMS utilities" should be seen in Overview and WAN pages~~.</td>

+

<td>Turns mobile data usage off.</td>

</tr>{{#ifeq: {{{wifi}}} | 1 |

<tr>

Line 215: Line 222:

<td>Restore to user's defaults</td>

<td>userdefaults</td>

−

<td>Restores user's default configuration on the device. [[{{{name}}}~~_Backup~~#Create_default_configuration|Click here]] for more information on User's default configuration.</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=

Line 394: Line 401:

<td>Returns the value of a single configuration option.</td>

−

<td><li>uci get network.wan.ipaddr</li>Returns the router's WAN IP address.</td>

+

<td><ul><li>uci get network.wan.ipaddr</li></ul>Returns the router's WAN IP address.</td>

</tr>

<tr>

<td>uci set <config>.<section>.<option_name>="value"</td>

<td>Sets the value of a specified configuration option.</td>

−

<td><li>uci set network.mobile.apn=example</li>Changes mobile APN value to "example".</td>

+

<td><ul><li>uci set network.mobile.apn=example</li></ul>Changes mobile APN value to "example".</td>

</tr>

<tr>

<td>Returns the contents of a config file</td>

−

<td><li>uci show openvpn</li>Returns the contents of the "openvpn" config file.</td>

+

<td><ul><li>uci show openvpn</li></ul>Returns the contents of the "openvpn" config file.</td>

</tr>

<tr>

<td>Returns the exact part (section) of a config file.</td>

−

<td><li>uci show network.lan</li>Returns the configuration of the "lan" section from the "network" config file.</td>

+

<td><ul><li>uci show network.lan</li></ul>Returns the configuration of the "lan" section from the "network" config file.</td>

</tr>

<!--

Line 431: Line 438:

===API rule===

----

−

~~The ~~API~~ rule is used to configure any parameters on~~ the ~~device~~.

+

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

Line 444: Line 451:

</tr>

<tr>

−

+

−

<td>Returns ~~the value of a single configuration option~~.</td>

+

<td>Returns specified config options.</td>

−

<td><li>~~uci~~ get ~~network.wan.ipaddr~~</li>Returns ~~the router's WAN IP address~~.</td>

+

<td><ul><li>api get /auto_reboot/periodic/config</li></ul>Returns periodic reboot options.</td>

</tr>

<tr>

−

<td>~~uci~~ ~~set~~ <config>.<section>.<option_name>="value"</td>

+

<td>api post<method> <config>.<section>.<option_name>="value"</td>

<td>Sets the value of a specified configuration option.</td>

−

<td><li>~~uci set network.mobile.apn=example~~</li>~~Changes mobile APN value~~ to ~~"example"~~.</td>

+

<td><ul><li>api post /auto_reboot/periodic/config {"data": {"action": "1", "period": "week", "days": ["mon"], "time": ["12:00"]}}</li></ul>Creates a periodic reboot configuration with options to reboot device every monday on 12:00.</td>

</tr>

<tr>

−

+

<td>api put <method> <config>.<section>.<option_name>="value"</td>

−

<td>~~Returns the contents of~~ a config ~~file~~</td>

+

<td>Edits a specified config options.</td>

−

<td><li>~~uci show openvpn~~</li>~~Returns the contents of the "openvpn"~~ config ~~file~~.</td>

+

<td><ul><li>api put /auto_reboot/periodic/config/{id} {"data": { "enable": "1"}}</li></ul>Sets a specified periodic reboot config to enabled.</td>

</tr>

<tr>

−

+

<td>api delete <method> <config>.<section>.<config_id></td>

−

<td>~~Returns the exact part (section) of~~ a ~~config file~~.</td>

+

<td>Deletes a specified configuration.</td>

−

<td><li>~~uci show network.lan~~</~~li>Returns the configuration of the "lan" section from the "network" config file.<~~/~~td>~~

+

<td><ul><li>api delete /auto_reboot/periodic/config/{id}</li></ul>Deletes a specified periodic reboot configuration.</td>

−

</~~tr>~~

−

~~<!--~~

−

~~<tr>~~

−

~~<td>uci delete <~~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~~</li>Deletes a ~~network interface called "lan4"~~.</td>

</tr>

−

~~<tr>~~

−

~~<td>uci delete <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>uci delete dhcp.lan.force</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 [[UCI command usage]] article.

===Custom Rules===

Line 493: Line 486:

Post/Get 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}}}~~_v2~~.png|border|class=tlt-border]]

+

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

Line 509: Line 502:

<tr>

<td>Access</td>

−

+

<td>Methods available for Post/Get. All methods are allowed if this list is left empty.</td>

</tr>

Line 553: Line 546:

<tr>

<td>Read mobile message</td>

−

<td>http://<span

+

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

−

style="color: black;">192.168.1.1/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

+

<td>http://style="color: black;">192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage

−

style="color: black;">192.168.1.1/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

+

<td>http://style="color: black;">192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&group=group_name&text=testmessage

−

style="color: black;">192.168.1.1/cgi-bin/sms_send?username=user1&password=user_pass&group=group_name&text=testmessage

</td>

</tr>

Line 576: Line 566:

<tr>

<td>Delete mobile message</td>

−

<td>http://<span

+

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

−

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

</td>

</tr>

Line 668: Line 657:

<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>Everyone</li>

−

<li>Listed numbers</li>

+

<li>Listed numbers</li>

−

<li>From user group</li>

+

<li>From user group</li>

+

</ul>

</td>

</tr>

Line 690: Line 680:

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_v1~~.png|border|class=tlt-border]]

+

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

Line 717: Line 707:

<td>off | on; default: off</td>

<td>Enable/disable adding original message sender phone number at the end of message text</td>

+

</tr>

+

<tr>

+

+

<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: off</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: <li>Ignore</li> <li>Verify</li>

+

<td>Select whether to ignore or verify server certificate. Available options: <ul><li>Ignore</li> <li>Verify</li></ul>

</td>

</tr>

Line 727: Line 733:

<td>Method</td>

<td>default: '''Get'''</td>

−

<td>Choose witch HTTP request method will be used. Available options: <li>Get</li> <li>Post</li>

+

<td>Choose witch HTTP request method will be used. Available options: <ul><li>Get</li> <li>Post</li></ul>

</td>

</tr>

Line 754: Line 760:

<td>default: none</td>

<td>Extra html query name/value pair. Enter name to the left field and value to right</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:~~

−

~~<li>Everyone</li>~~

−

~~<li>Listed numbers</li>~~

−

~~<li>From user group</li>~~

−

~~</td>~~

</tr>

</table>

Line 815: Line 811:

<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>Everyone</li>

−

<li>Listed numbers</li>

+

<li>Listed numbers</li>

−

<li>From user group</li>

+

<li>From user group</li>

+

</ul>

</td>

</tr>

Line 832: Line 829:

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

−

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

+

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

Line 857: Line 854:

</tr>

<tr>

−

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

+

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

<td>off | on; default: off</td>

<td>Enable/disable adding sender phone number at the end of email text body</td>

+

</tr>

+

<tr>

+

+

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

Line 867: Line 875:

</tr>

<tr>

−

<td>~~Email group~~</td>

+

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

<td>default: none</td>

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

Line 875: Line 883:

<td>default: none</td>

<td>For whom you want to send an email to. Allowed characters (a-zA-Z0-9._%+-)</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:~~

−

~~<li>Everyone</li>~~

−

~~<li>Listed numbers</li>~~

−

~~<li>From user group</li>~~

−

~~</td>~~

</tr>

</table>

Line 894: Line 892:

Important note: 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}}}~~_v1~~.png|border|class=tlt-border]]

+

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

Line 938: Line 936:

</tr>

<tr>

−

<td>SMS limit</td>

+

<td>SMS PDU limit</td>

<td>integer; default: 5</td>

−

<td>~~Limit of SMS count that can~~ be ~~contained~~ in ~~the email body~~ of ~~text, SMS length~~ is ~~limited to 160 seven-bit~~ characters. ~~Emails that contain more symbols than it is specified in this field will not be sent as SMS messages~~</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>

Line 979: Line 977:

===SMPP===

----

−

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:

+

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

Line 1,015: Line 1,013:

</tr>|}}

</table>

−

{{#~~ifeq~~:{{{name}}}| TRB255| |

+

{{#switch:{{{name}}}| TRB255 | TRB256 = | #default =

==Call Utilities==

Line 1,028: Line 1,026:

----

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

−

~~{{#ifeq:{{{dualmodem}}}| 1 |~~

−

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

−

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

−

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

+

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

Line 1,041: Line 1,038:

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

}}

+

==Messages==

Line 1,049: Line 1,047:

In the Read Messages 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}}}~~_v2~~.png|border|class=tlt-border]]

+

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

===Send Messages===

Karolis.t

Administrators

226

edits

Namespaces

Variants

Views

More

Search

Changes

Template:Networking rutos manual mobile utilities (view source)

Revision as of 11:42, 8 March 2024

Navigation menu

Personal tools

NAVIGATION

Tools

Categories