2023-01-03 19:55:46 +00:00
// Copyright 2014 Signal Messenger, LLC
2021-07-20 20:18:35 +00:00
// SPDX-License-Identifier: AGPL-3.0-only
2018-02-15 19:59:46 +00:00
// Source: https://github.com/signalapp/libsignal-service-java/blob/4684a49b2ed8f32be619e0d0eea423626b6cb2cb/protobuf/SignalService.proto
package signalservice ;
2014-01-15 07:46:05 +00:00
2018-02-15 19:59:46 +00:00
option java_package = "org.whispersystems.signalservice.internal.push" ;
option java_outer_classname = "SignalServiceProtos" ;
2014-01-15 07:46:05 +00:00
2015-06-01 21:08:21 +00:00
message Envelope {
2014-03-12 19:52:19 +00:00
enum Type {
2018-10-18 01:01:21 +00:00
UNKNOWN = 0 ;
CIPHERTEXT = 1 ;
KEY_EXCHANGE = 2 ;
PREKEY_BUNDLE = 3 ;
RECEIPT = 5 ;
UNIDENTIFIED_SENDER = 6 ;
2021-05-28 19:11:19 +00:00
// Our parser does not handle reserved in enums: DESKTOP-1569
// reserved 7;
PLAINTEXT_CONTENT = 8 ;
2014-03-12 19:52:19 +00:00
}
2018-10-18 01:01:21 +00:00
optional Type type = 1 ;
2023-08-10 16:43:33 +00:00
optional string sourceServiceId = 11 ;
2018-10-18 01:01:21 +00:00
optional uint32 sourceDevice = 7 ;
2023-08-10 16:43:33 +00:00
optional string destinationServiceId = 13 ;
2022-03-31 03:07:55 +00:00
// reserved 3; // formerly optional string relay = 3;
2018-10-18 01:01:21 +00:00
optional uint64 timestamp = 5 ;
2022-03-31 03:07:55 +00:00
// reserved 6; // formerly optional bytes legacyMessage = 6;
2018-10-18 01:01:21 +00:00
optional bytes content = 8 ; // Contains an encrypted Content
optional string serverGuid = 9 ;
optional uint64 serverTimestamp = 10 ;
2022-07-01 16:55:13 +00:00
optional bool ephemeral = 12 ; // indicates that the message should not be persisted if the recipient is offline
optional bool urgent = 14 [ default = true ] ; // indicates that the content is considered timely by the sender; defaults to true so senders have to opt-out to say something isn't time critical
2022-07-28 16:35:29 +00:00
optional string updated_pni = 15 ;
2022-10-07 17:02:08 +00:00
optional bool story = 16 ; // indicates that the content is a story.
2023-02-08 00:55:12 +00:00
optional bytes reporting_token = 17 ;
// next: 18
2015-06-01 21:08:21 +00:00
}
2014-03-12 19:52:19 +00:00
2015-06-01 21:08:21 +00:00
message Content {
2022-08-15 21:53:33 +00:00
optional DataMessage dataMessage = 1 ;
optional SyncMessage syncMessage = 2 ;
optional CallingMessage callingMessage = 3 ;
optional NullMessage nullMessage = 4 ;
optional ReceiptMessage receiptMessage = 5 ;
optional TypingMessage typingMessage = 6 ;
optional bytes senderKeyDistributionMessage = 7 ;
optional bytes decryptionErrorMessage = 8 ;
optional StoryMessage storyMessage = 9 ;
optional PniSignatureMessage pniSignatureMessage = 10 ;
2023-03-27 23:48:57 +00:00
optional EditMessage editMessage = 11 ;
Feature: Blue check marks for read messages if opted in (#1489)
* Refactor delivery receipt event handler
* Rename the delivery receipt event
For less ambiguity with read receipts.
* Rename synced read event
For less ambiguity with read receipts from other Signal users.
* Add support for incoming receipt messages
Handle ReceiptMessages, which may include encrypted delivery receipts or read
receipts from recipients of our sent messages.
// FREEBIE
* Rename ReadReceipts to ReadSyncs
* Render read messages with blue double checks
* Send read receipts to senders of incoming messages
// FREEBIE
* Move ReadSyncs to their own file
// FREEBIE
* Fixup old comments on read receipts (now read syncs)
And some variable renaming for extra clarity.
// FREEBIE
* Add global setting for read receipts
Don't send read receipt messages unless the setting is enabled.
Don't process read receipts if the setting is disabled.
// FREEBIE
* Sync read receipt setting from mobile
Toggling this setting on your mobile device should sync it to Desktop. When
linking, use the setting in the provisioning message.
// FREEBIE
* Send receipt messages silently
Avoid generating phantom messages on ios
// FREEBIE
* Save recipients on the outgoing message models
For accurate tracking and display of sent/delivered/read state, even if group
membership changes later.
// FREEBIE
* Fix conversation type in profile key update handling
// FREEBIE
* Set recipients on synced sent messages
* Render saved recipients in message detail if available
For older messages, where we did not save the intended set of recipients at the
time of sending, fall back to the current group membership.
// FREEBIE
* Record who has been successfully sent to
// FREEBIE
* Record who a message has been delivered to
* Invert the not-clickable class
* Fix readReceipt setting sync when linking
* Render per recipient sent/delivered/read status
In the message detail view for outgoing messages, render each recipient's
individual sent/delivered/read status with respect to this message, as long as
there are no errors associated with the recipient (ie, safety number changes,
user not registered, etc...) since the error icon is displayed in that case.
*Messages sent before this change may not have per-recipient status lists
and will simply show no status icon.
// FREEBIE
* Add configuration sync request
Send these requests in a one-off fashion when:
1. We have just setup from a chrome app import
2. We have just upgraded to read-receipt support
// FREEBIE
* Expose sendRequestConfigurationSyncMessage
// FREEBIE
* Fix handling of incoming delivery receipts - union with array
FREEBIE
2017-10-04 22:28:43 +00:00
}
2020-06-04 18:16:19 +00:00
message CallingMessage {
2017-02-22 18:20:54 +00:00
message Offer {
2020-06-04 18:16:19 +00:00
enum Type {
2020-07-29 16:29:57 +00:00
OFFER_AUDIO_CALL = 0 ;
OFFER_VIDEO_CALL = 1 ;
2020-06-04 18:16:19 +00:00
}
optional uint64 callId = 1 ;
2024-01-09 23:36:10 +00:00
reserved /* sdp */ 2 ;
2020-07-29 16:29:57 +00:00
optional Type type = 3 ;
optional bytes opaque = 4 ;
2017-02-22 18:20:54 +00:00
}
message Answer {
2020-07-29 16:29:57 +00:00
optional uint64 callId = 1 ;
2024-01-09 23:36:10 +00:00
reserved /* sdp */ 2 ;
2020-07-29 16:29:57 +00:00
optional bytes opaque = 3 ;
2017-02-22 18:20:54 +00:00
}
2020-06-04 18:16:19 +00:00
message IceCandidate {
2020-07-29 16:29:57 +00:00
optional uint64 callId = 1 ;
2024-01-09 23:36:10 +00:00
reserved /* mid */ 2 ;
reserved /* line */ 3 ;
reserved /* sdp */ 4 ;
2020-07-29 16:29:57 +00:00
optional bytes opaque = 5 ;
2017-02-22 18:20:54 +00:00
}
message Busy {
2020-06-04 18:16:19 +00:00
optional uint64 callId = 1 ;
2017-02-22 18:20:54 +00:00
}
message Hangup {
2020-06-04 18:16:19 +00:00
enum Type {
2020-07-07 00:37:43 +00:00
HANGUP_NORMAL = 0 ;
HANGUP_ACCEPTED = 1 ;
HANGUP_DECLINED = 2 ;
HANGUP_BUSY = 3 ;
HANGUP_NEED_PERMISSION = 4 ;
2020-06-04 18:16:19 +00:00
}
2017-02-22 18:20:54 +00:00
2020-06-04 18:16:19 +00:00
optional uint64 callId = 1 ;
optional Type type = 2 ;
optional uint32 deviceId = 3 ;
}
2017-02-22 18:20:54 +00:00
2020-11-13 19:57:55 +00:00
message Opaque {
2021-08-20 16:06:15 +00:00
enum Urgency {
DROPPABLE = 0 ;
HANDLE_IMMEDIATELY = 1 ;
}
optional bytes data = 1 ;
optional Urgency urgency = 2 ;
2020-11-13 19:57:55 +00:00
}
2020-06-04 18:16:19 +00:00
optional Offer offer = 1 ;
optional Answer answer = 2 ;
repeated IceCandidate iceCandidates = 3 ;
2024-01-09 23:36:10 +00:00
reserved /* legacyHangup */ 4 ;
2020-06-04 18:16:19 +00:00
optional Busy busy = 5 ;
2024-01-09 23:36:10 +00:00
reserved /* profileKey */ 6 ;
2020-06-04 18:16:19 +00:00
optional Hangup hangup = 7 ;
2024-01-09 23:36:10 +00:00
reserved /* multiRing */ 8 ;
2020-06-04 18:16:19 +00:00
optional uint32 destinationDeviceId = 9 ;
2020-11-13 19:57:55 +00:00
optional Opaque opaque = 10 ;
2015-06-01 21:08:21 +00:00
}
2015-02-13 01:42:07 +00:00
2015-06-01 21:08:21 +00:00
message DataMessage {
2014-03-12 19:52:19 +00:00
enum Flags {
2018-02-15 19:59:46 +00:00
END_SESSION = 1 ;
2016-09-20 21:36:57 +00:00
EXPIRATION_TIMER_UPDATE = 2 ;
2017-09-11 16:50:35 +00:00
PROFILE_KEY_UPDATE = 4 ;
2014-01-15 07:46:05 +00:00
}
2022-11-30 21:47:54 +00:00
message Payment {
message Amount {
message MobileCoin {
optional uint64 picoMob = 1 ; // 1,000,000,000,000 picoMob per Mob
}
oneof Amount {
MobileCoin mobileCoin = 1 ;
}
}
message RequestId {
optional string uuid = 1 ;
}
message Request {
optional RequestId requestId = 1 ;
optional Amount amount = 2 ;
optional string note = 3 ;
}
message Notification {
message MobileCoin {
optional bytes receipt = 1 ;
}
oneof Transaction {
MobileCoin mobileCoin = 1 ;
}
// Optional, Refers to the PaymentRequest message, if any.
optional string note = 2 ;
optional RequestId requestId = 1003 ;
}
message Cancellation {
optional RequestId requestId = 1 ;
}
message Activation {
enum Type {
REQUEST = 0 ;
ACTIVATED = 1 ;
}
optional Type type = 1 ;
}
oneof Item {
Notification notification = 1 ;
Activation activation = 2 ;
Request request = 1002 ;
Cancellation cancellation = 1003 ;
}
}
2018-04-06 21:59:26 +00:00
message Quote {
2022-05-11 20:59:58 +00:00
enum Type {
NORMAL = 0 ;
GIFT_BADGE = 1 ;
}
2018-04-06 21:59:26 +00:00
message QuotedAttachment {
optional string contentType = 1 ;
optional string fileName = 2 ;
optional AttachmentPointer thumbnail = 3 ;
}
optional uint64 id = 1 ;
2021-04-05 20:39:38 +00:00
reserved /* author */ 2 ; // removed
2023-08-10 16:43:33 +00:00
optional string authorAci = 5 ;
2018-04-06 21:59:26 +00:00
optional string text = 3 ;
repeated QuotedAttachment attachments = 4 ;
2020-09-16 22:42:48 +00:00
repeated BodyRange bodyRanges = 6 ;
2022-05-11 20:59:58 +00:00
optional Type type = 7 ;
2018-04-06 21:59:26 +00:00
}
2018-04-27 16:32:31 +00:00
message Contact {
message Name {
optional string givenName = 1 ;
optional string familyName = 2 ;
optional string prefix = 3 ;
optional string suffix = 4 ;
optional string middleName = 5 ;
2024-10-01 21:46:56 +00:00
reserved /* displayName */ 6 ;
optional string nickname = 7 ;
2018-04-27 16:32:31 +00:00
}
message Phone {
enum Type {
HOME = 1 ;
MOBILE = 2 ;
WORK = 3 ;
CUSTOM = 4 ;
}
optional string value = 1 ;
optional Type type = 2 ;
optional string label = 3 ;
}
message Email {
enum Type {
HOME = 1 ;
MOBILE = 2 ;
WORK = 3 ;
CUSTOM = 4 ;
}
optional string value = 1 ;
optional Type type = 2 ;
optional string label = 3 ;
}
message PostalAddress {
enum Type {
HOME = 1 ;
WORK = 2 ;
CUSTOM = 3 ;
}
optional Type type = 1 ;
optional string label = 2 ;
optional string street = 3 ;
optional string pobox = 4 ;
optional string neighborhood = 5 ;
optional string city = 6 ;
optional string region = 7 ;
optional string postcode = 8 ;
optional string country = 9 ;
}
message Avatar {
optional AttachmentPointer avatar = 1 ;
optional bool isProfile = 2 ;
}
optional Name name = 1 ;
repeated Phone number = 3 ;
repeated Email email = 4 ;
repeated PostalAddress address = 5 ;
optional Avatar avatar = 6 ;
optional string organization = 7 ;
}
2019-01-16 03:03:56 +00:00
message Preview {
optional string url = 1 ;
optional string title = 2 ;
optional AttachmentPointer image = 3 ;
2020-08-29 01:27:45 +00:00
optional string description = 4 ;
optional uint64 date = 5 ;
2019-01-16 03:03:56 +00:00
}
2019-05-16 22:32:11 +00:00
message Sticker {
2020-07-07 00:56:56 +00:00
optional bytes packId = 1 ;
optional bytes packKey = 2 ;
optional uint32 stickerId = 3 ;
optional AttachmentPointer data = 4 ;
2021-10-05 22:10:08 +00:00
optional string emoji = 5 ;
2019-05-16 22:32:11 +00:00
}
2019-12-16 17:45:57 +00:00
message Reaction {
optional string emoji = 1 ;
optional bool remove = 2 ;
2021-03-31 19:48:10 +00:00
reserved /* targetAuthorE164 */ 3 ; // removed
2023-08-10 16:43:33 +00:00
optional string targetAuthorAci = 4 ;
2019-12-16 17:45:57 +00:00
optional uint64 targetTimestamp = 5 ;
}
2020-04-29 21:24:12 +00:00
message Delete {
optional uint64 targetSentTimestamp = 1 ;
}
2020-09-16 22:42:48 +00:00
message BodyRange {
2023-04-10 16:31:45 +00:00
enum Style {
NONE = 0 ;
BOLD = 1 ;
ITALIC = 2 ;
SPOILER = 3 ;
STRIKETHROUGH = 4 ;
MONOSPACE = 5 ;
}
2023-07-26 17:49:27 +00:00
2023-04-10 16:31:45 +00:00
optional uint32 start = 1 ;
2020-09-16 22:42:48 +00:00
optional uint32 length = 2 ;
2023-07-26 17:49:27 +00:00
2023-04-10 16:31:45 +00:00
oneof associatedValue {
2023-08-10 16:43:33 +00:00
string mentionAci = 3 ;
2023-04-10 16:31:45 +00:00
Style style = 4 ;
}
2020-09-16 22:42:48 +00:00
}
2020-11-16 19:58:54 +00:00
message GroupCallUpdate {
2020-12-02 01:49:08 +00:00
optional string eraId = 1 ;
2020-11-16 19:58:54 +00:00
}
2021-11-16 01:20:09 +00:00
message StoryContext {
2023-08-10 16:43:33 +00:00
optional string authorAci = 1 ;
2021-11-16 01:20:09 +00:00
optional uint64 sentTimestamp = 2 ;
}
2019-06-10 21:40:02 +00:00
enum ProtocolVersion {
option allow_alias = true ;
2021-10-27 22:18:25 +00:00
INITIAL = 0 ;
MESSAGE_TIMERS = 1 ;
VIEW_ONCE = 2 ;
VIEW_ONCE_VIDEO = 3 ;
REACTIONS = 4 ;
2020-04-17 22:51:39 +00:00
CDN_SELECTOR_ATTACHMENTS = 5 ;
2021-10-27 22:18:25 +00:00
MENTIONS = 6 ;
PAYMENTS = 7 ;
CURRENT = 7 ;
2019-06-10 21:40:02 +00:00
}
2022-05-11 20:59:58 +00:00
message GiftBadge {
optional bytes receiptCredentialPresentation = 1 ;
}
2019-06-10 21:40:02 +00:00
optional string body = 1 ;
repeated AttachmentPointer attachments = 2 ;
2023-04-15 00:52:50 +00:00
reserved /*groupV1*/ 3 ;
2020-04-14 18:32:11 +00:00
optional GroupContextV2 groupV2 = 15 ;
2019-06-10 21:40:02 +00:00
optional uint32 flags = 4 ;
optional uint32 expireTimer = 5 ;
2024-08-21 16:03:28 +00:00
optional uint32 expireTimerVersion = 23 ;
2019-06-10 21:40:02 +00:00
optional bytes profileKey = 6 ;
optional uint64 timestamp = 7 ;
optional Quote quote = 8 ;
repeated Contact contact = 9 ;
repeated Preview preview = 10 ;
optional Sticker sticker = 11 ;
optional uint32 requiredProtocolVersion = 12 ;
2019-08-05 20:53:15 +00:00
optional bool isViewOnce = 14 ;
2019-12-16 17:45:57 +00:00
optional Reaction reaction = 16 ;
2020-04-29 21:24:12 +00:00
optional Delete delete = 17 ;
2020-09-16 22:42:48 +00:00
repeated BodyRange bodyRanges = 18 ;
2020-11-16 19:58:54 +00:00
optional GroupCallUpdate groupCallUpdate = 19 ;
2022-11-30 21:47:54 +00:00
optional Payment payment = 20 ;
2021-11-16 01:20:09 +00:00
optional StoryContext storyContext = 21 ;
2022-05-11 20:59:58 +00:00
optional GiftBadge giftBadge = 22 ;
2018-02-15 19:59:46 +00:00
}
message NullMessage {
optional bytes padding = 1 ;
}
message ReceiptMessage {
enum Type {
DELIVERY = 0 ;
READ = 1 ;
2021-06-29 20:11:10 +00:00
VIEWED = 2 ;
2018-02-15 19:59:46 +00:00
}
optional Type type = 1 ;
repeated uint64 timestamp = 2 ;
}
2018-11-14 19:10:32 +00:00
message TypingMessage {
enum Action {
STARTED = 0 ;
STOPPED = 1 ;
}
optional uint64 timestamp = 1 ;
optional Action action = 2 ;
optional bytes groupId = 3 ;
}
2021-11-16 01:20:09 +00:00
message StoryMessage {
optional bytes profileKey = 1 ;
optional GroupContextV2 group = 2 ;
2022-03-04 21:14:52 +00:00
oneof attachment {
AttachmentPointer fileAttachment = 3 ;
TextAttachment textAttachment = 4 ;
}
2022-07-01 00:52:03 +00:00
optional bool allowsReplies = 5 ;
2023-04-10 16:31:45 +00:00
repeated BodyRange bodyRanges = 6 ;
2022-03-04 21:14:52 +00:00
}
message TextAttachment {
enum Style {
DEFAULT = 0 ;
REGULAR = 1 ;
BOLD = 2 ;
SERIF = 3 ;
SCRIPT = 4 ;
CONDENSED = 5 ;
}
message Gradient {
2024-04-09 21:38:27 +00:00
optional uint32 startColor = 1 ; // deprecated: this field will be removed in a future release.
optional uint32 endColor = 2 ; // deprecated: this field will be removed in a future release.
2022-03-04 21:14:52 +00:00
optional uint32 angle = 3 ; // degrees
2024-04-09 21:38:27 +00:00
repeated uint32 colors = 4 ;
repeated float positions = 5 ; // percent from 0 to 1
2022-03-04 21:14:52 +00:00
}
optional string text = 1 ;
optional Style textStyle = 2 ;
optional uint32 textForegroundColor = 3 ; // integer representation of hex color
optional uint32 textBackgroundColor = 4 ;
optional Preview preview = 5 ;
oneof background {
Gradient gradient = 6 ;
uint32 color = 7 ;
}
2021-11-16 01:20:09 +00:00
}
2018-02-15 19:59:46 +00:00
message Verified {
enum State {
DEFAULT = 0 ;
VERIFIED = 1 ;
UNVERIFIED = 2 ;
}
2020-03-05 21:14:58 +00:00
optional string destination = 1 ;
2023-08-10 16:43:33 +00:00
optional string destinationAci = 5 ;
2020-03-05 21:14:58 +00:00
optional bytes identityKey = 2 ;
optional State state = 3 ;
optional bytes nullMessage = 4 ;
2015-06-01 21:08:21 +00:00
}
message SyncMessage {
message Sent {
2018-10-18 01:01:21 +00:00
message UnidentifiedDeliveryStatus {
2024-03-12 01:08:38 +00:00
optional string destination = 1 ;
2023-08-10 16:43:33 +00:00
optional string destinationServiceId = 3 ;
2024-03-12 01:08:38 +00:00
optional bool unidentified = 2 ;
reserved /* destinationPni */ 4 ;
optional bytes destinationPniIdentityKey = 5 ; // Only set for PNI destinations
2018-10-18 01:01:21 +00:00
}
2022-07-01 00:52:03 +00:00
message StoryMessageRecipient {
2023-08-10 16:43:33 +00:00
optional string destinationServiceId = 1 ;
2022-07-01 00:52:03 +00:00
repeated string distributionListIds = 2 ;
optional bool isAllowedToReply = 3 ;
}
2018-10-18 01:01:21 +00:00
optional string destination = 1 ;
2023-08-10 16:43:33 +00:00
optional string destinationServiceId = 7 ;
2018-10-18 01:01:21 +00:00
optional uint64 timestamp = 2 ;
optional DataMessage message = 3 ;
optional uint64 expirationStartTimestamp = 4 ;
repeated UnidentifiedDeliveryStatus unidentifiedStatus = 5 ;
2019-05-09 15:38:05 +00:00
optional bool isRecipientUpdate = 6 [ default = false ] ;
2022-07-01 00:52:03 +00:00
optional StoryMessage storyMessage = 8 ;
repeated StoryMessageRecipient storyMessageRecipients = 9 ;
2023-03-27 23:48:57 +00:00
optional EditMessage editMessage = 10 ;
2015-06-01 21:08:21 +00:00
}
message Contacts {
2017-06-19 15:35:19 +00:00
optional AttachmentPointer blob = 1 ;
2018-02-15 19:59:46 +00:00
optional bool complete = 2 [ default = false ] ;
2015-06-01 21:08:21 +00:00
}
2016-09-07 00:12:45 +00:00
message Blocked {
2020-07-07 00:56:56 +00:00
repeated string numbers = 1 ;
2023-08-10 16:43:33 +00:00
repeated string acis = 3 ;
2020-07-07 00:56:56 +00:00
repeated bytes groupIds = 2 ;
2016-09-07 00:12:45 +00:00
}
2015-06-19 22:34:41 +00:00
message Request {
enum Type {
Feature: Blue check marks for read messages if opted in (#1489)
* Refactor delivery receipt event handler
* Rename the delivery receipt event
For less ambiguity with read receipts.
* Rename synced read event
For less ambiguity with read receipts from other Signal users.
* Add support for incoming receipt messages
Handle ReceiptMessages, which may include encrypted delivery receipts or read
receipts from recipients of our sent messages.
// FREEBIE
* Rename ReadReceipts to ReadSyncs
* Render read messages with blue double checks
* Send read receipts to senders of incoming messages
// FREEBIE
* Move ReadSyncs to their own file
// FREEBIE
* Fixup old comments on read receipts (now read syncs)
And some variable renaming for extra clarity.
// FREEBIE
* Add global setting for read receipts
Don't send read receipt messages unless the setting is enabled.
Don't process read receipts if the setting is disabled.
// FREEBIE
* Sync read receipt setting from mobile
Toggling this setting on your mobile device should sync it to Desktop. When
linking, use the setting in the provisioning message.
// FREEBIE
* Send receipt messages silently
Avoid generating phantom messages on ios
// FREEBIE
* Save recipients on the outgoing message models
For accurate tracking and display of sent/delivered/read state, even if group
membership changes later.
// FREEBIE
* Fix conversation type in profile key update handling
// FREEBIE
* Set recipients on synced sent messages
* Render saved recipients in message detail if available
For older messages, where we did not save the intended set of recipients at the
time of sending, fall back to the current group membership.
// FREEBIE
* Record who has been successfully sent to
// FREEBIE
* Record who a message has been delivered to
* Invert the not-clickable class
* Fix readReceipt setting sync when linking
* Render per recipient sent/delivered/read status
In the message detail view for outgoing messages, render each recipient's
individual sent/delivered/read status with respect to this message, as long as
there are no errors associated with the recipient (ie, safety number changes,
user not registered, etc...) since the error icon is displayed in that case.
*Messages sent before this change may not have per-recipient status lists
and will simply show no status icon.
// FREEBIE
* Add configuration sync request
Send these requests in a one-off fashion when:
1. We have just setup from a chrome app import
2. We have just upgraded to read-receipt support
// FREEBIE
* Expose sendRequestConfigurationSyncMessage
// FREEBIE
* Fix handling of incoming delivery receipts - union with array
FREEBIE
2017-10-04 22:28:43 +00:00
UNKNOWN = 0 ;
CONTACTS = 1 ;
2023-07-26 17:49:27 +00:00
reserved /* GROUPS */ 2 ;
Feature: Blue check marks for read messages if opted in (#1489)
* Refactor delivery receipt event handler
* Rename the delivery receipt event
For less ambiguity with read receipts.
* Rename synced read event
For less ambiguity with read receipts from other Signal users.
* Add support for incoming receipt messages
Handle ReceiptMessages, which may include encrypted delivery receipts or read
receipts from recipients of our sent messages.
// FREEBIE
* Rename ReadReceipts to ReadSyncs
* Render read messages with blue double checks
* Send read receipts to senders of incoming messages
// FREEBIE
* Move ReadSyncs to their own file
// FREEBIE
* Fixup old comments on read receipts (now read syncs)
And some variable renaming for extra clarity.
// FREEBIE
* Add global setting for read receipts
Don't send read receipt messages unless the setting is enabled.
Don't process read receipts if the setting is disabled.
// FREEBIE
* Sync read receipt setting from mobile
Toggling this setting on your mobile device should sync it to Desktop. When
linking, use the setting in the provisioning message.
// FREEBIE
* Send receipt messages silently
Avoid generating phantom messages on ios
// FREEBIE
* Save recipients on the outgoing message models
For accurate tracking and display of sent/delivered/read state, even if group
membership changes later.
// FREEBIE
* Fix conversation type in profile key update handling
// FREEBIE
* Set recipients on synced sent messages
* Render saved recipients in message detail if available
For older messages, where we did not save the intended set of recipients at the
time of sending, fall back to the current group membership.
// FREEBIE
* Record who has been successfully sent to
// FREEBIE
* Record who a message has been delivered to
* Invert the not-clickable class
* Fix readReceipt setting sync when linking
* Render per recipient sent/delivered/read status
In the message detail view for outgoing messages, render each recipient's
individual sent/delivered/read status with respect to this message, as long as
there are no errors associated with the recipient (ie, safety number changes,
user not registered, etc...) since the error icon is displayed in that case.
*Messages sent before this change may not have per-recipient status lists
and will simply show no status icon.
// FREEBIE
* Add configuration sync request
Send these requests in a one-off fashion when:
1. We have just setup from a chrome app import
2. We have just upgraded to read-receipt support
// FREEBIE
* Expose sendRequestConfigurationSyncMessage
// FREEBIE
* Fix handling of incoming delivery receipts - union with array
FREEBIE
2017-10-04 22:28:43 +00:00
BLOCKED = 3 ;
CONFIGURATION = 4 ;
2020-07-07 00:56:56 +00:00
KEYS = 5 ;
2024-11-12 19:36:58 +00:00
reserved /* PNI_IDENTITY */ 6 ;
2015-06-19 22:34:41 +00:00
}
2017-06-08 22:57:25 +00:00
2015-06-19 22:34:41 +00:00
optional Type type = 1 ;
}
2017-06-08 22:57:25 +00:00
2020-07-07 00:56:56 +00:00
message Keys {
2024-11-12 19:36:58 +00:00
reserved /* storageService */ 1 ; // deprecated: this field will be removed in a future release.
2024-10-31 17:01:03 +00:00
optional bytes master = 2 ; // deprecated: this field will be removed in a future release.
optional string accountEntropyPool = 3 ;
optional bytes mediaRootBackupKey = 4 ;
2020-07-07 00:56:56 +00:00
}
2016-02-20 00:28:08 +00:00
message Read {
2020-03-05 21:14:58 +00:00
optional string sender = 1 ;
2023-08-10 16:43:33 +00:00
optional string senderAci = 3 ;
2020-03-05 21:14:58 +00:00
optional uint64 timestamp = 2 ;
2016-02-20 00:28:08 +00:00
}
2015-06-19 22:34:41 +00:00
2021-07-06 18:21:05 +00:00
message Viewed {
optional string senderE164 = 1 ;
2023-08-10 16:43:33 +00:00
optional string senderAci = 3 ;
2021-07-06 18:21:05 +00:00
optional uint64 timestamp = 2 ;
}
2018-02-15 19:59:46 +00:00
message Configuration {
2020-07-07 00:56:56 +00:00
optional bool readReceipts = 1 ;
optional bool unidentifiedDeliveryIndicators = 2 ;
optional bool typingIndicators = 3 ;
2021-05-14 01:18:43 +00:00
reserved 4 ;
2020-07-07 00:56:56 +00:00
optional uint32 provisioningVersion = 5 ;
2020-09-28 23:46:31 +00:00
optional bool linkPreviews = 6 ;
Feature: Blue check marks for read messages if opted in (#1489)
* Refactor delivery receipt event handler
* Rename the delivery receipt event
For less ambiguity with read receipts.
* Rename synced read event
For less ambiguity with read receipts from other Signal users.
* Add support for incoming receipt messages
Handle ReceiptMessages, which may include encrypted delivery receipts or read
receipts from recipients of our sent messages.
// FREEBIE
* Rename ReadReceipts to ReadSyncs
* Render read messages with blue double checks
* Send read receipts to senders of incoming messages
// FREEBIE
* Move ReadSyncs to their own file
// FREEBIE
* Fixup old comments on read receipts (now read syncs)
And some variable renaming for extra clarity.
// FREEBIE
* Add global setting for read receipts
Don't send read receipt messages unless the setting is enabled.
Don't process read receipts if the setting is disabled.
// FREEBIE
* Sync read receipt setting from mobile
Toggling this setting on your mobile device should sync it to Desktop. When
linking, use the setting in the provisioning message.
// FREEBIE
* Send receipt messages silently
Avoid generating phantom messages on ios
// FREEBIE
* Save recipients on the outgoing message models
For accurate tracking and display of sent/delivered/read state, even if group
membership changes later.
// FREEBIE
* Fix conversation type in profile key update handling
// FREEBIE
* Set recipients on synced sent messages
* Render saved recipients in message detail if available
For older messages, where we did not save the intended set of recipients at the
time of sending, fall back to the current group membership.
// FREEBIE
* Record who has been successfully sent to
// FREEBIE
* Record who a message has been delivered to
* Invert the not-clickable class
* Fix readReceipt setting sync when linking
* Render per recipient sent/delivered/read status
In the message detail view for outgoing messages, render each recipient's
individual sent/delivered/read status with respect to this message, as long as
there are no errors associated with the recipient (ie, safety number changes,
user not registered, etc...) since the error icon is displayed in that case.
*Messages sent before this change may not have per-recipient status lists
and will simply show no status icon.
// FREEBIE
* Add configuration sync request
Send these requests in a one-off fashion when:
1. We have just setup from a chrome app import
2. We have just upgraded to read-receipt support
// FREEBIE
* Expose sendRequestConfigurationSyncMessage
// FREEBIE
* Fix handling of incoming delivery receipts - union with array
FREEBIE
2017-10-04 22:28:43 +00:00
}
2019-05-16 22:32:11 +00:00
message StickerPackOperation {
enum Type {
INSTALL = 0 ;
REMOVE = 1 ;
}
2020-07-07 00:56:56 +00:00
2019-05-16 22:32:11 +00:00
optional bytes packId = 1 ;
optional bytes packKey = 2 ;
optional Type type = 3 ;
}
2019-08-05 20:53:15 +00:00
message ViewOnceOpen {
2020-03-05 21:14:58 +00:00
optional string sender = 1 ;
2023-08-10 16:43:33 +00:00
optional string senderAci = 3 ;
2020-03-05 21:14:58 +00:00
optional uint64 timestamp = 2 ;
2019-06-26 19:33:13 +00:00
}
2020-05-27 21:37:06 +00:00
message MessageRequestResponse {
enum Type {
UNKNOWN = 0 ;
ACCEPT = 1 ;
DELETE = 2 ;
BLOCK = 3 ;
BLOCK_AND_DELETE = 4 ;
2024-03-12 16:29:31 +00:00
SPAM = 5 ;
BLOCK_AND_SPAM = 6 ;
2020-05-27 21:37:06 +00:00
}
optional string threadE164 = 1 ;
2023-08-10 16:43:33 +00:00
optional string threadAci = 2 ;
2020-05-27 21:37:06 +00:00
optional bytes groupId = 3 ;
optional Type type = 4 ;
}
2020-07-07 00:56:56 +00:00
message FetchLatest {
enum Type {
2021-11-30 16:29:57 +00:00
UNKNOWN = 0 ;
LOCAL_PROFILE = 1 ;
STORAGE_MANIFEST = 2 ;
SUBSCRIPTION_STATUS = 3 ;
2020-07-07 00:56:56 +00:00
}
optional Type type = 1 ;
}
2022-07-28 16:35:29 +00:00
message PniChangeNumber {
optional bytes identityKeyPair = 1 ; // Serialized libsignal-client IdentityKeyPair
2023-07-14 16:53:20 +00:00
optional bytes signedPreKey = 2 ; // Serialized libsignal-client SignedPreKeyRecord
optional bytes lastResortKyberPreKey = 5 ; // Serialized libsignal-client KyberPreKeyRecord
2022-07-28 16:35:29 +00:00
optional uint32 registrationId = 3 ;
2023-07-14 16:53:20 +00:00
optional string newE164 = 4 ; // The e164 we have changed our number to
// Next ID: 6
2022-07-28 16:35:29 +00:00
}
2023-01-10 00:52:01 +00:00
message CallEvent {
enum Type {
2023-08-09 00:53:06 +00:00
UNKNOWN = 0 ;
AUDIO_CALL = 1 ;
VIDEO_CALL = 2 ;
GROUP_CALL = 3 ;
AD_HOC_CALL = 4 ;
2023-01-10 00:52:01 +00:00
}
enum Direction {
UNKNOWN = 0 ;
INCOMING = 1 ;
OUTGOING = 2 ;
}
enum Event {
UNKNOWN = 0 ;
ACCEPTED = 1 ;
NOT_ACCEPTED = 2 ;
2023-08-09 00:53:06 +00:00
DELETE = 3 ;
2024-07-03 21:35:41 +00:00
OBSERVED = 4 ;
2023-01-10 00:52:01 +00:00
}
2024-06-26 00:58:38 +00:00
/ * Data identifying a conversation. The service ID for 1 : 1 , the group ID for
* group , or the room ID for an ad - hoc call. See also
* ` CallLogEvent / peerId ` . * /
2023-08-09 00:53:06 +00:00
optional bytes peerId = 1 ;
2024-06-26 00:58:38 +00:00
/ * An identifier for a call. Generated directly for 1 : 1 , or derived from
* the era ID for group and ad - hoc calls. See also ` CallLogEvent / callId ` . * /
2023-01-10 00:52:01 +00:00
optional uint64 callId = 2 ;
optional uint64 timestamp = 3 ;
optional Type type = 4 ;
optional Direction direction = 5 ;
optional Event event = 6 ;
}
2024-02-22 21:19:50 +00:00
message CallLinkUpdate {
2024-04-25 17:09:05 +00:00
enum Type {
UPDATE = 0 ;
2024-09-04 18:06:06 +00:00
reserved 1 ; // was DELETE, superseded by storage service
2024-04-25 17:09:05 +00:00
}
optional bytes rootKey = 1 ;
2024-02-22 21:19:50 +00:00
optional bytes adminPasskey = 2 ;
2024-04-25 17:09:05 +00:00
optional Type type = 3 ; // defaults to UPDATE
2024-02-22 21:19:50 +00:00
}
2023-08-09 00:53:06 +00:00
message CallLogEvent {
enum Type {
CLEAR = 0 ;
2024-03-11 18:18:55 +00:00
MARKED_AS_READ = 1 ;
2024-06-26 00:58:38 +00:00
MARKED_AS_READ_IN_CONVERSATION = 2 ;
2023-08-09 00:53:06 +00:00
}
optional Type type = 1 ;
optional uint64 timestamp = 2 ;
2024-06-26 00:58:38 +00:00
/ * Data identifying a conversation. The service ID for 1 : 1 , the group ID for
* group , or the room ID for an ad - hoc call. See also
* ` CallEvent / peerId ` . * /
optional bytes peerId = 3 ;
/ * An identifier for a call. Generated directly for 1 : 1 , or derived from
* the era ID for group and ad - hoc calls. See also ` CallEvent / callId ` . * /
optional uint64 callId = 4 ;
2023-08-09 00:53:06 +00:00
}
2024-05-28 15:56:00 +00:00
message DeleteForMe {
message ConversationIdentifier {
oneof identifier {
2024-06-17 19:24:39 +00:00
string threadServiceId = 1 ;
2024-05-28 15:56:00 +00:00
bytes threadGroupId = 2 ;
string threadE164 = 3 ;
}
}
2024-06-26 00:58:38 +00:00
2024-05-28 15:56:00 +00:00
message AddressableMessage {
oneof author {
2024-06-17 19:24:39 +00:00
string authorServiceId = 1 ;
2024-05-28 15:56:00 +00:00
string authorE164 = 2 ;
}
optional uint64 sentTimestamp = 3 ;
}
message MessageDeletes {
optional ConversationIdentifier conversation = 1 ;
repeated AddressableMessage messages = 2 ;
}
2024-06-21 22:35:18 +00:00
message AttachmentDelete {
optional ConversationIdentifier conversation = 1 ;
optional AddressableMessage targetMessage = 2 ;
// The `clientUuid` from `AttachmentPointer`.
optional bytes clientUuid = 3 ;
// SHA256 hash of the (encrypted, padded, etc.) attachment blob on the CDN.
optional bytes fallbackDigest = 4 ;
// SHA256 hash of the plaintext content of the attachment.
optional bytes fallbackPlaintextHash = 5 ;
}
2024-05-28 15:56:00 +00:00
message ConversationDelete {
optional ConversationIdentifier conversation = 1 ;
repeated AddressableMessage mostRecentMessages = 2 ;
optional bool isFullDelete = 3 ;
2024-06-24 17:49:36 +00:00
repeated AddressableMessage mostRecentNonExpiringMessages = 4 ;
2024-05-28 15:56:00 +00:00
}
message LocalOnlyConversationDelete {
optional ConversationIdentifier conversation = 1 ;
}
repeated MessageDeletes messageDeletes = 1 ;
repeated ConversationDelete conversationDeletes = 2 ;
repeated LocalOnlyConversationDelete localOnlyConversationDeletes = 3 ;
2024-06-21 22:35:18 +00:00
repeated AttachmentDelete attachmentDeletes = 4 ;
2024-05-28 15:56:00 +00:00
}
2024-06-26 00:58:38 +00:00
2020-05-27 21:37:06 +00:00
optional Sent sent = 1 ;
optional Contacts contacts = 2 ;
2023-07-26 17:49:27 +00:00
reserved /* groups */ 3 ;
2020-05-27 21:37:06 +00:00
optional Request request = 4 ;
repeated Read read = 5 ;
optional Blocked blocked = 6 ;
optional Verified verified = 7 ;
optional Configuration configuration = 9 ;
optional bytes padding = 8 ;
repeated StickerPackOperation stickerPackOperation = 10 ;
optional ViewOnceOpen viewOnceOpen = 11 ;
2020-07-07 00:56:56 +00:00
optional FetchLatest fetchLatest = 12 ;
optional Keys keys = 13 ;
2020-05-27 21:37:06 +00:00
optional MessageRequestResponse messageRequestResponse = 14 ;
2021-07-06 18:21:05 +00:00
reserved 15 ; // not yet added
repeated Viewed viewed = 16 ;
2023-05-10 17:02:32 +00:00
reserved 17 ; // pniIdentity
2022-07-28 16:35:29 +00:00
optional PniChangeNumber pniChangeNumber = 18 ;
2023-01-10 00:52:01 +00:00
optional CallEvent callEvent = 19 ;
2024-02-22 21:19:50 +00:00
optional CallLinkUpdate callLinkUpdate = 20 ;
2023-08-09 00:53:06 +00:00
optional CallLogEvent callLogEvent = 21 ;
2024-05-28 15:56:00 +00:00
optional DeleteForMe deleteForMe = 22 ;
2015-06-01 21:08:21 +00:00
}
message AttachmentPointer {
2017-05-10 22:16:19 +00:00
enum Flags {
VOICE_MESSAGE = 1 ;
2024-06-21 22:35:18 +00:00
BORDERLESS = 2 ;
2021-06-08 20:15:31 +00:00
// Our parser does not handle reserved in enums: DESKTOP-1569
2024-06-21 22:35:18 +00:00
// reserved 4;
GIF = 8 ;
2017-05-10 22:16:19 +00:00
}
2017-06-08 22:57:25 +00:00
2020-04-17 22:51:39 +00:00
oneof attachment_identifier {
2024-06-21 22:35:18 +00:00
fixed64 cdnId = 1 ;
string cdnKey = 15 ;
}
// Cross-client identifier for this attachment among all attachments on the
// owning message.
optional bytes clientUuid = 20 ;
optional string contentType = 2 ;
optional bytes key = 3 ;
optional uint32 size = 4 ;
optional bytes thumbnail = 5 ;
optional bytes digest = 6 ;
reserved /* incrementalMac with implicit chunk sizing */ 16 ;
reserved /* incrementalMac for all attachment types */ 18 ;
optional bytes incrementalMac = 19 ;
optional uint32 chunkSize = 17 ;
optional string fileName = 7 ;
optional uint32 flags = 8 ;
optional uint32 width = 9 ;
optional uint32 height = 10 ;
optional string caption = 11 ;
optional string blurHash = 12 ;
optional uint64 uploadTimestamp = 13 ;
optional uint32 cdnNumber = 14 ;
// Next ID: 21
2015-06-01 21:08:21 +00:00
}
2020-04-14 18:32:11 +00:00
message GroupContextV2 {
optional bytes masterKey = 1 ;
optional uint32 revision = 2 ;
optional bytes groupChange = 3 ;
}
2017-06-09 22:00:54 +00:00
message ContactDetails {
2017-06-09 21:58:55 +00:00
message Avatar {
optional string contentType = 1 ;
optional uint32 length = 2 ;
}
2024-08-21 16:03:28 +00:00
optional string number = 1 ;
optional string aci = 9 ;
optional string name = 2 ;
optional Avatar avatar = 3 ;
2023-11-07 20:26:31 +00:00
// reserved 4; // formerly color
// reserved 5; // formerly verified
// reserved 6; // formerly profileKey
// reserved 7; // formerly blocked
2024-08-21 16:03:28 +00:00
optional uint32 expireTimer = 8 ;
optional uint32 expireTimerVersion = 12 ;
optional uint32 inboxPosition = 10 ;
2015-06-22 21:45:42 +00:00
}
2022-08-15 21:53:33 +00:00
message PniSignatureMessage {
optional bytes pni = 1 ;
// Signature *by* the PNI identity key *of* the ACI identity key
optional bytes signature = 2 ;
}
2023-03-27 23:48:57 +00:00
message EditMessage {
optional uint64 targetSentTimestamp = 1 ;
optional DataMessage dataMessage = 2 ;
}