Differences

This shows you the differences between two versions of the page.

--- packet:bpq [2024/04/04 12:24] – Added tx/rx parameter information mm0uhr
+++ packet:bpq [2024/04/30 15:24] (current) – g7taj
@@ Line 141: / Line 141: @@
 BPQ has a simple and evolving HTTP REST API.
+It is used though the HTTPPORT (in this example is port 9122)
 endpoints: (note older versions were prefixed with 'get' (except request_token)
+<code>
 /api/request_token
 /api/ports
@@ Line 149: / Line 151: @@
 /api/users
 /api/info
+/api/links
 /api/mheardport/<port#>
+</code>
 Requested like so:
@@ Line 163: / Line 167: @@
 <code>{"callSign": "G7TAJ-15", "port": "1", "packets": 10, "lastHeard": "2024-3-6 17:14:01"  },
 {"callSign": "G7TAJ", "port": "1", "packets": 5, "lastHeard": "2024-3-3 15:46:07"  }</code>
+===== Events =====
+BPQ can fire an executable on certain events.
+  * new message
+  * message read
+  * user joining chat
+In bpq32.cfg
+<code>EnableEvents=1</code>
+For mail events:
+On the web interface, MailMgmt/Configuration enable:
+<code>Enable Event Reporting</code>
+This will call the following in the bpq directory (For Windows add .exe to the filename)
+<code>MailNewMsg</code>
+It will run the following on a message being read:
+<code>MailMsgRead</code>
+The format of the output is as a string of arguments to the program:
+<code>51260 P N 0 G7TAJ G7TAJ 240408 test</code>
+Chat events:
+This needs to be configured on the chat Web interface page.
+<code>ChatNewUser</code>
+Arguments:
+''
+-G7TAJ : Steve %%*%%%%*%%%%*%% Joined Chat, Topic General
+''