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

   1 /////
   2 vim:set ts=4 sw=4 tw=82 noet:
   3 /////
   4 :quotes.~:
   5
   6 = signal-cli-dbus (5)
   7
   8 == Name
   9
  10 DBus API for signal-cli - A commandline and dbus interface for the Signal messenger
  11
  12 == Synopsis
  13
  14 *signal-cli* [--verbose] [--config CONFIG] [-u USERNAME] [-o {plain-text,json}] daemon [--system]
  15
  16 *dbus-send* [--system | --session] [--print-reply] --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal[/_<phonenum>] org.asamk.Signal.<method> [string:<string argument>] [array:<type>:<array argument>]
  17
  18 Note: when daemon was started without explicit `-u USERNAME`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenum>`.
  19
  20 == Description
  21
  22 See signal-cli (1) for details on the application.
  23
  24 This documentation handles the supported methods when running signal-cli as a DBus daemon.
  25
  26 The method are described as follows:
  27
  28 method(arg1<type>, arg2<type>, ...) -> return<type>
  29
  30 Where <type> is according to DBus specification:
  31
  32 * <s>   : String
  33 * <ay>  : Byte Array
  34 * <aay> : Array of Byte Arrays
  35 * <as>  : String Array
  36 * <ax>  : Array of signed 64 bit integer
  37 * <b>   : Boolean (0|1)
  38 * <x>   : Signed 64 bit integer
  39 * <>    : no return value
  40
  41 Exceptions are the names of the Java Exceptions returned in the body field. They typically contain an additional message with details. All Exceptions begin with "org.asamk.Signal.Error." which is omitted here for better readability.
  42
  43 Phone numbers always have the format +<countrycode><regional number>
  44
  45 == Methods
  46
  47 updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
  48 * groupId  : Byte array representing the internal group identifier
  49 * newName  : New name of group (empty if unchanged)
  50 * members  : String array of new members to be invited to group
  51 * avatar   : Filename of avatar picture to be set for group (empty if none)
  52
  53 Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
  54
  55 updateProfile(newName<s>, about <s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
  56 * newName     : New name for your own profile (empty if unchanged)
  57 * about       : About message for profile (empty if unchanged)
  58 * aboutEmoji  : Emoji for profile (empty if unchanged)
  59 * avatar      : Filename of avatar picture for profile (empty if unchanged)
  60 * remove      : Set to 1 if the existing avatar picture should be removed
  61
  62 Exceptions: Failure
  63
  64
  65 setExpirationTimer(number<s>, expiration<i>) -> <>::
  66 * number     : Phone number of recipient
  67 * expiration : int32 for the number of seconds before messages to this recipient disappear. Set to 0 to disable expiration.
  68
  69 Exceptions: Failure
  70
  71 setContactBlocked(number<s>, block<b>) -> <>::
  72 * number  : Phone number affected by method
  73 * block   : 0=remove block , 1=blocked
  74
  75 Messages from blocked numbers will no longer be forwarded via DBus.
  76
  77 Exceptions: InvalidNumber
  78
  79 setGroupBlocked(groupId<ay>, block<b>) -> <>::
  80 * groupId : Byte array representing the internal group identifier
  81 * block   : 0=remove block , 1=blocked
  82
  83 Messages from blocked groups will no longer be forwarded via DBus.
  84
  85 Exceptions: GroupNotFound
  86
  87 joinGroup(inviteURI<s>) -> <>::
  88 * inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
  89
  90 Exceptions: Failure
  91
  92 quitGroup(groupId<ay>) -> <>::
  93 * groupId : Byte array representing the internal group identifier
  94
  95 Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember()
  96
  97 Exceptions: GroupNotFound, Failure
  98
  99 isMember(groupId<ay>) -> active<b>::
 100 * groupId : Byte array representing the internal group identifier
 101
 102 Note that this method does not raise an Exception for a non-existing/unknown group but will simply return 0 (false)
 103
 104 sendEndSessionMessage(recipients<as>) -> <>::
 105 * recipients : Array of phone numbers
 106
 107 Exceptions: Failure, InvalidNumber, UntrustedIdentity
 108
 109 sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
 110 * message     : Text to send (can be UTF8)
 111 * 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)
 112 * groupId     : Byte array representing the internal group identifier
 113 * timestamp   : Can be used to identify the corresponding signal reply
 114
 115 Exceptions: GroupNotFound, Failure, AttachmentInvalid
 116
 117 sendContacts() -> <>::
 118
 119 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.
 120
 121 Exceptions: Failure
 122
 123 sendSyncRequest() -> <>::
 124
 125 Sends a synchronization request to the primary device (for group, contacts, ...). Only works if sent from a secondary device.
 126
 127 Exception: Failure
 128
 129 sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
 130 * message     : Text to send (can be UTF8)
 131 * 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)
 132 * timestamp   : Can be used to identify the corresponding signal reply
 133
 134 Exceptions: Failure, AttachmentInvalid
 135
 136 sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
 137 sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
 138 * message     : Text to send (can be UTF8)
 139 * 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)
 140 * recipient   : Phone number of a single recipient
 141 * recipients  : Array of phone numbers
 142 * timestamp   : Can be used to identify the corresponding signal reply
 143
 144 Depending on the type of the recipient field this sends a message to one or multiple recipients.
 145
 146 Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
 147
 148 sendTyping(recipient<s>, stop<b>) -> <>::
 149 * recipient             : Phone number of a single recipient
 150 * targetSentTimestamp   : True, if typing state should be stopped
 151
 152 Exceptions: Failure, GroupNotFound, UntrustedIdentity
 153
 154
 155 sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
 156 * recipient             : Phone number of a single recipient
 157 * targetSentTimestamp   : Array of Longs to identify the corresponding signal messages
 158
 159 Exceptions: Failure, UntrustedIdentity
 160
 161 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 162 * emoji               : Unicode grapheme cluster of the emoji
 163 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 164 * targetAuthor        : String with the phone number of the author of the message to which to react
 165 * targetSentTimestamp : Long representing timestamp of the message to which to react
 166 * groupId             : Byte array with base64 encoded group identifier
 167 * timestamp           : Long, can be used to identify the corresponding signal reply
 168
 169 Exceptions: Failure, InvalidNumber, GroupNotFound
 170
 171 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 172 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 173 * emoji               : Unicode grapheme cluster of the emoji
 174 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 175 * targetAuthor        : String with the phone number of the author of the message to which to react
 176 * targetSentTimestamp : Long representing timestamp of the message to which to react
 177 * recipient           : String with the phone number of a single recipient
 178 * recipients          : Array of strings with phone numbers, should there be more recipients
 179 * timestamp           : Long, can be used to identify the corresponding signal reply
 180
 181 Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
 182
 183 Exceptions: Failure, InvalidNumber
 184
 185 sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 186 * targetSentTimestamp : Long representing timestamp of the message to delete
 187 * groupId             : Byte array with base64 encoded group identifier
 188 * timestamp           : Long, can be used to identify the corresponding signal reply
 189
 190 Exceptions: Failure, GroupNotFound
 191
 192 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 193 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 194 * targetSentTimestamp : Long representing timestamp of the message to delete
 195 * recipient           : String with the phone number of a single recipient
 196 * recipients          : Array of strings with phone numbers, should there be more recipients
 197 * timestamp           : Long, can be used to identify the corresponding signal reply
 198
 199 Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients.
 200
 201 Exceptions: Failure, InvalidNumber
 202
 203 getContactName(number<s>) -> name<s>::
 204 * number  : Phone number
 205 * 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
 206
 207 setContactName(number<s>,name<>) -> <>::
 208 * number  : Phone number
 209 * name    : Name to be set in contacts (in local storage with signal-cli)
 210
 211 getGroupIds() -> groupList<aay>::
 212 groupList : Array of Byte arrays representing the internal group identifiers
 213
 214 All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked()
 215
 216 getGroupName(groupId<ay>) -> groupName<s>::
 217 groupName : The display name of the group
 218 groupId   : Byte array representing the internal group identifier
 219
 220 Exceptions: None, if the group name is not found an empty string is returned
 221
 222 getGroupMembers(groupId<ay>) -> members<as>::
 223 members   : String array with the phone numbers of all active members of a group
 224 groupId   : Byte array representing the internal group identifier
 225
 226 Exceptions: None, if the group name is not found an empty array is returned
 227
 228 listNumbers() -> numbers<as>::
 229 numbers : String array of all known numbers
 230
 231 This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
 232
 233 getContactNumber(name<s>) -> numbers<as>::
 234 * numbers : Array of phone number
 235 * name    : Contact or profile name ("firstname lastname")
 236
 237 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.
 238
 239 isContactBlocked(number<s>) -> state<b>::
 240 * number  : Phone number
 241 * state   : 1=blocked, 0=not blocked
 242
 243 Exceptions: None, for unknown numbers 0 (false) is returned
 244
 245 isGroupBlocked(groupId<ay>) -> state<b>::
 246 * groupId : Byte array representing the internal group identifier
 247 * state   : 1=blocked, 0=not blocked
 248
 249 Exceptions: None, for unknown groups 0 (false) is returned
 250
 251 removePin() -> <>::
 252
 253 Removes registration PIN protection.
 254
 255 Exception: Failure
 256
 257 setPin(pin<s>) -> <>::
 258 * pin               : PIN you set after registration (resets after 7 days of inactivity)
 259
 260 Sets a registration lock PIN, to prevent others from registering your number.
 261
 262 Exception: Failure
 263
 264 version() -> version<s>::
 265 * version : Version string of signal-cli
 266
 267 isRegistred -> result<b>::
 268 * result : Currently always returns 1=true
 269
 270 uploadStickerPack(stickerPackPath<s>) -> url<s>::
 271 * stickerPackPath : Path to the manifest.json file or a zip file in the same directory
 272 * url             : URL of sticker pack after successful upload
 273
 274 Exception: Failure
 275
 276 == Signals
 277
 278 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
 279 The sync message is received when the user sends a message from a linked device.
 280
 281 ReceiptReceived (timestamp<x>, sender<s>)::
 282 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
 283 * sender    : Phone number of the sender
 284
 285 This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
 286
 287 MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
 288 * timestamp   : Integer value that is used by the system to send a ReceiptReceived reply
 289 * sender      : Phone number of the sender
 290 * groupId     : Byte array representing the internal group identifier (empty when private message)
 291 * message     : Message text
 292 * attachments : String array of filenames for the attachments. These files are located in the signal-cli storage and the current user needs to have read access there
 293
 294 This signal is received whenever we get a private message or a message is posted in a group we are an active member
 295
 296 == Examples
 297
 298 Send a text message (without attachment) to a contact::
 299 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
 300
 301 Send a group message::
 302 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
 303
 304 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`::
 305 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
 306
 307 == Authors
 308
 309 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 310 For more information about signal-cli development, see
 311 <https://github.com/AsamK/signal-cli>.