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