nmode's Git Repositories - signal-cli/blob - man/signal-cli-jsonrpc.5.adoc

   1 /////
   2 vim:set ts=4 sw=4 tw=82 noet:
   3 /////
   4
   5 :quotes.~:
   6
   7 = signal-cli-jsonrpc (5)
   8 :doctype: manpage
   9
  10 == Name
  11
  12 signal-cli-jsonrpc - A commandline and dbus interface for the Signal messenger
  13
  14 == Synopsis
  15
  16 *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket] [--tcp]
  17
  18 *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] jsonRpc
  19
  20 == Description
  21
  22 See signal-cli (1) for details on the application.
  23
  24 signal-cli provides a JSON-RPC based API with the `jsonRpc` and `daemon` commands.
  25
  26 - `jsonRpc` command accepts input on STDIN and responds on STDOUT.
  27 This is intended to make it easier to embed signal-cli in other applications.
  28
  29   `signal-cli -a _ACCOUNT_ jsonRpc`
  30
  31 - `daemon` command provides a UNIX or TCP socket and can handle requests from multiple clients.
  32
  33   `signal-cli -a _ACCOUNT_ daemon --socket` or for multi-account mode `signal-cli daemon --socket`
  34
  35 == Basic usage
  36
  37 In JSON-RPC mode, signal-cli will read requests from stdin.
  38 Every requests must be a JSON object in a single line.
  39 Requests must have a unique "id" value to be able to match the response to the corresponding request.
  40
  41 Example:
  42
  43 REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"my special mark"}`
  44
  45 RESPONSE: `{"jsonrpc":"2.0","result":[{"id":"Pmpi+EfPWmsxiomLe9Nx2XF9HOE483p6iKiFj65iMwI=","name":"My Group","description":"It's special because it is mine.","isMember":true,"isBlocked":false,"members":["+33123456789","+440123456789"],"pendingMembers":[],"requestingMembers":[],"admins":["+33123456789","+440123456789"],"groupInviteLink":"https://signal.group/#CjQKIAtcbUw482i7bqvmJCwdgvg0FMif52N5v9lGg_bE4U3zEhCjHKSaPzWImMpnCbU8A1r0"}],"id":"my special mark"}`
  46
  47 From the command line:
  48
  49 `echo '{"jsonrpc":"2.0","method":"listGroups","id":"my special mark"}' | signal-cli -u +33123456789 jsonRpc`
  50
  51 Like in dbus daemon mode, messages are automatically received in jsonRpc mode.
  52 Incoming messages are sent as JSON-RPC notifications.
  53
  54 Example:
  55
  56 `{"jsonrpc":"2.0","method":"receive","params":{"envelope":{"source":"+33123456789","sourceNumber":"+33123456789","sourceUuid":"uuid","sourceName":"name","sourceDevice":1,"timestamp":1631458508784,"dataMessage":{"timestamp":1631458508784,"message":"foobar","expiresInSeconds":0,"viewOnce":false,"mentions":[],"attachments":[],"contacts":[]}}}}`
  57
  58 === Multi-account daemon mode
  59 When the daemon command is started without an account parameter (-a), signal-cli will provide all local accounts and additional commands to register and link new accounts.
  60
  61 In multi-account mode, requests for a single account require an additional `account` param.
  62
  63 REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"my special mark","params":{"account":"+33123456789"}}`
  64
  65 == Commands
  66
  67 The commands available for the JSON-RPC mode are the same as the cli commands (except `register`, `verify` and `link`).
  68 The `method` field is the command name and the parameters can be sent as the `params` object.
  69
  70 - Parameter names are provided in camelCase format instead of the hyphen format on the cli.
  71
  72   e.g.: `--group-id=ID` on the cli becomes `"groupId":"ID"`
  73
  74 - Parameters that can take multiple values on the command line can be provided as single json value or as json array
  75
  76   e.g. `--attachment ATTACH1 ATTACH2` becomes `"attachments":["ATTACH1", "ATTACH2"]`
  77
  78   `--attachment ATTACH` becomes `"attachment":"ATTACH"`
  79
  80 === Additional JSON-RPC commands
  81
  82 For receiving message additional commands are provided in JSON-RPC mode with `--receive-mode=manual`.
  83
  84 ==== subscribeReceive
  85
  86 Tells the daemon to start receiving messages, returns the subscription id as a single integer value in the result.
  87
  88 ==== unsubscribeReceive
  89
  90 Stop a previous subscription for receiving messages.
  91
  92 Params:
  93
  94 - `subscription`: the subscription id returned by `subscribeReceive`
  95
  96 == Examples
  97
  98 REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"5"}` RESPONSE: `{"jsonrpc":"2.0","result":[...],"id":"5"}`
  99
 100 REQUEST: `{"jsonrpc":"2.0","method":"send","params":{"recipient":["+YYY"],"message":"MESSAGE"},"id":4}` RESPONSE: `{"jsonrpc":"2.0","result":{"timestamp":999},"id":4}`
 101
 102 REQUEST: `{"jsonrpc":"2.0","method":"updateGroup","params":{"groupId":"GROUP_ID=","name":"new group name","members":["+ZZZ"],"link":"enabledWithApproval","setPermissionEditDetails":"only-admins"},"id":"someId"}` RESPONSE: `{"jsonrpc":"2.0","result":{"timestamp":9999},"id":"someId"}`
 103
 104 REQUEST: `{"jsonrpc":"2.0","method":"sendSyncRequest","id":9}` RESPONSE: `{"jsonrpc":"2.0","result":{},"id":9}`
 105
 106 REQUEST: `{"jsonrpc":"2.0"}` RESPONSE: `{"jsonrpc":"2.0","error":{"code":-32600,"message":"method field must be set","data":null},"id":null}`
 107
 108 == Authors
 109
 110 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 111 For more information about signal-cli development, see
 112 <https://github.com/AsamK/signal-cli>.