mirror of
https://github.com/AsamK/signal-cli
synced 2025-08-29 10:30:38 +00:00
Update man pages
This commit is contained in:
AsamK
parent
0bd142ab6b
commit
f0d9a33d9a
3 changed files with 472 additions and 392 deletions
695
man/signal-cli-dbus.5.adoc
Executable file → Normal file
695
man/signal-cli-dbus.5.adoc
Executable file → Normal file
|
|
@ -1,6 +1,7 @@
|
|||
/////
|
||||
vim:set ts=4 sw=4 tw=82 noet:
|
||||
/////
|
||||
|
||||
:quotes.~:
|
||||
|
||||
= signal-cli-dbus (5)
|
||||
|
|
@ -11,11 +12,11 @@ DBus API for signal-cli - A commandline and dbus interface for the Signal messen
|
|||
|
||||
== Synopsis
|
||||
|
||||
*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] [-o {plain-text,json}] daemon [--system]
|
||||
*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] [-o {plain-text,json}] daemon [--dbus] [--dbus-system]
|
||||
|
||||
*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>]
|
||||
*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>]
|
||||
|
||||
Note: when daemon was started without explicit `-a ACCOUNT`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenum>`.
|
||||
Note: when daemon was started without explicit `-a ACCOUNT`, the `dbus-send` command requires adding the phone number in `/org/asamk/Signal/_<phonenumber>`.
|
||||
|
||||
== Description
|
||||
|
||||
|
|
@ -29,39 +30,47 @@ method(arg1<type>, arg2<type>, ...) -> return<type>
|
|||
|
||||
Where <type> is according to DBus specification:
|
||||
|
||||
* <a> : Array of ... (comma-separated list) (array:)
|
||||
* <a> : Array of ... (comma-separated list) (array:)
|
||||
* (...) : Struct (cannot be sent via `dbus-send`)
|
||||
* <b> : Boolean (false|true) (boolean:)
|
||||
* <i> : Signed 32-bit (int) integer (int32:)
|
||||
* <o> : DBusPath object (objpath:)
|
||||
* <s> : String (string:)
|
||||
* <x> : Signed 64-bit (long) integer (int64:)
|
||||
* <y> : Unsigned 8-bit (byte) integer (byte:)
|
||||
* <> : no return value
|
||||
* <b> : Boolean (false|true) (boolean:)
|
||||
* <i> : Signed 32-bit (int) integer (int32:)
|
||||
* <o> : DBusPath object (objpath:)
|
||||
* <s> : String (string:)
|
||||
* <x> : Signed 64-bit (long) integer (int64:)
|
||||
* <y> : Unsigned 8-bit (byte) integer (byte:)
|
||||
* <> : no return value
|
||||
|
||||
The final parenthetical value (such as "boolean:") is the type indicator used by `dbus-send`.
|
||||
|
||||
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.
|
||||
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 +<countrycode><regional number>
|
||||
|
||||
== Methods
|
||||
|
||||
=== Control methods
|
||||
These methods are available if the daemon is started anonymously (without an explicit `-a ACCOUNT`).
|
||||
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-account mode; the rest are disabled.
|
||||
=== SignalControl interface
|
||||
|
||||
These methods are available if the daemon is started in multi-account mode (without an explicit `-a ACCOUNT`).
|
||||
The exported `/org/asamk/Signal` object provides a SignalControl interface, with methods to manage accounts.
|
||||
Individual accounts are exported as separate objects and provide a Signal interface, that's described below.
|
||||
e.g. `/org/asamk/Signal/\_441234567890` where the + dialing code is replaced by an underscore (_).
|
||||
|
||||
link() -> deviceLinkUri<s>::
|
||||
link(newDeviceName<s>) -> deviceLinkUri<s>::
|
||||
* 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 "sgnl://linkdevice?uuid=...". This can be piped to a QR encoder to create a display that
|
||||
can be captured by a Signal smartphone client. For example:
|
||||
Returns a URI of the form "sgnl://linkdevice?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`
|
||||
[source]
|
||||
|
||||
----
|
||||
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
|
||||
|
||||
|
|
@ -71,30 +80,30 @@ listAccounts() -> accountList<as>::
|
|||
Exceptions: None
|
||||
|
||||
register(number<s>, voiceVerification<b>) -> <>::
|
||||
* number : Phone number
|
||||
* number : Phone number
|
||||
* voiceVerification : true = use voice verification; false = use SMS verification
|
||||
|
||||
Exceptions: Failure, InvalidNumber, RequiresCaptcha
|
||||
|
||||
registerWithCaptcha(number<s>, voiceVerification<b>, captcha<s>) -> <>::
|
||||
* number : Phone number
|
||||
* number : Phone number
|
||||
* voiceVerification : true = use voice verification; false = use SMS verification
|
||||
* captcha : Captcha string
|
||||
* captcha : Captcha string
|
||||
|
||||
Exceptions: Failure, InvalidNumber, RequiresCaptcha
|
||||
|
||||
verify(number<s>, verificationCode<s>) -> <>::
|
||||
* number : Phone number
|
||||
* verificationCode : Code received from Signal after successful registration request
|
||||
* 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<s>, verificationCode<s>, pin<s>) -> <>::
|
||||
* number : Phone number
|
||||
* verificationCode : Code received from Signal after successful registration request
|
||||
* pin : PIN you set with setPin command after verifying previous registration
|
||||
* 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
|
||||
|
||||
|
|
@ -103,300 +112,26 @@ version() -> version<s>::
|
|||
|
||||
Exceptions: None
|
||||
|
||||
=== Group control methods
|
||||
The following methods listen to the recipient's object path, which is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
=== Signal interface
|
||||
|
||||
createGroup(groupName<s>, members<as>, avatar<s>) -> groupId<ay>::
|
||||
* groupName : String representing the display name of the group
|
||||
* members : String array of new members to be invited to group
|
||||
* avatar : Filename of avatar picture to be set for group (empty if none)
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
The following methods listen to the account's object path, which is constructed as follows:
|
||||
|
||||
Exceptions: AttachmentInvalid, Failure, InvalidNumber;
|
||||
|
||||
getGroup(groupId<ay>) -> objectPath<o>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* objectPath : DBusPath for the group
|
||||
|
||||
getGroupMembers(groupId<ay>) -> members<as>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* members : String array with the phone numbers of all active members of a group
|
||||
|
||||
Exceptions: None, if the group name is not found an empty array is returned
|
||||
|
||||
joinGroup(inviteURI<s>) -> <>::
|
||||
* inviteURI : String starting with https://signal.group/#
|
||||
|
||||
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.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
listGroups() -> groups<a(oays)>::
|
||||
* groups : Array of Structs(objectPath, groupId, groupName)
|
||||
** objectPath : DBusPath
|
||||
** groupId : Byte array representing the internal group identifier
|
||||
** groupName : String representing the display name of the group
|
||||
|
||||
sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
=== Group methods
|
||||
The following methods listen to the group's object path, which can be obtained from the listGroups() method and is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber + "/Groups/" + DBusGroupId
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
* DBusGroupId : groupId in base64 format, with underscore (_) replacing plus (+), equals (=), or slash (/)
|
||||
|
||||
Groups have the following (case-sensitive) properties:
|
||||
* Id<ay> (read-only) : Byte array representing the internal group identifier
|
||||
* Name<s> : Display name of the group
|
||||
* Description<s> : Description of the group
|
||||
* Avatar<s> (write-only) : Filename of the avatar
|
||||
* IsBlocked<b> : true=member will not receive group messages; false=not blocked
|
||||
* IsMember<b> (read-only) : always true (object path exists only for group members)
|
||||
* IsAdmin<b> (read-only) : true=member has admin privileges; false=not admin
|
||||
* MessageExpirationTimer<i> : int32 representing message expiration time for group
|
||||
* Members<as> (read-only) : String array of group members' phone numbers
|
||||
* PendingMembers<as> (read-only) : String array of pending members' phone numbers
|
||||
* RequestingMembers<as> (read-only) : String array of requesting members' phone numbers
|
||||
* Admins<as> (read-only) : String array of admins' phone numbers
|
||||
* PermissionAddMember<s> : String representing who has permission to add members
|
||||
** ONLY_ADMINS, EVERY_MEMBER
|
||||
* PermissionEditDetails<s> : String representing who may edit group details
|
||||
** ONLY_ADMINS, EVERY_MEMBER
|
||||
* PermissionSendMessage<s> : String representing who post messages to group
|
||||
** ONLY_ADMINS, EVERY_MEMBER (note that ONLY_ADMINS is equivalent to IsAnnouncementGroup)
|
||||
* GroupInviteLink<s> (read-only) : String of the invitation link (starts with https://signal.group/#)
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Group string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Group`
|
||||
|
||||
addAdmins(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Grant admin privileges to recipients.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
addMembers(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Add recipients to group if they are pending members; otherwise add recipients to list of requesting members.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
disableLink() -> <>::
|
||||
|
||||
Disables the group's invitation link.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
enableLink(requiresApproval<b>) -> <>::
|
||||
* requiresApproval : true=add numbers using the link to the requesting members list
|
||||
|
||||
Enables the group's invitation link.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
quitGroup() -> <>::
|
||||
Exceptions: Failure, LastGroupAdmin
|
||||
|
||||
removeAdmins(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Remove admin privileges from recipients.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
removeMembers(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Remove recipients from group.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
resetLink() -> <>::
|
||||
|
||||
Resets the group's invitation link to a new random URL starting with https://signal.group/#
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Deprecated group control methods
|
||||
The following deprecated methods listen to the recipient's object path, which is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
|
||||
getGroupIds() -> groupList<aay>::
|
||||
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
|
||||
|
||||
getGroupName(groupId<ay>) -> groupName<s>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* groupName : The display name of the group
|
||||
|
||||
Exceptions: None, if the group name is not found an empty string is returned
|
||||
|
||||
isGroupBlocked(groupId<ay>) -> isGroupBlocked<b>::
|
||||
* 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
|
||||
|
||||
isMember(groupId<ay>) -> isMember<b>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* isMember : true=you are a group member; false=you are not a group member
|
||||
|
||||
Note that this method does not raise an Exception for a non-existing/unknown group but will simply return 0 (false)
|
||||
|
||||
quitGroup(groupId<ay>) -> <>::
|
||||
* 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
|
||||
|
||||
setGroupBlocked(groupId<ay>, block<b>) -> <>::
|
||||
* 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
|
||||
|
||||
updateGroup(groupId<ay>, newName<s>, members<as>, avatar<s>) -> groupId<ay>::
|
||||
* 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)
|
||||
|
||||
Exceptions: AttachmentInvalid, Failure, InvalidNumber, GroupNotFound
|
||||
|
||||
=== Device control methods
|
||||
The following methods listen to the recipient's object path, which is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
|
||||
addDevice(deviceUri<s>) -> <>::
|
||||
* 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.
|
||||
|
||||
getDevice(deviceId<x>) -> devicePath<o>::
|
||||
* deviceId : Long representing a deviceId
|
||||
* devicePath : DBusPath object for the device
|
||||
|
||||
Exceptions: DeviceNotFound
|
||||
|
||||
listDevices() -> devices<a(oxs)>::
|
||||
* devices : Array of structs (objectPath, id, name)
|
||||
** objectPath : DBusPath representing the device's object path
|
||||
** id : Long representing the deviceId
|
||||
** name : String representing the device's name
|
||||
|
||||
Exceptions: InvalidUri
|
||||
|
||||
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
|
||||
|
||||
=== Device methods and properties
|
||||
The following methods listen to the device's object path, which is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber + "/Devices/" + deviceId
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
* deviceId : Long representing the device identifier (obtained from listDevices() method)
|
||||
|
||||
Devices have the following (case-sensitive) properties:
|
||||
* Id<x> (read-only) : Long representing the device identifier
|
||||
* Created<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
|
||||
* LastSeen<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
|
||||
* Name<s> : String representing the display name of the device
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Device string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Device`
|
||||
|
||||
removeDevice() -> <>::
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Configuration properties
|
||||
The configuration's object path, which exists only for primary devices, is constructed as follows:
|
||||
"/org/asamk/Signal/" + DBusNumber + "/Configuration"
|
||||
* DBusNumber : recipient's phone number, with underscore (_) replacing plus (+)
|
||||
|
||||
Configurations have the following (case-sensitive) properties:
|
||||
* ReadReceipts<b> : should send read receipts (true/false)
|
||||
* UnidentifiedDeliveryIndicators<b> : should show unidentified delivery indicators (true/false)
|
||||
* TypingIndicators<b> : should send/show typing indicators (true/false)
|
||||
* LinkPreviews<b> : should generate link previews (true/false)
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Configuration string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Configuration`
|
||||
|
||||
=== Other methods
|
||||
- for single-account mode: "/org/asamk/Signal/"
|
||||
- for multi-account mode: "/org/asamk/Signal/" + DBusNumber
|
||||
* DBusNumber: account's phone number, with underscore (_) replacing plus (+)
|
||||
|
||||
getContactName(number<s>) -> name<s>::
|
||||
* 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
|
||||
* 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
|
||||
|
||||
getContactNumber(name<s>) -> numbers<as>::
|
||||
* numbers : Array of phone number
|
||||
* name : Contact or profile name ("firstname lastname")
|
||||
* 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.
|
||||
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
|
||||
|
||||
|
|
@ -406,8 +141,8 @@ getSelfNumber() -> number<s>::
|
|||
Exceptions: None
|
||||
|
||||
isContactBlocked(number<s>) -> blocked<b>::
|
||||
* number : Phone number
|
||||
* blocked : true=blocked, false=not blocked
|
||||
* number : Phone number
|
||||
* blocked : true=blocked, false=not blocked
|
||||
|
||||
For unknown numbers false is returned but no exception is raised.
|
||||
|
||||
|
|
@ -416,12 +151,13 @@ Exceptions: InvalidPhoneNumber
|
|||
isRegistered() -> result<b>::
|
||||
isRegistered(number<s>) -> result<b>::
|
||||
isRegistered(numbers<as>) -> results<ab>::
|
||||
* number : Phone number
|
||||
* number : Phone number
|
||||
* numbers : String array of phone numbers
|
||||
* result : true=number is registered, false=number is not registered
|
||||
* 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).
|
||||
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
|
||||
|
||||
|
|
@ -445,11 +181,11 @@ Exceptions: Failure, InvalidNumber, UntrustedIdentity
|
|||
|
||||
sendMessage(message<s>, attachments<as>, recipient<s>) -> timestamp<x>::
|
||||
sendMessage(message<s>, attachments<as>, recipients<as>) -> timestamp<x>::
|
||||
* message : Text to send (can be UTF8)
|
||||
* 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
|
||||
* 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.
|
||||
|
||||
|
|
@ -457,65 +193,65 @@ Exceptions: AttachmentInvalid, Failure, InvalidNumber, UntrustedIdentity
|
|||
|
||||
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
|
||||
sendMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
|
||||
* 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
|
||||
* 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
|
||||
* 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
|
||||
|
||||
sendNoteToSelfMessage(message<s>, attachments<as>) -> timestamp<x>::
|
||||
* message : Text to send (can be UTF8)
|
||||
* 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
|
||||
* timestamp : Long, can be used to identify the corresponding Signal reply
|
||||
|
||||
Exceptions: Failure, AttachmentInvalid
|
||||
|
||||
sendReadReceipt(recipient<s>, targetSentTimestamps<ax>) -> <>::
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamps : Array of Longs to identify the corresponding Signal messages
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamps : Array of Longs to identify the corresponding Signal messages
|
||||
|
||||
Exceptions: Failure, UntrustedIdentity
|
||||
|
||||
sendViewedReceipt(recipient<s>, targetSentTimestamp<ax>) -> <>::
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamp : Array of Longs to identify the corresponding signal messages
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamp : Array of Longs to identify the corresponding signal messages
|
||||
|
||||
Exceptions: Failure, UntrustedIdentity
|
||||
|
||||
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipient<s>) -> timestamp<x>::
|
||||
sendRemoteDeleteMessage(targetSentTimestamp<x>, recipients<as>) -> timestamp<x>::
|
||||
* 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
|
||||
* 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
|
||||
|
||||
sendTyping(recipient<s>, stop<b>) -> <>::
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamp : True, if typing state should be stopped
|
||||
* recipient : Phone number of a single recipient
|
||||
* targetSentTimestamp : True, if typing state should be stopped
|
||||
|
||||
Exceptions: Failure, GroupNotFound, UntrustedIdentity
|
||||
|
||||
setContactBlocked(number<s>, block<b>) -> <>::
|
||||
* number : Phone number affected by method
|
||||
* block : false=remove block, true=blocked
|
||||
* 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
|
||||
|
||||
setContactName(number<s>,name<>) -> <>::
|
||||
* number : Phone number
|
||||
* name : Name to be set in contacts (in local storage with signal-cli)
|
||||
* number : Phone number
|
||||
* name : Name to be set in contacts (in local storage with signal-cli)
|
||||
|
||||
Exceptions: InvalidNumber, Failure
|
||||
|
||||
|
|
@ -530,13 +266,14 @@ deleteRecipient(number<s>) -> <>::
|
|||
Exceptions: Failure
|
||||
|
||||
setExpirationTimer(number<s>, expiration<i>) -> <>::
|
||||
* number : Phone number of recipient
|
||||
* expiration : int32 for the number of seconds before messages to this recipient disappear. Set to 0 to disable 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
|
||||
|
||||
setPin(pin<s>) -> <>::
|
||||
* pin : PIN you set after registration (resets after 7 days of inactivity)
|
||||
* pin : PIN you set after registration (resets after 7 days of inactivity)
|
||||
|
||||
Sets a registration lock PIN, to prevent others from registering your number.
|
||||
|
||||
|
|
@ -544,26 +281,26 @@ Exceptions: Failure
|
|||
|
||||
submitRateLimitChallenge(challenge<s>, captcha<s>) -> <>::
|
||||
* challenge : The challenge token taken from the proof required error.
|
||||
* captcha : The captcha token from the solved captcha on the Signal website..
|
||||
* captcha : The captcha token from the solved captcha on the Signal website.
|
||||
Can be used to lift some rate-limits by solving a captcha.
|
||||
|
||||
Exception: IOErrorException
|
||||
|
||||
updateProfile(name<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
|
||||
updateProfile(givenName<s>, familyName<s>, about<s>, aboutEmoji <s>, avatar<s>, remove<b>) -> <>::
|
||||
* 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
|
||||
* 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
|
||||
|
||||
uploadStickerPack(stickerPackPath<s>) -> url<s>::
|
||||
* stickerPackPath : Path to the manifest.json file or a zip file in the same directory
|
||||
* url : URL of sticker pack after successful upload
|
||||
* url : URL of sticker pack after successful upload
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
|
|
@ -572,28 +309,258 @@ version() -> version<s>::
|
|||
|
||||
Exceptions: None
|
||||
|
||||
==== Group related methods
|
||||
|
||||
createGroup(groupName<s>, members<as>, avatar<s>) -> groupId<ay>::
|
||||
* groupName : String representing the display name of the group
|
||||
* members : String array of new members to be invited to group
|
||||
* avatar : Filename of avatar picture to be set for group (empty if none)
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
|
||||
Exceptions: AttachmentInvalid, Failure, InvalidNumber;
|
||||
|
||||
getGroup(groupId<ay>) -> objectPath<o>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* objectPath : DBusPath for the group
|
||||
|
||||
getGroupMembers(groupId<ay>) -> members<as>::
|
||||
* groupId : Byte array representing the internal group identifier
|
||||
* members : String array with the phone numbers of all active members of a group
|
||||
|
||||
Exceptions: None, if the group name is not found an empty array is returned
|
||||
|
||||
joinGroup(inviteURI<s>) -> <>::
|
||||
* inviteURI : String starting with https://signal.group/#
|
||||
|
||||
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.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
listGroups() -> groups<a(oays)>::
|
||||
* groups : Array of Structs(objectPath, groupId, groupName)
|
||||
** objectPath : DBusPath
|
||||
** groupId : Byte array representing the internal group identifier
|
||||
** groupName : String representing the display name of the group
|
||||
|
||||
sendGroupMessage(message<s>, attachments<as>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
sendGroupMessageReaction(emoji<s>, remove<b>, targetAuthor<s>, targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
sendGroupRemoteDeleteMessage(targetSentTimestamp<x>, groupId<ay>) -> timestamp<x>::
|
||||
* 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
|
||||
|
||||
==== Device related methods
|
||||
|
||||
addDevice(deviceUri<s>) -> <>::
|
||||
* 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.
|
||||
|
||||
getDevice(deviceId<x>) -> devicePath<o>::
|
||||
* deviceId : Long representing a deviceId
|
||||
* devicePath : DBusPath object for the device
|
||||
|
||||
Exceptions: DeviceNotFound
|
||||
|
||||
listDevices() -> devices<a(oxs)>::
|
||||
* devices : Array of structs (objectPath, id, name)
|
||||
** objectPath : DBusPath representing the device's object path
|
||||
** id : Long representing the deviceId
|
||||
** name : String representing the device's name
|
||||
|
||||
Exceptions: InvalidUri
|
||||
|
||||
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
|
||||
|
||||
=== Signal.Group interface
|
||||
|
||||
The following methods listen to the group's object path, which can be obtained from the listGroups() method and is constructed as follows:
|
||||
|
||||
<ACCOUNT_PATH> + "/Groups/" + DBusGroupId
|
||||
|
||||
DBusGroupId : groupId in base64 format, with underscore (_) replacing plus (+), equals (=), or slash (/)
|
||||
|
||||
Groups have the following (case-sensitive) properties:
|
||||
|
||||
* Id<ay> (read-only) : Byte array representing the internal group identifier
|
||||
* Name<s> : Display name of the group
|
||||
* Description<s> : Description of the group
|
||||
* Avatar<s> (write-only) : Filename of the avatar
|
||||
* IsBlocked<b> : true=member will not receive group messages; false=not blocked
|
||||
* IsMember<b> (read-only) : always true (object path exists only for group members)
|
||||
* IsAdmin<b> (read-only) : true=member has admin privileges; false=not admin
|
||||
* MessageExpirationTimer<i> : int32 representing message expiration time for group
|
||||
* Members<as> (read-only) : String array of group members' phone numbers
|
||||
* PendingMembers<as> (read-only) : String array of pending members' phone numbers
|
||||
* RequestingMembers<as> (read-only) : String array of requesting members' phone numbers
|
||||
* Admins<as> (read-only) : String array of admins' phone numbers
|
||||
* PermissionAddMember<s> : String representing who has permission to add members *ONLY_ADMINS, EVERY_MEMBER*
|
||||
* PermissionEditDetails<s> : String representing who may edit group details *ONLY_ADMINS, EVERY_MEMBER*
|
||||
* PermissionSendMessage<s> : String representing who post messages to group *ONLY_ADMINS, EVERY_MEMBER* (note that ONLY_ADMINS is equivalent to IsAnnouncementGroup)
|
||||
* GroupInviteLink<s> (read-only) : String of the invitation link (starts with https://signal.group/#)
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Group string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Group`
|
||||
|
||||
addAdmins(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Grant admin privileges to recipients.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
addMembers(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Add recipients to group if they are pending members; otherwise add recipients to list of requesting members.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
disableLink() -> <>::
|
||||
|
||||
Disables the group's invitation link.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
enableLink(requiresApproval<b>) -> <>::
|
||||
* requiresApproval : true=add numbers using the link to the requesting members list
|
||||
|
||||
Enables the group's invitation link.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
quitGroup() -> <>::
|
||||
Exceptions: Failure, LastGroupAdmin
|
||||
|
||||
removeAdmins(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Remove admin privileges from recipients.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
removeMembers(recipients<as>) -> <>::
|
||||
* recipients : String array of phone numbers
|
||||
|
||||
Remove recipients from group.
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
resetLink() -> <>::
|
||||
|
||||
Resets the group's invitation link to a new random URL starting with https://signal.group/#
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Signal.Device interface
|
||||
|
||||
The following methods listen to the device's object path, which is constructed as follows:
|
||||
|
||||
<ACCOUNT_PATH> + "/Devices/" + deviceId
|
||||
|
||||
deviceId : Number representing the device identifier (obtained from listDevices() method)
|
||||
|
||||
Devices have the following (case-sensitive) properties:
|
||||
|
||||
* Id<x> (read-only) : Long representing the device identifier
|
||||
* Created<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
|
||||
* LastSeen<x> (read-only) : Long representing the number of milliseconds since the Unix epoch
|
||||
* Name<s> : String representing the display name of the device
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Device string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Device`
|
||||
|
||||
removeDevice() -> <>::
|
||||
|
||||
Exceptions: Failure
|
||||
|
||||
=== Signal.Configuration interface
|
||||
|
||||
The configuration's object path, which exists only for primary devices, is constructed as follows:
|
||||
<ACCOUNT_PATH> + "/Configuration"
|
||||
|
||||
Configurations have the following (case-sensitive) properties:
|
||||
|
||||
* ReadReceipts<b> : should send read receipts (true/false)
|
||||
* UnidentifiedDeliveryIndicators<b> : should show unidentified delivery indicators (true/false)
|
||||
* TypingIndicators<b> : should send/show typing indicators (true/false)
|
||||
* LinkPreviews<b> : should generate link previews (true/false)
|
||||
|
||||
To get a property, use (replacing `--session` with `--system` if needed):
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.Get string:org.asamk.Signal.Configuration string:$PROPERTY_NAME`
|
||||
|
||||
To set a property, use:
|
||||
`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`
|
||||
|
||||
To get all properties, use:
|
||||
`dbus-send --session --dest=org.asamk.Signal --print-reply $OBJECT_PATH org.freedesktop.DBus.Properties.GetAll string:org.asamk.Signal.Configuration`
|
||||
|
||||
== Signals
|
||||
|
||||
SyncMessageReceived (timestamp<x>, sender<s>, destination<s>, groupId<ay>, message<s>, attachments<as>)::
|
||||
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
|
||||
* sender : Phone number of the sender
|
||||
* 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
|
||||
* 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<x>, sender<s>)::
|
||||
* timestamp : Integer value that can be used to associate this e.g. with a sendMessage()
|
||||
* sender : Phone number of the sender
|
||||
* 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<x>, sender<s>, groupId<ay>, message<s>, attachments<as>)::
|
||||
* 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
|
||||
* 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
|
||||
|
|
@ -604,7 +571,7 @@ 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
|
||||
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
|
||||
|
||||
Print the group name corresponding to a groupId; the daemon runs on system bus, and was started without an explicit `-a ACCOUNT`::
|
||||
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
|
||||
|
|
|
|||
95
man/signal-cli-jsonrpc.5.adoc
Normal file
95
man/signal-cli-jsonrpc.5.adoc
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
/////
|
||||
vim:set ts=4 sw=4 tw=82 noet:
|
||||
/////
|
||||
|
||||
:quotes.~:
|
||||
|
||||
= signal-cli-jsonrpc (5)
|
||||
|
||||
== Name
|
||||
|
||||
JSON-RPC API for signal-cli - A commandline and dbus interface for the Signal messenger
|
||||
|
||||
== Synopsis
|
||||
|
||||
*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] daemon [--socket] [--tcp]
|
||||
|
||||
*signal-cli* [--verbose] [--config CONFIG] [-a ACCOUNT] jsonRpc
|
||||
|
||||
== Description
|
||||
|
||||
See signal-cli (1) for details on the application.
|
||||
|
||||
signal-cli provides a JSON-RPC based API with the `jsonRpc` and `daemon` commands.
|
||||
|
||||
- `jsonRpc` command accepts input on STDIN and responds on STDOUT.
|
||||
This is intended to make it easier to embed signal-cli in other applications.
|
||||
|
||||
`signal-cli -a _ACCOUNT_ jsonRpc`
|
||||
|
||||
- `daemon` command provides a UNIX or TCP socket and can handle requests from multiple clients.
|
||||
|
||||
`signal-cli -a _ACCOUNT_ daemon --socket` or for multi-account mode `signal-cli daemon --socket`
|
||||
|
||||
== Basic usage
|
||||
|
||||
In JSON-RPC mode, signal-cli will read requests from stdin.
|
||||
Every requests must be a JSON object in a single line.
|
||||
Requests must have a unique "id" value to be able to match the response to the corresponding request.
|
||||
|
||||
Example:
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"my special mark"}`
|
||||
|
||||
RESPONSE: `{"jsonrpc":"2.0","result":[{"id":"Pmpi+EfPWmsxiomLe9Nx2XF9HOE483p6iKiFj65iMwI=","name":"My Group","description":"It's special because it is mine.","isMember":true,"isBlocked":false,"members":["+33123456789","+440123456789"],"pendingMembers":[],"requestingMembers":[],"admins":["+33123456789","+440123456789"],"groupInviteLink":"https://signal.group/#CjQKIAtcbUw482i7bqvmJCwdgvg0FMif52N5v9lGg_bE4U3zEhCjHKSaPzWImMpnCbU8A1r0"}],"id":"my special mark"}`
|
||||
|
||||
From the command line:
|
||||
|
||||
`echo '{"jsonrpc":"2.0","method":"listGroups","id":"my special mark"}' | signal-cli -u +33123456789 jsonRpc`
|
||||
|
||||
Like in dbus daemon mode, messages are automatically received in jsonRpc mode.
|
||||
Incoming messages are sent as JSON-RPC notifications.
|
||||
|
||||
Example:
|
||||
|
||||
`{"jsonrpc":"2.0","method":"receive","params":{"envelope":{"source":"+33123456789","sourceNumber":"+33123456789","sourceUuid":"uuid","sourceName":"name","sourceDevice":1,"timestamp":1631458508784,"dataMessage":{"timestamp":1631458508784,"message":"foobar","expiresInSeconds":0,"viewOnce":false,"mentions":[],"attachments":[],"contacts":[]}}}}`
|
||||
|
||||
=== Multi-account daemon mode
|
||||
When the daemon command is started without an account parameter (-a), signal-cli will provide all local accounts and additional commands to register and link new accounts.
|
||||
|
||||
In multi-account mode, requests for a single account require an additional `account` param.
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"my special mark","params":{"account":"+33123456789"}}`
|
||||
|
||||
== Commands
|
||||
|
||||
The commands available for the JSON-RPC mode are the same as the cli commands (except `register`, `verify` and `link`).
|
||||
The `method` field is the command name and the parameters can be sent as the `params` object.
|
||||
|
||||
- Parameter names are provided in camelCase format instead of the hyphen format on the cli.
|
||||
|
||||
e.g.: `--group-id=ID` on the cli becomes `"groupId":"ID"`
|
||||
|
||||
- Parameters that can take multiple values on the command line can be provided as single json value or as json array
|
||||
|
||||
e.g. `--attachment ATTACH1 ATTACH2` becomes `"attachments":["ATTACH1", "ATTACH2"]`
|
||||
|
||||
`--attachment ATTACH` becomes `"attachment":"ATTACH"`
|
||||
|
||||
== Examples
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"listGroups","id":"5"}` RESPONSE: `{"jsonrpc":"2.0","result":[...],"id":"5"}`
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"send","params":{"recipient":["+YYY"],"message":"MESSAGE"},"id":4}` RESPONSE: `{"jsonrpc":"2.0","result":{"timestamp":999},"id":4}`
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"updateGroup","params":{"groupId":"GROUP_ID=","name":"new group name","members":["+ZZZ"],"link":"enabledWithApproval","setPermissionEditDetails":"only-admins"},"id":"someId"}` RESPONSE: `{"jsonrpc":"2.0","result":{"timestamp":9999},"id":"someId"}`
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0","method":"sendSyncRequest","id":9}` RESPONSE: `{"jsonrpc":"2.0","result":{},"id":9}`
|
||||
|
||||
REQUEST: `{"jsonrpc":"2.0"}` RESPONSE: `{"jsonrpc":"2.0","error":{"code":-32600,"message":"method field must be set","data":null},"id":null}`
|
||||
|
||||
== Authors
|
||||
|
||||
Maintained by AsamK <asamk@gmx.de>, who is assisted by other open source contributors.
|
||||
For more information about signal-cli development, see
|
||||
<https://github.com/AsamK/signal-cli>.
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
/////
|
||||
vim:set ts=4 sw=4 tw=82 noet:
|
||||
/////
|
||||
|
||||
:quotes.~:
|
||||
|
||||
= signal-cli (1)
|
||||
|
|
@ -22,7 +23,8 @@ signal-cli was primarily developed to be used on servers to notify admins of imp
|
|||
For this use-case, it has a dbus interface, that can be used to send messages from any programming language that has dbus bindings.
|
||||
|
||||
For some functionality the Signal protocol requires that all messages have been received from the server.
|
||||
The `receive` command should be regularly executed. In daemon mode messages are continuously received.
|
||||
The `receive` command should be regularly executed.
|
||||
In daemon mode messages are continuously received.
|
||||
|
||||
== Options
|
||||
|
||||
|
|
@ -46,8 +48,7 @@ The phone number must include the country calling code, i.e. the number must sta
|
|||
|
||||
This flag must not be given for the `link` command.
|
||||
It is optional for the `daemon` command.
|
||||
For all other commands it is only optional if there is exactly one local user in the
|
||||
config directory.
|
||||
For all other commands it is only optional if there is exactly one local user in the config directory.
|
||||
|
||||
*--dbus*::
|
||||
Make request via user dbus.
|
||||
|
|
@ -56,12 +57,12 @@ Make request via user dbus.
|
|||
Make request via system dbus.
|
||||
|
||||
*-o* OUTPUT-MODE, *--output* OUTPUT-MODE::
|
||||
Specify if you want commands to output in either "plain-text" mode or in "json". Defaults to "plain-text"
|
||||
Specify if you want commands to output in either "plain-text" mode or in "json".
|
||||
Defaults to "plain-text"
|
||||
|
||||
*--trust-new-identities* TRUST-MODE::
|
||||
Choose when to trust new identities:
|
||||
- `on-first-use` (default): Trust the first seen identity key from new users,
|
||||
changed keys must be verified manually
|
||||
- `on-first-use` (default): Trust the first seen identity key from new users, changed keys must be verified manually
|
||||
- `always`: Trust any new identity key without verification
|
||||
- `never`: Don't trust any unknown identity key, every key must be verified manually
|
||||
|
||||
|
|
@ -78,8 +79,7 @@ The verification should be done over voice, not SMS.
|
|||
*--captcha*::
|
||||
The captcha token, required if registration failed with a captcha required error.
|
||||
To get the token, go to https://signalcaptchas.org/registration/generate.html
|
||||
Check the developer tools for a redirect starting with signalcaptcha://
|
||||
Everything after signalcaptcha:// is the captcha token.
|
||||
Check the developer tools for a redirect starting with signalcaptcha:// Everything after signalcaptcha:// is the captcha token.
|
||||
|
||||
=== verify
|
||||
|
||||
|
|
@ -100,8 +100,9 @@ Use "updateAccount" to undo this.
|
|||
To remove a linked device, use "removeDevice" from the master device.
|
||||
|
||||
*--delete-account*::
|
||||
Delete account completely from server. Cannot be undone without loss. You will
|
||||
have to be readded to each group.
|
||||
Delete account completely from server.
|
||||
Cannot be undone without loss.
|
||||
You will have to be readded to each group.
|
||||
|
||||
CAUTION: Only delete your account if you won't use this number again!
|
||||
|
||||
|
|
@ -144,7 +145,8 @@ Remove the registration lock pin.
|
|||
=== link
|
||||
|
||||
Link to an existing device, instead of registering a new number.
|
||||
This shows a "sgnl://linkdevice?uuid=..." URI. If you want to connect to another signal-cli instance, you can just use this URI.
|
||||
This shows a "sgnl://linkdevice?uuid=..." URI.
|
||||
If you want to connect to another signal-cli instance, you can just use this URI.
|
||||
If you want to link to an Android/iOS device, create a QR code with the URI (e.g. with qrencode) and scan that in the Signal app.
|
||||
|
||||
*-n* NAME, *--name* NAME::
|
||||
|
|
@ -158,8 +160,7 @@ Only works, if this is the master device.
|
|||
|
||||
*--uri* URI::
|
||||
Specify the uri contained in the QR code shown by the new device.
|
||||
You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...")
|
||||
Make sure to enclose it in quotation marks for shells.
|
||||
You will need the full URI such as "sgnl://linkdevice?uuid=..." (formerly "tsdevice:/?uuid=...") Make sure to enclose it in quotation marks for shells.
|
||||
|
||||
=== listDevices
|
||||
|
||||
|
|
@ -206,13 +207,11 @@ Send the message to self without notification.
|
|||
Clear session state and send end session message.
|
||||
|
||||
*--mention*::
|
||||
Mention another group member (syntax: start:length:recipientNumber)
|
||||
In the apps the mention replaces part of the message text, which is specified by the start and length values.
|
||||
Mention another group member (syntax: start:length:recipientNumber) In the apps the mention replaces part of the message text, which is specified by the start and length values.
|
||||
e.g.: `-m "Hi X!" --mention "3:1:+123456789"`
|
||||
|
||||
*--quote-timestamp*::
|
||||
Specify the timestamp of a previous message with the recipient or group to add a
|
||||
quote to the new message.
|
||||
Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.
|
||||
|
||||
*--quote-author*::
|
||||
Specify the number of the author of the original message.
|
||||
|
|
@ -398,15 +397,13 @@ Trust all known keys of this user, only use this for testing.
|
|||
|
||||
*-v* VERIFIED_SAFETY_NUMBER, *--verified-safety-number* VERIFIED_SAFETY_NUMBER::
|
||||
Specify the safety number of the key, only use this option if you have verified the safety number.
|
||||
Can be either the plain text numbers shown in the app or the bytes from the QR-code,
|
||||
encoded as base64.
|
||||
Can be either the plain text numbers shown in the app or the bytes from the QR-code, encoded as base64.
|
||||
|
||||
=== updateProfile
|
||||
|
||||
Update the profile information shown to message recipients.
|
||||
The profile is stored encrypted on the Signal servers.
|
||||
The decryption key is sent with every outgoing messages to contacts and included
|
||||
in every group.
|
||||
The decryption key is sent with every outgoing messages to contacts and included in every group.
|
||||
|
||||
*--given-name* NAME, *--name* NAME::
|
||||
New (given) name.
|
||||
|
|
@ -443,6 +440,7 @@ Set expiration time of messages (seconds).
|
|||
To disable expiration set expiration time to 0.
|
||||
|
||||
=== removeContact
|
||||
|
||||
Remove the info of a given contact
|
||||
|
||||
NUMBER::
|
||||
|
|
@ -481,13 +479,13 @@ This command should only be used if this is the master device.
|
|||
=== sendSyncRequest
|
||||
|
||||
Send a synchronization request message to the master device (for group, contacts, ...).
|
||||
The master device will respond with synchronization messages with full contact and
|
||||
group lists.
|
||||
The master device will respond with synchronization messages with full contact and group lists.
|
||||
|
||||
=== uploadStickerPack
|
||||
|
||||
Upload a new sticker pack, consisting of a manifest file and the sticker images.
|
||||
Images must conform to the following specification: (see https://support.signal.org/hc/en-us/articles/360031836512-Stickers#sticker_reqs )
|
||||
|
||||
- Static stickers in PNG or WebP format
|
||||
- Animated stickers in APNG format,
|
||||
- Maximum file size for a sticker file is 300KiB
|
||||
|
|
@ -521,15 +519,34 @@ The path of the manifest.json or a zip file containing the sticker pack you wish
|
|||
|
||||
=== daemon
|
||||
|
||||
signal-cli can run in daemon mode and provides an experimental dbus interface.
|
||||
If no `-a` account is given, all local accounts will be exported as separate dbus
|
||||
objects under the same bus name.
|
||||
signal-cli can run in daemon mode and provides an experimental dbus or JSON-RPC interface.
|
||||
If no `-a` account is given, all local accounts will be exported as separate dbus objects under the same bus name.
|
||||
|
||||
*--dbus*::
|
||||
Export DBus interface on user bus.
|
||||
See signal-cli-dbus (5) for info on the dbus interface.
|
||||
|
||||
*--dbus-system*::
|
||||
Export DBus interface on system bus.
|
||||
See signal-cli-dbus (5) for info on the dbus interface.
|
||||
|
||||
*--socket [SOCKET]*::
|
||||
Export a JSON-RPC interface on a UNIX socket (default $XDG_RUNTIME_DIR/signal-cli/socket).
|
||||
See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
|
||||
|
||||
*--tcp [HOST:PORT]*::
|
||||
Export a JSON-RPC interface on a TCP socket (default localhost:7583).
|
||||
See signal-cli-jsonrpc (5) for info on the JSON-RPC interface.
|
||||
|
||||
*--system*::
|
||||
Use DBus system bus instead of user bus.
|
||||
*--ignore-attachments*::
|
||||
Don’t download attachments of received messages.
|
||||
|
||||
*--no-receive-stdout*::
|
||||
Don’t print received messages to stdout.
|
||||
|
||||
*--receive-mode*::
|
||||
Specify when to start receiving messages (on-start, on-connection, manual)
|
||||
|
||||
== Examples
|
||||
|
||||
Register a number (with SMS verification)::
|
||||
|
|
@ -566,6 +583,7 @@ Trust new key, without having verified it. Only use this if you don't care about
|
|||
signal-cli -a ACCOUNT trust -a NUMBER
|
||||
|
||||
== Exit codes
|
||||
|
||||
* *1*: Error is probably caused and fixable by the user
|
||||
* *2*: Some unexpected error
|
||||
* *3*: Server or IO error
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue