]> nmode's Git Repositories - signal-cli/blobdiff - man/signal-cli-jsonrpc.5.adoc
Implement sendPayment notification command
[signal-cli] / man / signal-cli-jsonrpc.5.adoc
index 24672484960d8127e554fef267494b517ac10b8e..f0b62ca95b96a26ff55076e0e7155d80df5a7d2a 100644 (file)
@@ -8,7 +8,7 @@ vim:set ts=4 sw=4 tw=82 noet:
 
 == Name
 
-JSON-RPC API for signal-cli - A commandline and dbus interface for the Signal messenger
+signal-cli-jsonrpc - A commandline and dbus interface for the Signal messenger
 
 == Synopsis
 
@@ -76,6 +76,22 @@ The `method` field is the command name and the parameters can be sent as the `pa
 
   `--attachment ATTACH` becomes `"attachment":"ATTACH"`
 
+=== Additional JSON-RPC commands
+
+For receiving message additional commands are provided in JSON-RPC mode with `--receive-mode=manual`.
+
+==== subscribeReceive
+
+Tells the daemon to start receiving messages, returns the subscription id as a single integer value in the result.
+
+==== unsubscribeReceive
+
+Stop a previous subscription for receiving messages.
+
+Params:
+
+- `subscription`: the subscription id returned by `subscribeReceive`
+
 == Examples
 
 REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"5"}` RESPONSE: `{"jsonrpc":"2.0","result":[...],"id":"5"}`