]> nmode's Git Repositories - signal-cli/commitdiff
Extend json-rpc man page
authorAsamK <asamk@gmx.de>
Thu, 5 Oct 2023 20:18:36 +0000 (22:18 +0200)
committerAsamK <asamk@gmx.de>
Thu, 5 Oct 2023 20:18:36 +0000 (22:18 +0200)
man/signal-cli-jsonrpc.5.adoc

index ad9cb53830bc12187f0a4fbbfded629559be0fbc..7f4aeeb3ad6833ca60457a5c497dd4cc02aa6724 100644 (file)
@@ -13,7 +13,7 @@ signal-cli-jsonrpc - A commandline and dbus interface for the Signal messenger
 
 == Synopsis
 
-*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket] [--tcp] [--http]
+*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket[=SOCKET_PATH]] [--tcp[=HOST:PORT]] [--http[=HOST:PORT]]
 
 *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] jsonRpc
 
@@ -32,6 +32,12 @@ This is intended to make it easier to embed signal-cli in other applications.
 
   `signal-cli -a _ACCOUNT_ daemon --socket` or for multi-account mode `signal-cli daemon --socket`
 
+With `--http` signal-cli exposes three endpoints;
+
+* POST /api/v1/rpc : Expects a single or batch JSON-RPC request
+* GET /api/v1/events : Returns a Server-Sent Events (SSE) stream of incoming messages
+* GET /api/v1/check : Responds with 200 OK if daemon is running
+
 == Basic usage
 
 In JSON-RPC mode, signal-cli will read requests from stdin.