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

   1 /////
   2 vim:set ts=4 sw=4 tw=82 noet:
   3 /////
   4 :quotes.~:
   5
   6 = signal-cli-dbus (5)
   7
   8 == Name
   9
  10 DBus API for signal-cli - A commandline and dbus interface for the Signal messenger
  11
  12 == Synopsis
  13
  14 *signal-cli* [--verbose] [--config CONFIG] [-u USERNAME] [-o {plain-text,json}] daemon [--system]
  15
  16 *dbus-send* [--system | --session] [--print-reply] --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal[/_<phonenum>] org.asamk.Signal.<method> [string:<string argument>] [array:<type>:<array argument>]
  17
  18 Note: when daemon was started without explicit `-u USERNAME`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenum>`.
  19
  20 == Description
  21
  22 See signal-cli (1) for details on the application.
  23
  24 This documentation handles the supported methods when running signal-cli as a DBus daemon.
  25
  26 The method are described as follows:
  27
  28 method(arg1<type>, arg2<type>, ...) -> return<type>
  29
  30 Where <type> is according to DBus specification:
  31
  32 * <s>   : String
  33 * <ay>  : Byte Array
  34 * <aay> : Array of Byte Arrays
  35 * <as>  : String Array
  36 * <ax>  : Array of signed 64 bit integer
  37 * <b>   : Boolean (0|1)
  38 * <x>   : Signed 64 bit integer
  39 * <>    : no return value
  40
  41 Exceptions are the names of the Java Exceptions returned in the body field. They typically contain an additional message with details. All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
  42
  43 Phone numbers always have the format +<countrycode><regional number>
  44
  45 == Methods
  46
  47 === Control methods
  48 These methods are available if the daemon is started anonymously (without an explicit `-u USERNAME`).
  49 Requests are sent to `/org/asamk/Signal`; requests related to individual accounts are sent to
  50 `/org/asamk/Signal/_441234567890` where the + dialing code is replaced by an underscore (_).
  51 Only `version()` is activated in single-user mode; the rest are disabled.
  52
  53 link() -> deviceLinkUri<s>::
  54 link(newDeviceName<s>) -> deviceLinkUri<s>::
  55 * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
  56 * deviceLinkUri : URI of newly linked device
  57
  58 Returns a URI of the form "tsdevice:/?uuid=...". This can be piped to a QR encoder to create a display that
  59 can be captured by a Signal smartphone client. For example:
  60
  61 `dbus-send --session --dest=org.asamk.Signal --type=method_call --print-reply /org/asamk/Signal org.asamk.Signal.link string:"My secondary client"|tr '\n' '\0'|sed 's/.*string //g'|sed 's/\"//g'|qrencode -s10 -tANSI256`
  62
  63 Exception: Failure
  64
  65 listAccounts() -> accountList<as>::
  66 * accountList : Array of all attached accounts in DBus object path form
  67
  68 Exceptions: None
  69
  70 register(number<s>, voiceVerification<b>) -> <>::
  71 * number            : Phone number
  72 * voiceVerification : true = use voice verification; false = use SMS verification
  73
  74 Exceptions: Failure, InvalidNumber, RequiresCaptcha
  75
  76 registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
  77 * number            : Phone number
  78 * voiceVerification : true = use voice verification; false = use SMS verification
  79 * captcha           : Captcha string
  80
  81 Exceptions: Failure, InvalidNumber, RequiresCaptcha
  82
  83 verify(number<s>, verificationCode<s>) -> <>::
  84 * number            : Phone number
  85 * verificationCode  : Code received from Signal after successful registration request
  86
  87 Command fails if PIN was set after previous registration; use verifyWithPin instead.
  88
  89 Exception: Failure, InvalidNumber
  90
  91 verifyWithPin(number<s>, verificationCode<s>, pin<s>) -> <>::
  92 * number            : Phone number
  93 * verificationCode  : Code received from Signal after successful registration request
  94 * pin               : PIN you set with setPin command after verifying previous registration
  95
  96 Exception: Failure, InvalidNumber
  97
  98 version() -> version<s>::
  99 * version : Version string of signal-cli
 100
 101 Exceptions: None
 102
 103 === Other methods
 104
 105 updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
 106 * groupId  : Byte array representing the internal group identifier
 107 * newName  : New name of group (empty if unchanged)
 108 * members  : String array of new members to be invited to group
 109 * avatar   : Filename of avatar picture to be set for group (empty if none)
 110
 111 Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
 112
 113 updateProfile(name<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
 114 updateProfile(givenName<s>, familyName<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
 115 * name        : Name for your own profile (empty if unchanged)
 116 * givenName   : Given name for your own profile (empty if unchanged)
 117 * familyName  : Family name for your own profile (empty if unchanged)
 118 * about       : About message for profile (empty if unchanged)
 119 * aboutEmoji  : Emoji for profile (empty if unchanged)
 120 * avatar      : Filename of avatar picture for profile (empty if unchanged)
 121 * remove      : Set to true if the existing avatar picture should be removed
 122
 123 Exceptions: Failure
 124
 125
 126 setExpirationTimer(number<s>, expiration<i>) -> <>::
 127 * number     : Phone number of recipient
 128 * expiration : int32 for the number of seconds before messages to this recipient disappear. Set to 0 to disable expiration.
 129
 130 Exceptions: Failure
 131
 132 setContactBlocked(number<s>, block<b>) -> <>::
 133 * number  : Phone number affected by method
 134 * block   : 0=remove block , 1=blocked
 135
 136 Messages from blocked numbers will no longer be forwarded via DBus.
 137
 138 Exceptions: InvalidNumber
 139
 140 setGroupBlocked(groupId<ay>, block<b>) -> <>::
 141 * groupId : Byte array representing the internal group identifier
 142 * block   : 0=remove block , 1=blocked
 143
 144 Messages from blocked groups will no longer be forwarded via DBus.
 145
 146 Exceptions: GroupNotFound
 147
 148 joinGroup(inviteURI<s>) -> <>::
 149 * inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
 150
 151 Exceptions: Failure
 152
 153 quitGroup(groupId<ay>) -> <>::
 154 * groupId : Byte array representing the internal group identifier
 155
 156 Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember()
 157
 158 Exceptions: GroupNotFound, Failure
 159
 160 isMember(groupId<ay>) -> active<b>::
 161 * groupId : Byte array representing the internal group identifier
 162
 163 Note that this method does not raise an Exception for a non-existing/unknown group but will simply return 0 (false)
 164
 165 sendEndSessionMessage(recipients<as>) -> <>::
 166 * recipients : Array of phone numbers
 167
 168 Exceptions: Failure, InvalidNumber, UntrustedIdentity
 169
 170 sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
 171 * message     : Text to send (can be UTF8)
 172 * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
 173 * groupId     : Byte array representing the internal group identifier
 174 * timestamp   : Can be used to identify the corresponding signal reply
 175
 176 Exceptions: GroupNotFound, Failure, AttachmentInvalid
 177
 178 sendContacts() -> <>::
 179
 180 Sends a synchronization message with the local contacts list to all linked devices. This command should only be used if this is the primary device.
 181
 182 Exceptions: Failure
 183
 184 sendSyncRequest() -> <>::
 185
 186 Sends a synchronization request to the primary device (for group, contacts, ...). Only works if sent from a secondary device.
 187
 188 Exception: Failure
 189
 190 sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
 191 * message     : Text to send (can be UTF8)
 192 * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
 193 * timestamp   : Can be used to identify the corresponding signal reply
 194
 195 Exceptions: Failure, AttachmentInvalid
 196
 197 sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
 198 sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
 199 * message     : Text to send (can be UTF8)
 200 * attachments : String array of filenames to send as attachments (passed as filename, so need to be readable by the user signal-cli is running under)
 201 * recipient   : Phone number of a single recipient
 202 * recipients  : Array of phone numbers
 203 * timestamp   : Can be used to identify the corresponding signal reply
 204
 205 Depending on the type of the recipient field this sends a message to one or multiple recipients.
 206
 207 Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
 208
 209 sendTyping(recipient<s>, stop<b>) -> <>::
 210 * recipient             : Phone number of a single recipient
 211 * targetSentTimestamp   : True, if typing state should be stopped
 212
 213 Exceptions: Failure, GroupNotFound, UntrustedIdentity
 214
 215
 216 sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
 217 * recipient             : Phone number of a single recipient
 218 * targetSentTimestamp   : Array of Longs to identify the corresponding signal messages
 219
 220 Exceptions: Failure, UntrustedIdentity
 221
 222 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 223 * emoji               : Unicode grapheme cluster of the emoji
 224 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 225 * targetAuthor        : String with the phone number of the author of the message to which to react
 226 * targetSentTimestamp : Long representing timestamp of the message to which to react
 227 * groupId             : Byte array with base64 encoded group identifier
 228 * timestamp           : Long, can be used to identify the corresponding signal reply
 229
 230 Exceptions: Failure, InvalidNumber, GroupNotFound
 231
 232 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 233 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 234 * emoji               : Unicode grapheme cluster of the emoji
 235 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 236 * targetAuthor        : String with the phone number of the author of the message to which to react
 237 * targetSentTimestamp : Long representing timestamp of the message to which to react
 238 * recipient           : String with the phone number of a single recipient
 239 * recipients          : Array of strings with phone numbers, should there be more recipients
 240 * timestamp           : Long, can be used to identify the corresponding signal reply
 241
 242 Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
 243
 244 Exceptions: Failure, InvalidNumber
 245
 246 sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 247 * targetSentTimestamp : Long representing timestamp of the message to delete
 248 * groupId             : Byte array with base64 encoded group identifier
 249 * timestamp           : Long, can be used to identify the corresponding signal reply
 250
 251 Exceptions: Failure, GroupNotFound
 252
 253 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 254 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 255 * targetSentTimestamp : Long representing timestamp of the message to delete
 256 * recipient           : String with the phone number of a single recipient
 257 * recipients          : Array of strings with phone numbers, should there be more recipients
 258 * timestamp           : Long, can be used to identify the corresponding signal reply
 259
 260 Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients.
 261
 262 Exceptions: Failure, InvalidNumber
 263
 264 getContactName(number<s>) -> name<s>::
 265 * number  : Phone number
 266 * name    : Contact's name in local storage (from the master device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
 267
 268 setContactName(number<s>,name<>) -> <>::
 269 * number  : Phone number
 270 * name    : Name to be set in contacts (in local storage with signal-cli)
 271
 272 getGroupIds() -> groupList<aay>::
 273 groupList : Array of Byte arrays representing the internal group identifiers
 274
 275 All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked()
 276
 277 getGroupName(groupId<ay>) -> groupName<s>::
 278 groupName : The display name of the group
 279 groupId   : Byte array representing the internal group identifier
 280
 281 Exceptions: None, if the group name is not found an empty string is returned
 282
 283 getGroupMembers(groupId<ay>) -> members<as>::
 284 members   : String array with the phone numbers of all active members of a group
 285 groupId   : Byte array representing the internal group identifier
 286
 287 Exceptions: None, if the group name is not found an empty array is returned
 288
 289 listNumbers() -> numbers<as>::
 290 numbers : String array of all known numbers
 291
 292 This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
 293
 294 getContactNumber(name<s>) -> numbers<as>::
 295 * numbers : Array of phone number
 296 * name    : Contact or profile name ("firstname lastname")
 297
 298 Searches contacts and known profiles for a given name and returns the list of all known numbers. May result in e.g. two entries if a contact and profile name is set.
 299
 300 isContactBlocked(number<s>) -> state<b>::
 301 * number  : Phone number
 302 * state   : 1=blocked, 0=not blocked
 303
 304 Exceptions: None, for unknown numbers 0 (false) is returned
 305
 306 isGroupBlocked(groupId<ay>) -> state<b>::
 307 * groupId : Byte array representing the internal group identifier
 308 * state   : 1=blocked, 0=not blocked
 309
 310 Exceptions: None, for unknown groups 0 (false) is returned
 311
 312 removePin() -> <>::
 313
 314 Removes registration PIN protection.
 315
 316 Exception: Failure
 317
 318 setPin(pin<s>) -> <>::
 319 * pin               : PIN you set after registration (resets after 7 days of inactivity)
 320
 321 Sets a registration lock PIN, to prevent others from registering your number.
 322
 323 Exception: Failure
 324
 325 version() -> version<s>::
 326 * version : Version string of signal-cli
 327
 328 isRegistered() -> result<b>::
 329 isRegistered(number<s>) -> result<b>::
 330 isRegistered(numbers<as>) -> results<ab>::
 331 * number  : Phone number
 332 * numbers : String array of phone numbers
 333 * result  : true=number is registered, false=number is not registered
 334 * results : Boolean array of results
 335
 336 Exception: InvalidNumber for an incorrectly formatted phone number. For unknown numbers, false is returned, but no exception is raised. If no number is given, returns whether you are registered (presumably true).
 337
 338 addDevice(deviceUri<s>) -> <>::
 339 * deviceUri : URI in the form of tsdevice:/?uuid=... Normally received from Signal desktop or smartphone app
 340
 341 Exception: InvalidUri
 342
 343 listDevices() -> devices<as>::
 344 * devices  : String array of linked devices
 345
 346 Exception: Failure
 347
 348 removeDevice(deviceId<i>) -> <>::
 349 * deviceId : Device ID to remove, obtained from listDevices() command
 350
 351 Exception: Failure
 352
 353 updateDeviceName(deviceName<s>) -> <>::
 354 * deviceName : New name
 355
 356 Set a new name for this device (main or linked).
 357
 358 Exception: Failure
 359
 360 uploadStickerPack(stickerPackPath<s>) -> url<s>::
 361 * stickerPackPath : Path to the manifest.json file or a zip file in the same directory
 362 * url             : URL of sticker pack after successful upload
 363
 364 Exception: Failure
 365
 366 == Signals
 367
 368 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
 369 The sync message is received when the user sends a message from a linked device.
 370
 371 ReceiptReceived (timestamp<x>, sender<s>)::
 372 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
 373 * sender    : Phone number of the sender
 374
 375 This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
 376
 377 MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
 378 * timestamp   : Integer value that is used by the system to send a ReceiptReceived reply
 379 * sender      : Phone number of the sender
 380 * groupId     : Byte array representing the internal group identifier (empty when private message)
 381 * message     : Message text
 382 * attachments : String array of filenames for the attachments. These files are located in the signal-cli storage and the current user needs to have read access there
 383
 384 This signal is received whenever we get a private message or a message is posted in a group we are an active member
 385
 386 == Examples
 387
 388 Send a text message (without attachment) to a contact::
 389 dbus-send --print-reply --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal org.asamk.Signal.sendMessage string:"Message text goes here" array:string: string:+123456789
 390
 391 Send a group message::
 392 dbus-send --session --print-reply --type=method_call --dest=org.asamk.Signal /org/asamk/Signal org.asamk.Signal.sendGroupMessage  string:'The message goes here'  array:string:'/path/to/attachmnt1','/path/to/attachmnt2'  array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185
 393
 394 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`::
 395 dbus-send --system --print-reply --type=method_call --dest='org.asamk.Signal' /org/asamk/Signal/_1234567890 org.asamk.Signal.getGroupName array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185
 396
 397 == Authors
 398
 399 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 400 For more information about signal-cli development, see
 401 <https://github.com/AsamK/signal-cli>.