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