///// vim:set ts=4 sw=4 tw=82 noet: ///// :quotes.~: = signal-cli-dbus (5) == Name DBus API for signal-cli - A commandline and dbus interface for the Signal messenger == Synopsis *signal-cli* [--verbose] [--config CONFIG] [-u USERNAME] [-o {plain-text,json}] daemon [--system] *dbus-send* [--system | --session] [--print-reply] --type=method_call --dest="org.asamk.Signal" /org/asamk/Signal[/_] org.asamk.Signal. [string:] [array::] Note: when daemon was started without explicit `-u USERNAME`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_`. == Description See signal-cli (1) for details on the application. This documentation handles the supported methods when running signal-cli as a DBus daemon. The method are described as follows: method(arg1, arg2, ...) -> return Where is according to DBus specification: * : Array of ... * : String * : Boolean (false|true) * : Signed int32 integer (int) * : DBusPath object * : Signed int64 integer (long) * : Byte * <> : no return value 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. Phone numbers always have the format + == Methods === Control methods These methods are available if the daemon is started anonymously (without an explicit `-u USERNAME`). Requests are sent to `/org/asamk/Signal`; requests related to individual accounts are sent to `/org/asamk/Signal/_441234567890` where the + dialing code is replaced by an underscore (_). Only `version()` is activated in single-user mode; the rest are disabled. link() -> deviceLinkUri:: link(newDeviceName) -> deviceLinkUri:: * newDeviceName : Name to give new device (defaults to "cli" if no name is given) * deviceLinkUri : URI of newly linked device Returns a URI of the form "tsdevice:/?uuid=...". This can be piped to a QR encoder to create a display that can be captured by a Signal smartphone client. For example: `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` Exceptions: Failure listAccounts() -> accountList:: * accountList : Array of all attached accounts in DBus object path form Exceptions: None register(number, voiceVerification) -> <>:: * number : Phone number * voiceVerification : true = use voice verification; false = use SMS verification Exceptions: Failure, InvalidNumber, RequiresCaptcha registerWithCaptcha(number, voiceVerification, captcha) -> <>:: * number : Phone number * voiceVerification : true = use voice verification; false = use SMS verification * captcha : Captcha string Exceptions: Failure, InvalidNumber, RequiresCaptcha verify(number, verificationCode) -> <>:: * number : Phone number * verificationCode : Code received from Signal after successful registration request Command fails if PIN was set after previous registration; use verifyWithPin instead. Exceptions: Failure, InvalidNumber verifyWithPin(number, verificationCode, pin) -> <>:: * number : Phone number * verificationCode : Code received from Signal after successful registration request * pin : PIN you set with setPin command after verifying previous registration Exceptions: Failure, InvalidNumber version() -> version:: * version : Version string of signal-cli Exceptions: None === Device methods Requests for these methods are sent to a specific device (main or linked); the list is available from the listDevices() method (see below under "Other methods"). getDeviceName() -> deviceName:: * deviceName : Name of this device Exceptions: None removeDevice() -> <>:: Exceptions: Failure setDeviceName(deviceName) -> <>:: * deviceName : Name of this device Sets the name of this device locally. If this device is controlled by this signal-cli instance, also sets the name on the Signal servers. Exceptions: Failure === Other methods updateAdmins(groupId, admins, addToAdmins) -> adminList:: * groupId : Byte array representing the internal group identifier * admins : Phone numbers of users to grant or deny admin status * addToAdmins : true for add to group admins; false for remove from group admins * adminList : List of admins after command execution Exceptions: GroupNotFound, InvalidGroupId, Failure updateGroup(groupId, name, description, addMembers, removeMembers, addAdmins, removeAdmins, resetGroupLink, groupLinkState, addMemberPermission, editDetailsPermission, avatar, expiration, isAnnouncementGroup) -> groupId:: updateGroup(groupId, name, description, addMembers, removeMembers, addAdmins, removeAdmins, resetGroupLink, groupLinkState, addMemberPermission, editDetailsPermission, avatar, expiration) -> groupId:: * groupId : Byte array representing the internal group identifier * name : Name of group (empty if unchanged) * description : Description (empty if unchanged) * addMembers : String array of new members to be invited to group (empty if unchanged) * removeMembers : String array of members to be removed from group (empty if unchanged) * addAdmins : String array of members granted admin privileges (empty if unchanged) * removeAdmins : String array of members denied admin privileges (empty if unchanged) * resetGroupLink : Boolean (true = change the group link, false = don't change) * groupLinkState : String ("enabled", "enabled-with-approval", "disabled") (empty if unchanged) * addMemberPermission : String of who may add members ("every-member", "only-admins") (empty if unchanged) * editDetailsPermission : String of who may edit group details ("every-member", "only-admins") (empty if unchanged) * avatar : Filename of avatar picture to be set for group (see below). * expiration : Expiration time (in seconds) for messages sent to this group (see below). * isAnnouncementGroup : true=only admins can post, false=any member can post (omit if unchanged) If groupId is empty or null, Signal creates a group with a random identifier and returns it. To delete the group avatar, send the name of an empty file; leave field empty if avatar is unchanged. Set expiration time to 0 to disable expirations, set to a negative number to leave unchanged. Omit the isAnnouncementGroup parameter to leave it unchanged. Exceptions: InvalidGroupId, Failure updateGroup(groupId, newName, members, avatar) -> groupId:: * groupId : Byte array representing the internal group identifier * newName : New name of group (empty if unchanged) * members : String array of new members to be invited to group * avatar : Filename of avatar picture to be set for group (empty if none) If groupId is empty or null, Signal creates a group with a random identifier and returns it. To delete the group avatar, send the name of an empty file; leave field empty if avatar is unchanged. Set expiration time to 0 to disable expirations. Exceptions: AttachmentInvalid, Failure, GroupNotFound, InvalidGroupId, InvalidNumber updateMembers(groupId, members, addToMembers) -> memberList:: * groupId : Byte array representing the internal group identifier * members : Phone numbers of users to add to or remove from group * addToMembers : true for add to group members; false for remove from group members * active : Boolean representing whether you are a member of the group * memberList : List of members after command execution Exceptions: GroupNotFound, Failure, InvalidGroupId, InvalidNumber updateProfile(name, about, aboutEmoji , avatar, remove) -> <>:: updateProfile(givenName, familyName, about, aboutEmoji , avatar, remove) -> <>:: * name : Name for your own profile (empty if unchanged) * givenName : Given name for your own profile (empty if unchanged) * familyName : Family name for your own profile (empty if unchanged) * about : About message for profile (empty if unchanged) * aboutEmoji : Emoji for profile (empty if unchanged) * avatar : Filename of avatar picture for profile (empty if unchanged) * remove : Set to true if the existing avatar picture should be removed Exceptions: Failure setExpirationTimer(number, expiration) -> <>:: * number : Phone number of recipient * expiration : int32 for the number of seconds before messages to this recipient disappear. Set to 0 to disable expiration. Exceptions: Failure, InvalidNumber setContactBlocked(number, block) -> <>:: * number : Phone number affected by method * block : false=remove block, true=blocked Messages from blocked numbers will no longer be forwarded via DBus. Exceptions: InvalidNumber setGroupBlocked(groupId, block) -> <>:: * groupId : Byte array representing the internal group identifier * block : false=remove block , true=blocked Messages from blocked groups will no longer be forwarded via DBus. Exceptions: GroupNotFound, InvalidGroupId getGroupInviteUri(groupId) -> inviteUri:: * groupId : Byte array representing the internal group identifier * inviteUri : String representing the URI of the group invitation link (starts with https://signal.group) Exceptions: Failure, InvalidGroupId joinGroup(inviteUri) -> groupId:: * inviteUri : String representing the URI of the group invitation link (starts with https://signal.group) * groupId : Byte array representing the internal group identifier Exceptions: Failure quitGroup(groupId) -> <>:: * groupId : Byte array representing the internal group identifier Note that quitting a group will not remove the group from the getGroupIds command, but set it inactive which can be tested with isMember() Exceptions: GroupNotFound, Failure, InvalidGroupId isMember(groupId) -> isMember:: * groupId : Byte array representing the internal group identifier * isMember : true=you are a group member; false=you are not a group member Exceptions: GroupNotFound, Failure, InvalidGroupId sendEndSessionMessage(recipients) -> <>:: * recipients : Array of phone numbers Exceptions: Failure, InvalidNumber, UntrustedIdentity sendGroupMessage(message, attachments, groupId) -> timestamp:: * message : Text to send (can be UTF8) * 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) * groupId : Byte array representing the internal group identifier * timestamp : Long, can be used to identify the corresponding Signal reply Exceptions: GroupNotFound, Failure, AttachmentInvalid, InvalidGroupId sendContacts() -> <>:: 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. Exceptions: Failure sendSyncRequest() -> <>:: Sends a synchronization request to the primary device (for group, contacts, ...). Only works if sent from a secondary device. Exceptions: Failure sendNoteToSelfMessage(message, attachments) -> timestamp:: * message : Text to send (can be UTF8) * 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) * timestamp : Long, can be used to identify the corresponding Signal reply Exceptions: Failure, AttachmentInvalid sendMessage(message, attachments, recipient) -> timestamp:: sendMessage(message, attachments, recipients) -> timestamp:: * message : Text to send (can be UTF8) * 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) * recipient : Phone number of a single recipient * recipients : String array of phone numbers * timestamp : Long, can be used to identify the corresponding Signal reply Depending on the type of the recipient field this sends a message to one or multiple recipients. Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity sendTyping(typingAction, groupIdStrings, numbers) -> <>:: * typingAction : true = start typing, false = stop typing * groupIdStrings : List of strings representing the internal group identifiers in Base64 format * numbers : List of phone numbers for recipients Exceptions: Failure, GroupNotFound, UntrustedIdentity sendReadReceipt(recipient, targetSentTimestamps) -> <>:: * recipient : Phone number of a single recipient * targetSentTimestamps : Array of Longs to identify the corresponding Signal messages Exceptions: Failure, UntrustedIdentity sendGroupMessageReaction(emoji, remove, targetAuthor, targetSentTimestamp, groupId) -> timestamp:: * emoji : Unicode grapheme cluster of the emoji * remove : Boolean, whether a previously sent reaction (emoji) should be removed * targetAuthor : String with the phone number of the author of the message to which to react * targetSentTimestamp : Long representing timestamp of the message to which to react * groupId : Byte array representing the internal group identifier * timestamp : Long, can be used to identify the corresponding signal reply Exceptions: Failure, InvalidNumber, GroupNotFound, InvalidGroupId sendMessageReaction(emoji, remove, targetAuthor, targetSentTimestamp, recipient) -> timestamp:: sendMessageReaction(emoji, remove, targetAuthor, targetSentTimestamp, recipients) -> timestamp:: * emoji : Unicode grapheme cluster of the emoji * remove : Boolean, whether a previously sent reaction (emoji) should be removed * targetAuthor : String with the phone number of the author of the message to which to react * targetSentTimestamp : Long representing timestamp of the message to which to react * recipient : String with the phone number of a single recipient * recipients : Array of strings with phone numbers, should there be more recipients * timestamp : Long, can be used to identify the corresponding Signal reply Depending on the type of the recipient(s) field this sends a reaction to one or multiple recipients. Exceptions: Failure, InvalidNumber sendGroupRemoteDeleteMessage(targetSentTimestamp, groupId) -> timestamp:: * targetSentTimestamp : Long representing timestamp of the message to delete * groupId : Byte array with base64 encoded group identifier * timestamp : Long, can be used to identify the corresponding signal reply Exceptions: Failure, GroupNotFound, InvalidGroupId sendRemoteDeleteMessage(targetSentTimestamp, recipient) -> timestamp:: sendRemoteDeleteMessage(targetSentTimestamp, recipients) -> timestamp:: * targetSentTimestamp : Long representing timestamp of the message to delete * recipient : String with the phone number of a single recipient * recipients : Array of strings with phone numbers, should there be more recipients * timestamp : Long, can be used to identify the corresponding signal reply Depending on the type of the recipient(s) field this deletes a message with one or multiple recipients. Exceptions: Failure, InvalidNumber getContactName(number) -> name:: * number : Phone number * 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 Exceptions: None setContactName(number,name<>) -> <>:: * number : Phone number * name : Name to be set in contacts (in local storage with signal-cli) Exceptions: InvalidNumber, Failure getGroupIds() -> groupList:: groupList : Array of Byte arrays representing the internal group identifiers All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked() Exceptions: None getGroupId(groupName) -> groupId:: * groupName : String representing name of a group * groupId : Byte array representing the internal group identifier Exceptions: GroupNotFound getGroupIdStrings() -> groupIdStrings:: * groupIdStrings : Array of strings representing the internal group identifiers All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked() Exceptions: None getGroupIdString(groupName) -> groupIdString:: * groupName : String representing name of a group * groupIdString : String representing the internal group identifier Exceptions: GroupNotFound getGroupName(groupId) -> groupName:: * groupId : Byte array representing the internal group identifier * groupName : The display name of the group Exceptions: InvalidGroupId, Failure getGroupNames() -> groupNames:: * groupName : Array of strings representing names of groups All groups known are returned, regardless of their active or blocked status. To query that use isMember() and isGroupBlocked() Exceptions: None getGroupMembers(groupId) -> members:: * groupId : Byte array representing the internal group identifier * members : String array with the phone numbers of all active members of a group Exceptions: InvalidGroupId, Failure getGroupAdminMembers(groupId) -> groupAdminMembers:: * groupId : Byte array representing the internal group identifier * groupAdminMembers : String array of phone numbers of members granted admin privileges Exceptions: InvalidGroupId, Failure getGroupPendingMembers(groupId) -> groupPendingMembers:: * groupId : Byte array representing the internal group identifier * groupPendingMembers : String array of phone numbers of pending members Exceptions: InvalidGroupId, Failure getGroupRequestingMembers(groupId) -> groupRequestingMembers:: * groupId : Byte array representing the internal group identifier * groupRequestingMembers : String array of phone numbers of requesting members Exceptions: InvalidGroupId, Failure isGroupAnnounceOnly(groupId) -> isAnnouncementGroup:: * groupId : Byte array representing the internal group identifier * isAnnouncementGroup : true=only admins can post, false=any member can post Exceptions: InvalidGroupId, Failure setGroupAnnounceOnly(groupId, isAnnouncementGroup) -> <>:: * groupId : Byte array representing the internal group identifier * isAnnouncementGroup : true=only admins can post, false=any member can post Exceptions: GroupNotFound, InvalidGroupId, Failure isAdmin(groupId) -> isAdmin:: * groupId : Byte array representing the internal group identifier * isAdmin : true=you are a group admin; false=you are not a group admin Exceptions: InvalidGroupId, Failure listNumbers() -> numbers:: * numbers : String array of all known numbers This is a concatenated list of all defined contacts as well of profiles known (e.g. peer group members or sender of received messages) Exceptions: None getContactNumber(name) -> numbers:: * numbers : Array of phone number * name : Contact or profile name ("firstname lastname") 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. Exceptions: None isContactBlocked(number) -> blocked:: * number : Phone number * blocked : true=blocked, false=not blocked For unknown numbers false is returned but no exception is raised. Exceptions: InvalidPhoneNumber isGroupBlocked(groupId) -> isGroupBlocked:: * groupId : Byte array representing the internal group identifier * isGroupBlocked : true=group is blocked; false=group is not blocked Dbus will not forward messages from a group when you have blocked it. Exceptions: InvalidGroupId, Failure removePin() -> <>:: Removes registration PIN protection. Exceptions: Failure setPin(pin) -> <>:: * pin : PIN you set after registration (resets after 7 days of inactivity) Sets a registration lock PIN, to prevent others from registering your number. Exceptions: Failure version() -> version:: * version : Version string of signal-cli Exceptions: None getSelfNumber() -> number:: * number : Your phone number Exceptions: None isRegistered() -> result:: isRegistered(number) -> result:: isRegistered(numbers) -> results:: * number : Phone number * numbers : String array of phone numbers * result : true=number is registered, false=number is not registered * results : Boolean array of results For unknown numbers, false is returned, but no exception is raised. If no number is given, returns true (indicating that you are registered). Exceptions: InvalidNumber addDevice(deviceUri) -> <>:: * deviceUri : URI in the form of tsdevice:/?uuid=... Normally displayed by a Signal desktop app, smartphone app, or another signal-cli instance using the `link` control method. Exceptions: InvalidUri getDevice(deviceId) -> devicePath:: * deviceId : Long representing a (potential) deviceId * devicePath : DBusPath object for the device Note that this method returns a value even if the device does not exist. Exceptions: None listDevices() -> devices:: * devices : Array of DBusPath objects for main device and any linked devices Exceptions: Failure uploadStickerPack(stickerPackPath) -> url:: * stickerPackPath : Path to the manifest.json file or a zip file in the same directory * url : URL of sticker pack after successful upload Exceptions: Failure == Signals SyncMessageReceived (timestamp, sender, destination, groupId, message, attachments):: * timestamp : Integer value that can be used to associate this e.g. with a sendMessage() * sender : Phone number of the sender * destination : DBus code for destination * groupId : Byte array representing the internal group identifier (empty when private message) * message : Message text * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/) The sync message is received when the user sends a message from a linked device. ReceiptReceived (timestamp, sender):: * timestamp : Integer value that can be used to associate this e.g. with a sendMessage() * sender : Phone number of the sender This signal is sent by each recipient (e.g. each group member) after the message was successfully delivered to the device MessageReceived(timestamp, sender, groupId, message, attachments):: * timestamp : Integer value that is used by the system to send a ReceiptReceived reply * sender : Phone number of the sender * groupId : Byte array representing the internal group identifier (empty when private message) * message : Message text * attachments : String array of filenames in the signal-cli storage (~/.local/share/signal-cli/attachments/) This signal is received whenever we get a private message or a message is posted in a group we are an active member == Examples Send a text message (without attachment) to a contact:: 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 Send a group message:: 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 Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-u USERNAME`:: 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 == Authors Maintained by AsamK , who is assisted by other open source contributors. For more information about signal-cli development, see .