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
   5 :quotes.~:
   6
   7 = signal-cli-dbus (5)
   8
   9 == Name
  10
  11 signal-cli-dbus - A commandline and dbus interface for the Signal messenger
  12
  13 == Synopsis
  14
  15 *signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] [-o {plain-text,json}] daemon [--dbus] [--dbus-system]
  16
  17 *dbus-send* [--system | --session] [--print-reply] --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal[/_<phonenumber>] org.asamk.Signal.<method> [string:<string argument>] [array:<type>:<array argument>]
  18
  19 Note: when daemon was started without explicit `-a ACCOUNT`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenumber>`.
  20
  21 == Description
  22
  23 See signal-cli (1) for details on the application.
  24
  25 This documentation handles the supported methods when running signal-cli as a DBus daemon.
  26
  27 The method are described as follows:
  28
  29 method(arg1<type>, arg2<type>, ...) -> return<type>
  30
  31 Where <type> is according to DBus specification:
  32
  33 * <a> : Array of ... (comma-separated list) (array:)
  34 * (...) : Struct (cannot be sent via `dbus-send`)
  35 * <b> : Boolean (false|true) (boolean:)
  36 * <i> : Signed 32-bit (int) integer (int32:)
  37 * <o> : DBusPath object (objpath:)
  38 * <s> : String (string:)
  39 * <x> : Signed 64-bit (long) integer (int64:)
  40 * <y> : Unsigned 8-bit (byte) integer (byte:)
  41 * <> : no return value
  42
  43 The final parenthetical value (such as "boolean:") is the type indicator used by `dbus-send`.
  44
  45 Exceptions are the names of the Java Exceptions returned in the body field.
  46 They typically contain an additional message with details.
  47 All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
  48
  49 Phone numbers always have the format +<countrycode><regional number>
  50
  51 == Methods
  52
  53 === SignalControl interface
  54
  55 These methods are available if the daemon is started in multi-account mode (without an explicit `-a ACCOUNT`).
  56 The exported `/org/asamk/Signal` object provides a SignalControl interface, with methods to manage accounts.
  57 Individual accounts are exported as separate objects and provide a Signal interface, that's described below.
  58 e.g. `/org/asamk/Signal/\_441234567890` where the + dialing code is replaced by an underscore (_).
  59
  60 link() -> deviceLinkUri<s>::
  61 link(newDeviceName<s>) -> deviceLinkUri<s>::
  62 * newDeviceName : Name to give new device (defaults to "cli" if no name is given)
  63 * deviceLinkUri : URI of newly linked device
  64
  65 Returns a URI of the form "sgnl://linkdevice?uuid=...".
  66 This can be piped to a QR encoder to create a display that can be captured by a Signal smartphone client.
  67
  68 For example:
  69
  70 ```
  71 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
  72 ```
  73
  74 listAccounts() -> accountList<as>::
  75 * accountList : Array of all attached accounts in DBus object path form
  76
  77 Exceptions: None
  78
  79 register(number<s>, voiceVerification<b>) -> <>::
  80 * number : Phone number
  81 * voiceVerification : true = use voice verification; false = use SMS verification
  82
  83 Exceptions: Failure, InvalidNumber, RequiresCaptcha
  84
  85 registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
  86 * number : Phone number
  87 * voiceVerification : true = use voice verification; false = use SMS verification
  88 * captcha : Captcha string
  89
  90 Exceptions: Failure, InvalidNumber, RequiresCaptcha
  91
  92 verify(number<s>, verificationCode<s>) -> <>::
  93 * number : Phone number
  94 * verificationCode : Code received from Signal after successful registration request
  95
  96 Command fails if PIN was set after previous registration; use verifyWithPin instead.
  97
  98 Exceptions: Failure, InvalidNumber
  99
 100 verifyWithPin(number<s>, verificationCode<s>, pin<s>) -> <>::
 101 * number : Phone number
 102 * verificationCode : Code received from Signal after successful registration request
 103 * pin : PIN you set with setPin command after verifying previous registration
 104
 105 Exceptions: Failure, InvalidNumber
 106
 107 version() -> version<s>::
 108 * version : Version string of signal-cli
 109
 110 Exceptions: None
 111
 112 === Signal interface
 113
 114 The following methods listen to the account's object path, which is constructed as follows:
 115
 116 - for single-account mode: "/org/asamk/Signal/"
 117 - for multi-account mode: "/org/asamk/Signal/" + DBusNumber
 118 * DBusNumber: account's phone number, with underscore (_) replacing plus (+)
 119
 120 getContactName(number<s>) -> name<s>::
 121 * number : Phone number
 122 * name : Contact's name in local storage (from the primary device for a linked account, or the one set with setContactName); if not set, contact's profile name is used
 123
 124 Exceptions: None
 125
 126 getContactNumber(name<s>) -> numbers<as>::
 127 * numbers : Array of phone number
 128 * name : Contact or profile name ("firstname lastname")
 129
 130 Searches contacts and known profiles for a given name and returns the list of all known numbers.
 131 May result in e.g. two entries if a contact and profile name is set.
 132
 133 Exceptions: None
 134
 135 getSelfNumber() -> number<s>::
 136 * number : Your phone number
 137
 138 Exceptions: None
 139
 140 isContactBlocked(number<s>) -> blocked<b>::
 141 * number : Phone number
 142 * blocked : true=blocked, false=not blocked
 143
 144 For unknown numbers false is returned but no exception is raised.
 145
 146 Exceptions: InvalidPhoneNumber
 147
 148 isRegistered() -> result<b>::
 149 isRegistered(number<s>) -> result<b>::
 150 isRegistered(numbers<as>) -> results<ab>::
 151 * number : Phone number
 152 * numbers : String array of phone numbers
 153 * result : true=number is registered, false=number is not registered
 154 * results : Boolean array of results
 155
 156 For unknown numbers, false is returned, but no exception is raised.
 157 If no number is given, returns true (indicating that you are registered).
 158
 159 Exceptions: InvalidNumber
 160
 161 listNumbers() -> numbers<as>::
 162 * numbers : String array of all known numbers
 163
 164 This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
 165
 166 Exceptions: None
 167
 168 removePin() -> <>::
 169
 170 Removes registration PIN protection.
 171
 172 Exceptions: Failure
 173
 174 sendEndSessionMessage(recipients<as>) -> <>::
 175 * recipients : Array of phone numbers
 176
 177 Exceptions: Failure, InvalidNumber, UntrustedIdentity
 178
 179 sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
 180 sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
 181 * message : Text to send (can be UTF8)
 182 * 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)
 183 * recipient : Phone number of a single recipient
 184 * recipients : String array of phone numbers
 185 * timestamp : Long, can be used to identify the corresponding Signal reply
 186
 187 Depending on the type of the recipient field this sends a message to one or multiple recipients.
 188
 189 Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
 190
 191 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 192 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 193 * emoji : Unicode grapheme cluster of the emoji
 194 * remove : Boolean, whether a previously sent reaction (emoji) should be removed
 195 * targetAuthor : String with the phone number of the author of the message to which to react
 196 * targetSentTimestamp : Long representing timestamp of the message to which to react
 197 * recipient : String with the phone number of a single recipient
 198 * recipients : Array of strings with phone numbers, should there be more recipients
 199 * timestamp : Long, can be used to identify the corresponding Signal reply
 200
 201 Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
 202
 203 Exceptions: Failure, InvalidNumber
 204
 205 sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
 206 * message : Text to send (can be UTF8)
 207 * 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)
 208 * timestamp : Long, can be used to identify the corresponding Signal reply
 209
 210 Exceptions: Failure, AttachmentInvalid
 211
 212 sendReadReceipt(recipient<s>, targetSentTimestamps<ax>) -> <>::
 213 * recipient : Phone number of a single recipient
 214 * targetSentTimestamps : Array of Longs to identify the corresponding Signal messages
 215
 216 Exceptions: Failure, UntrustedIdentity
 217
 218 sendViewedReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
 219 * recipient : Phone number of a single recipient
 220 * targetSentTimestamp : Array of Longs to identify the corresponding signal messages
 221
 222 Exceptions: Failure, UntrustedIdentity
 223
 224 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 225 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 226 * targetSentTimestamp : Long representing timestamp of the message to delete
 227 * recipient : String with the phone number of a single recipient
 228 * recipients : Array of strings with phone numbers, should there be more recipients
 229 * timestamp : Long, can be used to identify the corresponding signal reply
 230
 231 Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients.
 232
 233 Exceptions: Failure, InvalidNumber
 234
 235 sendTyping(recipient<s>, stop<b>) -> <>::
 236 * recipient : Phone number of a single recipient
 237 * stop : True, if typing state should be stopped
 238
 239 Exceptions: Failure, UntrustedIdentity
 240
 241 setContactBlocked(number<s>, block<b>) -> <>::
 242 * number : Phone number affected by method
 243 * block : false=remove block, true=blocked
 244
 245 Messages from blocked numbers will no longer be forwarded via DBus.
 246
 247 Exceptions: InvalidNumber
 248
 249 setContactName(number<s>,name<>) -> <>::
 250 * number : Phone number
 251 * name : Name to be set in contacts (in local storage with signal-cli)
 252
 253 Exceptions: InvalidNumber, Failure
 254
 255 deleteContact(number<s>) -> <>::
 256 * number : Phone number
 257
 258 Exceptions: Failure
 259
 260 deleteRecipient(number<s>) -> <>::
 261 * number : Phone number
 262
 263 Exceptions: Failure
 264
 265 setExpirationTimer(number<s>, expiration<i>) -> <>::
 266 * number : Phone number of recipient
 267 * expiration : int32 for the number of seconds before messages to this recipient disappear.
 268 Set to 0 to disable expiration.
 269
 270 Exceptions: Failure, InvalidNumber
 271
 272 setPin(pin<s>) -> <>::
 273 * pin : PIN you set after registration (resets after 7 days of inactivity)
 274
 275 Sets a registration lock PIN, to prevent others from registering your number.
 276
 277 Exceptions: Failure
 278
 279 submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
 280 * challenge : The challenge token taken from the proof required error.
 281 * captcha : The captcha token from the solved captcha on the Signal website.
 282 Can be used to lift some rate-limits by solving a captcha.
 283
 284 Exception: IOErrorException
 285
 286 updateProfile(name<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
 287 updateProfile(givenName<s>, familyName<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
 288 * name : Name for your own profile (empty if unchanged)
 289 * givenName : Given name for your own profile (empty if unchanged)
 290 * familyName : Family name for your own profile (empty if unchanged)
 291 * about : About message for profile (empty if unchanged)
 292 * aboutEmoji : Emoji for profile (empty if unchanged)
 293 * avatar : Filename of avatar picture for profile (empty if unchanged)
 294 * remove : Set to true if the existing avatar picture should be removed
 295
 296 Exceptions: Failure
 297
 298 uploadStickerPack(stickerPackPath<s>) -> url<s>::
 299 * stickerPackPath : Path to the manifest.json file or a zip file in the same directory
 300 * url : URL of sticker pack after successful upload
 301
 302 Exceptions: Failure
 303
 304 version() -> version<s>::
 305 * version : Version string of signal-cli
 306
 307 Exceptions: None
 308
 309 ==== Group related methods
 310
 311 createGroup(groupName<s>, members<as>, avatar<s>) -> groupId<ay>::
 312 * groupName : String representing the display name of the group
 313 * members : String array of new members to be invited to group
 314 * avatar : Filename of avatar picture to be set for group (empty if none)
 315 * groupId : Byte array representing the internal group identifier
 316
 317 Exceptions: AttachmentInvalid, Failure, InvalidNumber;
 318
 319 getGroup(groupId<ay>) -> objectPath<o>::
 320 * groupId : Byte array representing the internal group identifier
 321 * objectPath : DBusPath for the group
 322
 323 getGroupMembers(groupId<ay>) -> members<as>::
 324 * groupId : Byte array representing the internal group identifier
 325 * members : String array with the phone numbers of all active members of a group
 326
 327 Exceptions: None, if the group name is not found an empty array is returned
 328
 329 joinGroup(inviteURI<s>) -> <>::
 330 * inviteURI : String starting with https://signal.group/#
 331
 332 Behavior of this method depends on the `requirePermission` parameter of the `enableLink` method.
 333 If permission is required, `joinGroup` adds you to the requesting members list.
 334 Permission may be granted based on the group's `PermissionAddMember` property (`ONLY_ADMINS` or `EVERY_MEMBER`).
 335 If permission is not required, `joinGroup` admits you immediately to the group.
 336
 337 Exceptions: Failure
 338
 339 listGroups() -> groups<a(oays)>::
 340 * groups : Array of Structs(objectPath, groupId, groupName)
 341 ** objectPath : DBusPath
 342 ** groupId : Byte array representing the internal group identifier
 343 ** groupName : String representing the display name of the group
 344
 345 sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
 346 * message : Text to send (can be UTF8)
 347 * 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)
 348 * groupId : Byte array representing the internal group identifier
 349 * timestamp : Long, can be used to identify the corresponding Signal reply
 350
 351 Exceptions: GroupNotFound, Failure, AttachmentInvalid, InvalidGroupId
 352
 353 sendGroupTyping(groupId<ay>, stop<b>) -> <>::
 354 * groupId : Byte array representing the internal group identifier
 355 * stop : True, if typing state should be stopped
 356
 357 Exceptions: Failure, GroupNotFound, UntrustedIdentity
 358
 359 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 360 * emoji : Unicode grapheme cluster of the emoji
 361 * remove : Boolean, whether a previously sent reaction (emoji) should be removed
 362 * targetAuthor : String with the phone number of the author of the message to which to react
 363 * targetSentTimestamp : Long representing timestamp of the message to which to react
 364 * groupId : Byte array representing the internal group identifier
 365 * timestamp : Long, can be used to identify the corresponding signal reply
 366
 367 Exceptions: Failure, InvalidNumber, GroupNotFound, InvalidGroupId
 368
 369 sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 370 * targetSentTimestamp : Long representing timestamp of the message to delete
 371 * groupId : Byte array with base64 encoded group identifier
 372 * timestamp : Long, can be used to identify the corresponding signal reply
 373
 374 Exceptions: Failure, GroupNotFound, InvalidGroupId
 375
 376 ==== Device related methods
 377
 378 addDevice(deviceUri<s>) -> <>::
 379 * deviceUri : URI in the form of "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method.
 380
 381 getDevice(deviceId<x>) -> devicePath<o>::
 382 * deviceId : Long representing a deviceId
 383 * devicePath : DBusPath object for the device
 384
 385 Exceptions: DeviceNotFound
 386
 387 listDevices() -> devices<a(oxs)>::
 388 * devices : Array of structs (objectPath, id, name)
 389 ** objectPath : DBusPath representing the device's object path
 390 ** id : Long representing the deviceId
 391 ** name : String representing the device's name
 392
 393 Exceptions: InvalidUri
 394
 395 sendContacts() -> <>::
 396
 397 Sends a synchronization message with the local contacts list to all linked devices.
 398 This command should only be used if this is the primary device.
 399
 400 Exceptions: Failure
 401
 402 sendSyncRequest() -> <>::
 403
 404 Sends a synchronization request to the primary device (for group, contacts, ...).
 405 Only works if sent from a secondary device.
 406
 407 Exceptions: Failure
 408
 409 === Signal.Group interface
 410
 411 The following methods listen to the group's object path, which can be obtained from the listGroups() method and is constructed as follows:
 412
 413 <ACCOUNT_PATH> + "/Groups/" + DBusGroupId
 414
 415 DBusGroupId : groupId in base64 format, with underscore (_) replacing plus (+), equals (=), or slash (/)
 416
 417 Groups have the following (case-sensitive) properties:
 418
 419 * Id<ay> (read-only) : Byte array representing the internal group identifier
 420 * Name<s> : Display name of the group
 421 * Description<s> : Description of the group
 422 * Avatar<s> (write-only) : Filename of the avatar
 423 * IsBlocked<b> : true=member will not receive group messages; false=not blocked
 424 * IsMember<b> (read-only) : always true (object path exists only for group members)
 425 * IsAdmin<b> (read-only) : true=member has admin privileges; false=not admin
 426 * MessageExpirationTimer<i> : int32 representing message expiration time for group
 427 * Members<as> (read-only) : String array of group members' phone numbers
 428 * PendingMembers<as> (read-only) : String array of pending members' phone numbers
 429 * RequestingMembers<as> (read-only) : String array of requesting members' phone numbers
 430 * Admins<as> (read-only) : String array of admins' phone numbers
 431 * PermissionAddMember<s> : String representing who has permission to add members *ONLY_ADMINS, EVERY_MEMBER*
 432 * PermissionEditDetails<s> : String representing who may edit group details *ONLY_ADMINS, EVERY_MEMBER*
 433 * PermissionSendMessage<s> : String representing who post messages to group *ONLY_ADMINS, EVERY_MEMBER* (note that ONLY_ADMINS is equivalent to IsAnnouncementGroup)
 434 * GroupInviteLink<s> (read-only) : String of the invitation link (starts with https://signal.group/#)
 435
 436 To get a property, use (replacing `--session` with `--system` if needed):
 437 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Group string:$PROPERTY_NAME`
 438
 439 To set a property, use:
 440 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Group string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
 441
 442 To get all properties, use:
 443 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Group`
 444
 445 addAdmins(recipients<as>) -> <>::
 446 * recipients : String array of phone numbers
 447
 448 Grant admin privileges to recipients.
 449
 450 Exceptions: Failure
 451
 452 addMembers(recipients<as>) -> <>::
 453 * recipients : String array of phone numbers
 454
 455 Add recipients to group if they are pending members; otherwise add recipients to list of requesting members.
 456
 457 Exceptions: Failure
 458
 459 disableLink() -> <>::
 460
 461 Disables the group's invitation link.
 462
 463 Exceptions: Failure
 464
 465 enableLink(requiresApproval<b>) -> <>::
 466 * requiresApproval : true=add numbers using the link to the requesting members list
 467
 468 Enables the group's invitation link.
 469
 470 Exceptions: Failure
 471
 472 quitGroup() -> <>::
 473 Exceptions: Failure, LastGroupAdmin
 474
 475 removeAdmins(recipients<as>) -> <>::
 476 * recipients : String array of phone numbers
 477
 478 Remove admin privileges from recipients.
 479
 480 Exceptions: Failure
 481
 482 removeMembers(recipients<as>) -> <>::
 483 * recipients : String array of phone numbers
 484
 485 Remove recipients from group.
 486
 487 Exceptions: Failure
 488
 489 resetLink() -> <>::
 490
 491 Resets the group's invitation link to a new random URL starting with https://signal.group/#
 492
 493 Exceptions: Failure
 494
 495 === Signal.Device interface
 496
 497 The following methods listen to the device's object path, which is constructed as follows:
 498
 499 <ACCOUNT_PATH> + "/Devices/" + deviceId
 500
 501 deviceId : Number representing the device identifier (obtained from listDevices() method)
 502
 503 Devices have the following (case-sensitive) properties:
 504
 505 * Id<x> (read-only) : Long representing the device identifier
 506 * Created<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
 507 * LastSeen<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
 508 * Name<s> : String representing the display name of the device
 509
 510 To get a property, use (replacing `--session` with `--system` if needed):
 511 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Device string:$PROPERTY_NAME`
 512
 513 To set a property, use:
 514 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Device string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
 515
 516 To get all properties, use:
 517 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Device`
 518
 519 removeDevice() -> <>::
 520
 521 Exceptions: Failure
 522
 523 === Signal.Configuration interface
 524
 525 The configuration's object path, which exists only for primary devices, is constructed as follows:
 526 <ACCOUNT_PATH> + "/Configuration"
 527
 528 Configurations have the following (case-sensitive) properties:
 529
 530 * ReadReceipts<b> : should send read receipts (true/false)
 531 * UnidentifiedDeliveryIndicators<b> : should show unidentified delivery indicators (true/false)
 532 * TypingIndicators<b> : should send/show typing indicators (true/false)
 533 * LinkPreviews<b> : should generate link previews (true/false)
 534
 535 To get a property, use (replacing `--session` with `--system` if needed):
 536 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Configuration string:$PROPERTY_NAME`
 537
 538 To set a property, use:
 539 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Set string:org.asamk.Signal.Configuration string:$PROPERTY_NAME variant:$PROPERTY_TYPE:$PROPERTY_VALUE`
 540
 541 To get all properties, use:
 542 `dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Configuration`
 543
 544 == Signals
 545
 546 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, attachments<as>)::
 547 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
 548 * sender : Phone number of the sender
 549 * destination : DBus code for destination
 550 * groupId : Byte array representing the internal group identifier (empty when private message)
 551 * message : Message text
 552 * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/)
 553
 554 The sync message is received when the user sends a message from a linked device.
 555
 556 ReceiptReceived (timestamp<x>, sender<s>)::
 557 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
 558 * sender : Phone number of the sender
 559
 560 This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
 561
 562 MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
 563 * timestamp : Integer value that is used by the system to send a ReceiptReceived reply
 564 * sender : Phone number of the sender
 565 * groupId : Byte array representing the internal group identifier (empty when private message)
 566 * message : Message text
 567 * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/)
 568
 569 This signal is received whenever we get a private message or a message is posted in a group we are an active member
 570
 571 == Examples
 572
 573 Send a text message (without attachment) to a contact::
 574 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
 575
 576 Send a group message::
 577 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/attachment1','/path/to/attachment2' array:byte:139,22,72,247,116,32,170,104,205,164,207,21,248,77,185
 578
 579 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-a ACCOUNT`::
 580 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
 581
 582 == Authors
 583
 584 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 585 For more information about signal-cli development, see
 586 <https://github.com/AsamK/signal-cli>.