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