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 setContactBlocked(number<s>, block<b>) -> <>::
  65 * number  : Phone number affected by method
  66 * block   : 0=remove block , 1=blocked
  67
  68 Messages from blocked numbers will no longer be forwarded via DBus.
  69
  70 Exceptions: InvalidNumber
  71
  72 setGroupBlocked(groupId<ay>, block<b>) -> <>::
  73 * groupId : Byte array representing the internal group identifier
  74 * block   : 0=remove block , 1=blocked
  75
  76 Messages from blocked groups will no longer be forwarded via DBus.
  77
  78 Exceptions: GroupNotFound
  79
  80 joinGroup(inviteURI<s>) -> <>::
  81 * inviteURI : String starting with https://signal.group which is generated when you share a group link via Signal App
  82
  83 Exceptions: Failure
  84
  85 quitGroup(groupId<ay>) -> <>::
  86 * groupId : Byte array representing the internal group identifier
  87
  88 Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember()
  89
  90 Exceptions: GroupNotFound, Failure
  91
  92 isMember(groupId<ay>) -> active<b>::
  93 * groupId : Byte array representing the internal group identifier
  94
  95 Note that this method does not raise an Exception for a non-existing/unknown group but will simply return 0 (false)
  96
  97 sendEndSessionMessage(recipients<as>) -> <>::
  98 * recipients : Array of phone numbers
  99
 100 Exceptions: Failure, InvalidNumber, UntrustedIdentity
 101
 102 sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
 103 * message     : Text to send (can be UTF8)
 104 * 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)
 105 * groupId     : Byte array representing the internal group identifier
 106 * timestamp   : Can be used to identify the corresponding signal reply
 107
 108 Exceptions: GroupNotFound, Failure, AttachmentInvalid
 109
 110 sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
 111 * message     : Text to send (can be UTF8)
 112 * 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)
 113 * timestamp   : Can be used to identify the corresponding signal reply
 114
 115 Exceptions: Failure, AttachmentInvalid
 116
 117 sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
 118 sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
 119 * message     : Text to send (can be UTF8)
 120 * 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)
 121 * recipient   : Phone number of a single recipient
 122 * recipients  : Array of phone numbers
 123 * timestamp   : Can be used to identify the corresponding signal reply
 124
 125 Depending on the type of the recipient field this sends a message to one or multiple recipients.
 126
 127 Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
 128
 129 sendTyping(recipient<s>, stop<b>) -> <>::
 130 * recipient             : Phone number of a single recipient
 131 * targetSentTimestamp   : True, if typing state should be stopped
 132
 133 Exceptions: Failure, GroupNotFound, UntrustedIdentity
 134
 135
 136 sendReadReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
 137 * recipient             : Phone number of a single recipient
 138 * targetSentTimestamp   : Array of Longs to identify the corresponding signal messages
 139
 140 Exceptions: Failure, UntrustedIdentity
 141
 142 sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 143 * emoji               : Unicode grapheme cluster of the emoji
 144 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 145 * targetAuthor        : String with the phone number of the author of the message to which to react
 146 * targetSentTimestamp : Long representing timestamp of the message to which to react
 147 * groupId             : Byte array with base64 encoded group identifier
 148 * timestamp           : Long, can be used to identify the corresponding signal reply
 149
 150 Exceptions: Failure, InvalidNumber, GroupNotFound
 151
 152 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 153 sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 154 * emoji               : Unicode grapheme cluster of the emoji
 155 * remove              : Boolean, whether a previously sent reaction (emoji) should be removed
 156 * targetAuthor        : String with the phone number of the author of the message to which to react
 157 * targetSentTimestamp : Long representing timestamp of the message to which to react
 158 * recipient           : String with the phone number of a single recipient
 159 * recipients          : Array of strings with phone numbers, should there be more recipients
 160 * timestamp           : Long, can be used to identify the corresponding signal reply
 161
 162 Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients.
 163
 164 Exceptions: Failure, InvalidNumber
 165
 166 sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
 167 * targetSentTimestamp : Long representing timestamp of the message to delete
 168 * groupId             : Byte array with base64 encoded group identifier
 169 * timestamp           : Long, can be used to identify the corresponding signal reply
 170
 171 Exceptions: Failure, GroupNotFound
 172
 173 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
 174 sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
 175 * targetSentTimestamp : Long representing timestamp of the message to delete
 176 * recipient           : String with the phone number of a single recipient
 177 * recipients          : Array of strings with phone numbers, should there be more recipients
 178 * timestamp           : Long, can be used to identify the corresponding signal reply
 179
 180 Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients.
 181
 182 Exceptions: Failure, InvalidNumber
 183
 184 getContactName(number<s>) -> name<s>::
 185 * number  : Phone number
 186 * 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
 187
 188 setContactName(number<s>,name<>) -> <>::
 189 * number  : Phone number
 190 * name    : Name to be set in contacts (in local storage with signal-cli)
 191
 192 getGroupIds() -> groupList<aay>::
 193 groupList : Array of Byte arrays representing the internal group identifiers
 194
 195 All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked()
 196
 197 getGroupName(groupId<ay>) -> groupName<s>::
 198 groupName : The display name of the group
 199 groupId   : Byte array representing the internal group identifier
 200
 201 Exceptions: None, if the group name is not found an empty string is returned
 202
 203 getGroupMembers(groupId<ay>) -> members<as>::
 204 members   : String array with the phone numbers of all active members of a group
 205 groupId   : Byte array representing the internal group identifier
 206
 207 Exceptions: None, if the group name is not found an empty array is returned
 208
 209 listNumbers() -> numbers<as>::
 210 numbers : String array of all known numbers
 211
 212 This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages)
 213
 214 getContactNumber(name<s>) -> numbers<as>::
 215 * numbers : Array of phone number
 216 * name    : Contact or profile name ("firstname lastname")
 217
 218 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.
 219
 220 isContactBlocked(number<s>) -> state<b>::
 221 * number  : Phone number
 222 * state   : 1=blocked, 0=not blocked
 223
 224 Exceptions: None, for unknown numbers 0 (false) is returned
 225
 226 isGroupBlocked(groupId<ay>) -> state<b>::
 227 * groupId : Byte array representing the internal group identifier
 228 * state   : 1=blocked, 0=not blocked
 229
 230 Exceptions: None, for unknown groups 0 (false) is returned
 231
 232 removePin() -> <>::
 233
 234 Removes registration PIN protection.
 235
 236 Exception: Failure
 237
 238 setPin(pin<s>) -> <>::
 239 * pin               : PIN you set after registration (resets after 7 days of inactivity)
 240
 241 Sets a registration lock PIN, to prevent others from registering your number.
 242
 243 Exception: Failure
 244
 245 version() -> version<s>::
 246 * version : Version string of signal-cli
 247
 248 isRegistred -> result<b>::
 249 * result : Currently always returns 1=true
 250
 251 == Signals
 252
 253 SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>,message<s>, attachments<as>)::
 254 The sync message is received when the user sends a message from a linked device.
 255
 256 ReceiptReceived (timestamp<x>, sender<s>)::
 257 * timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
 258 * sender    : Phone number of the sender
 259
 260 This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device
 261
 262 MessageReceived(timestamp<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
 263 * timestamp   : Integer value that is used by the system to send a ReceiptReceived reply
 264 * sender      : Phone number of the sender
 265 * groupId     : Byte array representing the internal group identifier (empty when private message)
 266 * message     : Message text
 267 * 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
 268
 269 This signal is received whenever we get a private message or a message is posted in a group we are an active member
 270
 271 == Examples
 272
 273 Send a text message (without attachment) to a contact::
 274 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
 275
 276 Send a group message::
 277 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
 278
 279 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`::
 280 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
 281
 282 == Authors
 283
 284 Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
 285 For more information about signal-cli development, see
 286 <https://github.com/AsamK/signal-cli>.