webmaster/signal-cli
1
0
Fork 0
mirror of https://github.com/AsamK/signal-cli synced 2025-08-28 18:10:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Extend json-rpc man page

Browse source
This commit is contained in:
AsamK 2023-10-05 22:18:36 +02:00
parent 6f4d538832
commit fae83f8d22
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
man/signal-cli-jsonrpc.5.adoc
View 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.