node-red-contrib-tcrouter/receive-sms-check.html at master · PhoenixContactUSA/node-red-contrib-tcrouter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<script type="text/javascript">
    RED.nodes.registerType('receive-sms-check',{
        category: 'TC Router',
        color: '#a6bbcf',
        defaults: {
            router: {required: true, type: "tc-router"},
            name: {value:"receive-sms-check"}
        },
        inputs:1,
        outputs:1,
        icon: "font-awesome/fa-comment-o",
        label: function() {
            return this.name||"receive-sms-check";
        }
    });
</script>

<script type="text/x-red" data-template-name="receive-sms-check">
    <div class="form-row">
        <label for="node-input-router"><i class="icon-globe"></i> TC Router</label>
        <input type="text" id="node-input-router"></input>
    </div>
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
</script>

<script type="text/x-red" data-help-name="receive-sms-check">
    <p>Checks the TC Router for a received SMS message</p>
    <h3>Input</h3>
    <p>This node requires any input change to trigger a new check</p>
    <h3>Output</h3>
    <dl class="message-properties">
            <dt>success
                <span class="property-type">bool</span>
            </dt>
            <dd>Was there a new message received?</dd>
            <dt class="optional">timestamp
                <span class="property-type">string</span>
            </dt>
            <dd>Timestamp of when the message was received by the TC Router.  Only available if success is true</dd>
            <dt class="optional">SMS
                <span class="property-type">object</span>
            <dd>JSON object detailing the received SMS message. Available if success is true</dd>
            <dt class="optional">message
                <span class="property-type">string</span>
            </dt>
            <dd>Failure message returned by the router. Available if success was false</dd>
        </dl>
    <h3>Details</h3>
    <p>This function asks the TC Router if a new sms message has been received by the router.  If a message has been received, the message should be acted upon or stored and then must be cleared from the TC Routers memory so that new messages can be received. In order to clear the memory, the 'receive-sms-ack' node must be used.
    </p>
    <h3>References</h3>
    <ul>
        <li><a href="https://zmink.gitbook.io/node-tcrouter/">Setup Guide</a> - setup guide</li>
        <li><a href="https://github.com/PhoenixContactUSA/node-red-contrib-tcrouter">GitHub</a>Github repo</li>
    </ul>
</script>