This guide will provide information on how you can manage alerts from a SiteManager using HTTP and TCP
Learn to trigger HTTP or TCP alerts via the SiteManager to send emails or text messages.
To start out with make sure that Alert Mode has been set to Enabled.
To configure a SiteManager to send alerts via HTTP you will first need to configure what ports that you intend to use, possible recipients, and possible username and password. (The configuration of recipients are only if your script does not include this.)
After this has been configured you will need to configure an agent to point at the device you want to send alerts from your SiteManager. Any agent will do.
Sending Alerts with TCP request.
If you have configured your device IP correct then you will be able to send requests to your SiteManagers DEV port on the configured port. The syntax for these TCP request are as follows:
|UserName||The username must be the same as the fields provided above. If no username has been configured then this field can be ignored.|
|PassWord||The password must be the same as the fields provided above. If no password has been configured then this field can be ignored.|
|MobileNumber||The mobile phone number intended for the message. Country code can be included but is not required.|
|AlertText||the message that is being send to the recipient.|
There are different ways you can configure your TCP alert, and below are just a few examples.
- /+4511223344/Message text 1 to be send
- Here we are defining a number with a country code, (+45) and a text message after this.
- /11223344/”Message Text 2 to be send”
- Here we are not defining a country code, So the country code of the SIM card will be used. We also define the beginning and end of the text message.
- /<email@example.com>/Message text 3 to be send.
- Here we are sending a Email instead of a Text Message. The brackets <> are necessary for the SiteManager to send a Email
- /”Message Test 4 to be send.”
- No recipient defined in this message, the "Agent Alerts Recipients" from "GateManager > Alerts" will be used.
- /User1/pass1234/+4511223344/Message text 5 to be send
- Here we define both Username, Password, country cod, number, and message.
In the image below you can see that we are sending a TCP request to 10.0.1.1 with the following text: /test/test/+4511223344/Message This means that we are using the username "test" and password "test", we are sending a message to the number "11223344" with the country code "+45" and the message is "Message".
A standard TCP response is send by the SiteManager to the computer sending the TCP request.
Alternative formatting characters:
Formatting the message can be done with several different characters like: /, &, =, /t(tabulator)
So the TCP request could be formatted like this:
&SMS&+4511223344&Message text 1 to be send
=SMS=+4511223344=Message text 1 to be send
/SMS/+4511223344/Message text 1 to be send
This has the advantage that if you need to use 1 of these characters in the message text then you format the request with one of the others to avoid that character to be processed as a part of the formatting.
Example: You want to include an URL in the message text
/SMS/+4511223344/http://www.dr.dk This TCP request would be considered malformatted due the the extra // in the URL.
Instead if the TCP request was formatted using another character than / it would work:
Here the formatting character is & and therefor the // in the url is considered as plain text
Sending Alerts with HTTP request.
If you have configured your device IP correct then you will be able to send requests to your SiteManagers DEV port on the configured port. The syntax for these HTTP request are as follows:
http://<address of the SiteManager>:<port>/SMS/<number>/<text message>
|<address of the SiteManager>||This is the local IP address of the SiteManager that you want to send alerts.|
|<port>||The port defined in the Setup.|
|SMS||Static indication of alerts being send, use "SMS" even when sending Email alerts.|
|<number>||Recipient address for the alerts.|
|<text message>||the message that is being send to the recipient.|
- Here we are defining the IP address, port number a phone number with a country code and a text message to the recipient.
- NOTE "%2B" is the http equivalent of "+" - e.g. if the country code is +41 you would write %2B41
- Here we are defining an IP address and port number as before. But instead of a phone number we are defining an Email address. Be aware that you still need to define <> But you will need to use the HEX values instead. (%3C and %3E)
Below you can see an example where we are sending a text message using a web browser, if the request got sent correctly to the SiteManager then the SiteManager will return with a blank page as shown below.
For further information please see the following article: https://kb.secomea.com/hc/en-us/articles/115004525029