package signalservice

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: StorageRecord

• bytes profileKey = 1

• string givenName = 2

• string familyName = 3

• string avatarUrlPath = 4

• bool noteToSelfArchived = 5

• bool readReceipts = 6

• bool sealedSenderIndicators = 7

• bool typingIndicators = 8

• bool noteToSelfMarkedUnread = 10

• bool linkPreviews = 11

• AccountRecord.PhoneNumberSharingMode phoneNumberSharingMode = 12

• bool unlistedPhoneNumber = 13

• repeated AccountRecord.PinnedConversation pinnedConversations = 14

• bool preferContactAvatars = 15

• optional Payments payments = 16

• uint32 universalExpireTimer = 17

• bool primarySendsSms = 18

• repeated string preferredReactionEmoji = 20

• bytes subscriberId = 21

• string subscriberCurrencyCode = 22

• bool displayBadgesOnProfile = 23

• bool subscriptionManuallyCancelled = 24

• bool keepMutedChatsArchived = 25

• bool hasSetMyStoriesPrivacy = 26

• bool hasViewedOnboardingStory = 27

• bool storiesDisabled = 29

• OptionalBool storyViewReceiptsEnabled = 30

• bool hasSeenGroupStoryEducationSheet = 32

• string username = 33

• bool hasCompletedUsernameOnboarding = 34

• optional AccountRecord.UsernameLink usernameLink = 35

• optional uint64 backupTier = 40

  See zkgroup for integer particular values. Unset if backups are not enabled.

• optional AccountRecord.IAPSubscriberData backupSubscriberData = 41

• optional AvatarColor avatarColor = 42

• optional AccountRecord.NotificationProfileManualOverride notificationProfileManualOverride = 44

• bool notificationProfileSyncDisabled = 45

• bool automaticKeyVerificationDisabled = 46

• bool hasSeenAdminDeleteEducationDialog = 47

• optional bool releaseNotesChatArchived = 48

• optional uint64 releaseNotesChatMutedUntilTimestamp = 49

• optional bool releaseNotesChatBlocked = 50

• optional bool releaseNotesChatMarkedUnread = 51

• optional uint64 releaseNotesChatBlockedAt = 52

  only set if known (>0)

• AccountRecord.UnreadBadgeType unreadBadgeType = 53

  Only used in desktop/ios

• OptionalBool includeMutedChatsInBadge = 54

  Only used in desktop/ios. If unset, consider this off. Only used in desktop/ios

• OptionalBool reactionNotifications = 55

  If unset, consider this on

• OptionalBool notifyForCallsIfMuted = 56

  If unset, consider this off

• OptionalBool notifyForMentionsIfMuted = 57

  If unset, consider this on

• OptionalBool notifyForRepliesIfMuted = 58

  If unset, consider this on

• OptionalBool showUnreadReminders = 59

  If unset, consider this on

• OptionalBool notifyWhenContactJoins = 60

  If unset, consider this off

Used in: AccountRecord

• bytes subscriberId = 1

• oneof iapSubscriptionId

  • string purchaseToken = 2

    Identifies an Android Play Store IAP subscription.

  • uint64 originalTransactionId = 3

    Identifies an iOS App Store IAP subscription.

Used in: AccountRecord

• oneof override

  • uint64 disabledAtTimestampMs = 1

  • NotificationProfileManualOverride.ManuallyEnabled enabled = 2

Used in: NotificationProfileManualOverride

• bytes id = 1

• uint64 endAtTimestampMs = 3

  This will be unset if no timespan was chosen in the UI.

Used in: AccountRecord

• UNKNOWN = 0

• EVERYBODY = 1

• NOBODY = 2

Used in: AccountRecord

• oneof identifier

  • PinnedConversation.Contact contact = 1

  • bytes legacyGroupId = 3

  • bytes groupMasterKey = 4

  • PinnedConversation.ReleaseNotes releaseNotes = 5

Used in: PinnedConversation

• string serviceId = 1

• string e164 = 2

• bytes serviceIdBinary = 3

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: PinnedConversation

(message has no fields)

Used in: AccountRecord

• UNKNOWN_BADGE_TYPE = 0

  Interpret as "Unread messages"

• UNREAD_MESSAGES = 1

• UNREAD_CHATS = 2

Used in: AccountRecord

• bytes entropy = 1

  32 bytes of entropy used for encryption

• bytes serverId = 2

  16 bytes of encoded UUID provided by the server

• UsernameLink.Color color = 3

Used in: UsernameLink

• UNKNOWN = 0

• BLUE = 1

• WHITE = 2

• GREY = 3

• OLIVE = 4

• GREEN = 5

• ORANGE = 6

• PINK = 7

• PURPLE = 8

Used in: SyncMessage.AttachmentBackfillRequest, SyncMessage.AttachmentBackfillResponse, SyncMessage.DeleteForMe.AttachmentDelete, SyncMessage.DeleteForMe.ConversationDelete, SyncMessage.DeleteForMe.MessageDeletes

• oneof author

  • string authorServiceId = 1

  • string authorE164 = 2

  • bytes authorServiceIdBinary = 4

    service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

• optional uint64 sentTimestamp = 3

Used in: DataMessage, DataMessage.Contact.Avatar, DataMessage.Quote.QuotedAttachment, DataMessage.Sticker, Preview, StoryMessage, SyncMessage.AttachmentBackfillResponse.AttachmentData, SyncMessage.Contacts

• oneof attachment_identifier

  • fixed64 cdnId = 1

  • string cdnKey = 15

• optional bytes clientUuid = 20

  Cross-client identifier for this attachment among all attachments on the owning message.

• optional string contentType = 2

• optional bytes key = 3

• optional uint32 size = 4

• optional bytes thumbnail = 5

• optional bytes digest = 6

• 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

• optional bytes audioWaveform = 21

  Waveform for audio attachments. Each byte represents a "bar" in the waveform, with 0 as silence 255 as loudest. At most 100 bytes/bars.

• optional float audioDurationSeconds = 22

  Duration of an audio attachment, in seconds.

  Next ID: 23

• VOICE_MESSAGE = 1

• BORDERLESS = 2

• GIF = 8

If unset - computed as the value of the first byte of SHA-256(msg=CONTACT_ID) modulo the count of colors. Once set the avatar color for a recipient is never recomputed or changed. `CONTACT_ID` is the first available identifier from the list: - ServiceIdToBinary(ACI) - E164 - ServiceIdToBinary(PNI) - Group Id

Used in: AccountRecord, ContactRecord, GroupV2Record

• A100 = 0

• A110 = 1

• A120 = 2

• A130 = 3

• A140 = 4

• A150 = 5

• A160 = 6

• A170 = 7

• A180 = 8

• A190 = 9

• A200 = 10

• A210 = 11

Used in: DataMessage, DataMessage.Quote, StoryMessage

• optional uint32 start = 1

  Starting index in UTF-16 code units/raw string representation

• optional uint32 length = 2

  Length of range in UTF-16 code units/raw string representation

• oneof associatedValue

  • string mentionAci = 3

  • BodyRange.Style style = 4

  • bytes mentionAciBinary = 5

    16-byte UUID

Used in: BodyRange

• NONE = 0

• BOLD = 1

• ITALIC = 2

• SPOILER = 3

• STRIKETHROUGH = 4

• MONOSPACE = 5

Used in: StorageRecord

• bytes rootKey = 1

• bytes adminPasskey = 2

• uint64 deletedAtTimestampMs = 3

Used in: Content

• optional CallMessage.Offer offer = 1

• optional CallMessage.Answer answer = 2

• repeated CallMessage.IceUpdate iceUpdate = 3

• optional CallMessage.Busy busy = 5

• optional CallMessage.Hangup hangup = 7

• optional uint32 destinationDeviceId = 9

• optional CallMessage.Opaque opaque = 10

Used in: CallMessage

• optional uint64 id = 1

• optional bytes opaque = 3

Used in: CallMessage

• optional uint64 id = 1

Used in: CallMessage

• optional uint64 id = 1

• optional Hangup.Type type = 2

• optional uint32 deviceId = 3

Used in: Hangup

• HANGUP_NORMAL = 0

• HANGUP_ACCEPTED = 1

• HANGUP_DECLINED = 2

• HANGUP_BUSY = 3

• HANGUP_NEED_PERMISSION = 4

Used in: CallMessage

• optional uint64 id = 1

• optional bytes opaque = 5

Used in: CallMessage

• optional uint64 id = 1

• optional Offer.Type type = 3

• optional bytes opaque = 4

Used in: Offer

• OFFER_AUDIO_CALL = 0

• OFFER_VIDEO_CALL = 1

Used in: CallMessage

• optional bytes data = 1

• optional Opaque.Urgency urgency = 2

  If missing, treat as DROPPABLE.

Used in: Opaque

• DROPPABLE = 0

• HANDLE_IMMEDIATELY = 1

Used in: StorageRecord

• bytes identifier = 1

• string name = 2

• uint32 position = 3

• bool showOnlyUnread = 4

• bool showMutedChats = 5

• bool includeAllIndividualChats = 6

  Folder includes all 1:1 chats, unless excluded

• bool includeAllGroupChats = 7

  Folder includes all group chats, unless excluded

• ChatFolderRecord.FolderType folderType = 8

• repeated Recipient includedRecipients = 9

• repeated Recipient excludedRecipients = 10

• uint64 deletedAtTimestampMs = 11

  When non-zero, `position` should be set to -1 and includedRecipients should be empty

Represents the default "All chats" folder record vs all other custom folders

Used in: ChatFolderRecord

• UNKNOWN = 0

• ALL = 1

• CUSTOM = 2

• optional string number = 1

• optional string aci = 9

• optional bytes aciBinary = 13

  16-byte UUID

• optional string name = 2

• optional ContactDetails.Avatar avatar = 3

• optional uint32 expireTimer = 8

• optional uint32 expireTimerVersion = 12

• optional uint32 inboxPosition = 10

Used in: ContactDetails

• optional string contentType = 1

• optional uint32 length = 2

Used in: StorageRecord

• string aci = 1

• string e164 = 2

• string pni = 15

• bytes profileKey = 3

• bytes identityKey = 4

• ContactRecord.IdentityState identityState = 5

• string givenName = 6

• string familyName = 7

• string username = 8

• bool blocked = 9

• bool whitelisted = 10

• bool archived = 11

• bool markedUnread = 12

• uint64 mutedUntilTimestamp = 13

• bool hideStory = 14

• uint64 unregisteredAtTimestamp = 16

• string systemGivenName = 17

• string systemFamilyName = 18

• string systemNickname = 19

• bool hidden = 20

• bool pniSignatureVerified = 21

• optional ContactRecord.Name nickname = 22

• string note = 23

• optional AvatarColor avatarColor = 24

• bytes aciBinary = 25

  16-byte UUID

• bytes pniBinary = 26

  16-byte UUID

• uint64 blockedAtTimestamp = 27

  0 means the blocked time is unknown

• OptionalBool notifyForCallsIfMuted = 28

  If unset, use the default settings

• OptionalBool showUnreadReminders = 29

  If unset, use the default settings

• optional ContactRecord.Name sharedName = 30

  Name shared from a third party

Used in: ContactRecord

• DEFAULT = 0

• VERIFIED = 1

• UNVERIFIED = 2

Used in: ContactRecord

• string given = 1

• string family = 2

• oneof content

  • DataMessage dataMessage = 1

  • SyncMessage syncMessage = 2

  • CallMessage callMessage = 3

  • NullMessage nullMessage = 4

  • ReceiptMessage receiptMessage = 5

  • TypingMessage typingMessage = 6

  • bytes decryptionErrorMessage = 8

  • StoryMessage storyMessage = 9

  • EditMessage editMessage = 11

• optional bytes senderKeyDistributionMessage = 7

• optional PniSignatureMessage pniSignatureMessage = 10

Used in: SyncMessage.AttachmentBackfillRequest, SyncMessage.AttachmentBackfillResponse, SyncMessage.DeleteForMe.AttachmentDelete, SyncMessage.DeleteForMe.ConversationDelete, SyncMessage.DeleteForMe.LocalOnlyConversationDelete, SyncMessage.DeleteForMe.MessageDeletes

• oneof identifier

  • string threadServiceId = 1

  • bytes threadGroupId = 2

  • string threadE164 = 3

  • bytes threadServiceIdBinary = 4

    service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: Content, EditMessage, SyncMessage.Sent

• optional string body = 1

• repeated AttachmentPointer attachments = 2

• optional GroupContextV2 groupV2 = 15

• optional uint32 flags = 4

• optional uint32 expireTimer = 5

• optional uint32 expireTimerVersion = 23

• optional bytes profileKey = 6

• optional uint64 timestamp = 7

• optional DataMessage.Quote quote = 8

• repeated DataMessage.Contact contact = 9

• repeated Preview preview = 10

• optional DataMessage.Sticker sticker = 11

• optional uint32 requiredProtocolVersion = 12

• optional bool isViewOnce = 14

• optional DataMessage.Reaction reaction = 16

• optional DataMessage.Delete delete = 17

• repeated BodyRange bodyRanges = 18

• optional DataMessage.GroupCallUpdate groupCallUpdate = 19

• optional DataMessage.Payment payment = 20

• optional DataMessage.StoryContext storyContext = 21

• optional DataMessage.GiftBadge giftBadge = 22

• optional DataMessage.PollCreate pollCreate = 24

• optional DataMessage.PollTerminate pollTerminate = 25

• optional DataMessage.PollVote pollVote = 26

• optional DataMessage.PinMessage pinMessage = 27

• optional DataMessage.UnpinMessage unpinMessage = 28

• optional DataMessage.AdminDelete adminDelete = 29

  NEXT ID: 30

Used in: DataMessage

• optional bytes targetAuthorAciBinary = 1

  16-byte UUID

• optional uint64 targetSentTimestamp = 2

Used in: DataMessage

• optional Contact.Name name = 1

• repeated Contact.Phone number = 3

• repeated Contact.Email email = 4

• repeated Contact.PostalAddress address = 5

• optional Contact.Avatar avatar = 6

• optional string organization = 7

• optional bytes aciBinary = 8

  16-byte UUID

• optional Contact.SignalNickname nickname = 9

• optional string note = 10

  Next ID: 11

Used in: Contact

• optional AttachmentPointer avatar = 1

• optional bool isProfile = 2

Used in: Contact

• optional string value = 1

• optional Email.Type type = 2

• optional string label = 3

Used in: Email

• HOME = 1

• MOBILE = 2

• WORK = 3

• CUSTOM = 4

Used in: Contact

• optional string givenName = 1

• optional string familyName = 2

• optional string prefix = 3

• optional string suffix = 4

• optional string middleName = 5

• optional string nickname = 7

Used in: Contact

• optional string value = 1

• optional Phone.Type type = 2

• optional string label = 3

Used in: Phone

• HOME = 1

• MOBILE = 2

• WORK = 3

• CUSTOM = 4

Used in: Contact

• optional PostalAddress.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

Used in: PostalAddress

• HOME = 1

• WORK = 2

• CUSTOM = 3

Used in: Contact

• optional string given = 1

• optional string family = 2

Used in: DataMessage

• optional uint64 targetSentTimestamp = 1

• EXPIRATION_TIMER_UPDATE = 2

• PROFILE_KEY_UPDATE = 4

• FORWARD = 8

Used in: DataMessage

• optional bytes receiptCredentialPresentation = 1

Used in: DataMessage

• optional string eraId = 1

Used in: DataMessage

• oneof Item

  • Payment.Notification notification = 1

  • Payment.Activation activation = 2

Used in: Payment

• optional Activation.Type type = 1

Used in: Activation

• REQUEST = 0

• ACTIVATED = 1

• oneof Amount

  • Amount.MobileCoin mobileCoin = 1

Used in: Amount

• optional uint64 picoMob = 1

  1,000,000,000,000 picoMob per Mob

Used in: Payment

• oneof Transaction

  • Notification.MobileCoin mobileCoin = 1

• optional string note = 2

  Optional, Refers to the PaymentRequest message, if any.

Used in: Notification

• optional bytes receipt = 1

Used in: DataMessage

• optional bytes targetAuthorAciBinary = 1

  16-byte UUID

• optional uint64 targetSentTimestamp = 2

• oneof pinDuration

  • uint32 pinDurationSeconds = 3

  • bool pinDurationForever = 4

Used in: DataMessage

• optional string question = 1

• optional bool allowMultiple = 2

• repeated string options = 3

Used in: DataMessage

• optional uint64 targetSentTimestamp = 1

Used in: DataMessage

• optional bytes targetAuthorAciBinary = 1

• optional uint64 targetSentTimestamp = 2

• repeated uint32 optionIndexes = 3

• optional uint32 voteCount = 4

• INITIAL = 0

• MESSAGE_TIMERS = 1

• VIEW_ONCE = 2

• VIEW_ONCE_VIDEO = 3

• REACTIONS = 4

• CDN_SELECTOR_ATTACHMENTS = 5

• MENTIONS = 6

• PAYMENTS = 7

• POLLS = 8

• CURRENT = 8

Used in: DataMessage

• optional uint64 id = 1

• optional string authorAci = 5

• optional string text = 3

• repeated Quote.QuotedAttachment attachments = 4

• repeated BodyRange bodyRanges = 6

• optional Quote.Type type = 7

• optional bytes authorAciBinary = 8

  16-byte UUID

Used in: Quote

• optional string contentType = 1

• optional string fileName = 2

• optional AttachmentPointer thumbnail = 3

Used in: Quote

• NORMAL = 0

• GIFT_BADGE = 1

• POLL = 2

Used in: DataMessage

• optional string emoji = 1

• optional bool remove = 2

• optional string targetAuthorAci = 4

• optional uint64 targetSentTimestamp = 5

• optional bytes targetAuthorAciBinary = 6

  16-byte UUID

Used in: DataMessage

• optional bytes packId = 1

• optional bytes packKey = 2

• optional uint32 stickerId = 3

• optional AttachmentPointer data = 4

• optional string emoji = 5

Used in: DataMessage

• optional string authorAci = 1

• optional uint64 sentTimestamp = 2

• optional bytes authorAciBinary = 3

  16-byte UUID

Used in: DataMessage

• optional bytes targetAuthorAciBinary = 1

  16-byte UUID

• optional uint64 targetSentTimestamp = 2

• optional bytes ratchetKey = 1

  set to the public ratchet key from the SignalMessage if a 1-1 payload fails to decrypt

• optional uint64 timestamp = 2

• optional uint32 deviceId = 3

• optional bytes ephemeralPublic = 1

• optional bytes syntheticIv = 2

• optional bytes ciphertext = 3

Used in: Content, SyncMessage.Sent

• optional uint64 targetSentTimestamp = 1

• optional DataMessage dataMessage = 2

Used in: org.signal.chat.messages.GetMessagesResponse

• optional Envelope.Type type = 1

• optional string sourceServiceId = 11

• optional uint32 sourceDeviceId = 7

• optional string destinationServiceId = 13

• optional uint64 clientTimestamp = 5

• optional bytes content = 8

  Contains an encrypted Content

• optional string serverGuid = 9

• optional uint64 serverTimestamp = 10

• optional bool ephemeral = 12

  indicates that the message should not be persisted if the recipient is offline

• optional bool urgent = 14

  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

• optional string updatedPni = 15

  for number-change synchronization messages, provides the new server-assigned phone number identifier associated with the changed number

• optional bool story = 16

  indicates that the content is a story.

• optional bytes report_spam_token = 17

  token sent when reporting spam

• optional bytes sourceServiceIdBinary = 19

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

• optional bytes destinationServiceIdBinary = 20

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

• optional bytes serverGuidBinary = 21

  16-byte UUID

• optional bytes updatedPniBinary = 22

  16-byte UUID

Used in: Envelope

• UNKNOWN = 0

• DOUBLE_RATCHET = 1

  * A double-ratchet message represents a "normal," "unsealed-sender" message encrypted using the Double Ratchet within an established Signal session. Double-ratchet messages include sender information in the plaintext portion of the `Envelope`.

  content => (version byte | SignalMessage{Content})

• PREKEY_MESSAGE = 3

  * A prekey message begins a new Signal session. The `content` of a prekey message is a superset of a double-ratchet message's `content` and contains the sender's identity public key and information identifying the pre-keys used in the message's ciphertext. Like double-ratchet messages, prekey messages contain sender information in the plaintext portion of the `Envelope`.

  content => (version byte | PreKeySignalMessage{Content})

• SERVER_DELIVERY_RECEIPT = 5

  * Server delivery receipts are generated by the server when "unsealed-sender" messages are delivered to and acknowledged by the destination device. Server delivery receipts identify the sender in the plaintext portion of the `Envelope` and have no `content`. Note that receipts for sealed-sender messages are generated by clients as `UNIDENTIFIED_SENDER` messages. Note that, with server delivery receipts, the "client timestamp" on the envelope refers to the timestamp of the original message (i.e. the message the server just delivered) and not to the time of delivery. The "server timestamp" refers to the time of delivery.

  content => []

• UNIDENTIFIED_SENDER = 6

  * An unidentified sender message represents a message with no sender information in the plaintext portion of the `Envelope`. Unidentified sender messages always contain an additional `subtype` in their `content`. They may or may not be part of an existing Signal session (i.e. an unidentified sender message may have a "prekey message" subtype or may indicate an encryption error).

  content => ((version byte | UnidentifiedSenderMessage) OR (version byte | Multi-Recipient Sealed Sender Format))

• PLAINTEXT_CONTENT = 8

  * A plaintext message is used solely to convey encryption error receipts and never contains encrypted message content. Encryption error receipts must be delivered in plaintext because, encryption/decryption of a prior message failed and there is no reason to believe that encryption/decryption of subsequent messages with the same key material would succeed. Critically, plaintext messages never have "real" message content generated by users. Plaintext messages include sender information.

  content => (marker byte | Content)

Used in: DataMessage, StoryMessage

• optional bytes masterKey = 1

• optional uint32 revision = 2

• optional bytes groupChange = 3

Used in: StorageRecord

• bytes id = 1

• bool blocked = 2

• bool whitelisted = 3

• bool archived = 4

• bool markedUnread = 5

• uint64 mutedUntilTimestamp = 6

Used in: StorageRecord

• bytes masterKey = 1

• bool blocked = 2

• bool whitelisted = 3

• bool archived = 4

• bool markedUnread = 5

• uint64 mutedUntilTimestamp = 6

• bool dontNotifyForMentionsIfMuted = 7

  will be deprecated in favor of [notifyForMentionsIfMuted]

• bool hideStory = 8

• GroupV2Record.StorySendMode storySendMode = 10

• optional AvatarColor avatarColor = 11

• bytes verifiedNameHash = 12

  SHA-256 of UTF-8 encoded decrypted group title that was last verified

• uint64 blockedAtTimestamp = 13

  0 means the blocked time is unknown

• OptionalBool notifyForCallsIfMuted = 14

  If unset, use the default settings

• OptionalBool notifyForMentionsIfMuted = 15

  If unset, use the default settings. If [dontNotifyForMentionsIfMuted] is true, this should be initialized to false.

• OptionalBool notifyForRepliesIfMuted = 16

  If unset, use the default settings

• OptionalBool showUnreadReminders = 17

  If unset, use the default settings

Used in: GroupV2Record

• DEFAULT = 0

• DISABLED = 1

• ENABLED = 2

• uint64 version = 1

• uint32 sourceDevice = 3

• repeated ManifestRecord.Identifier identifiers = 2

• bytes recordIkm = 4

  Next ID: 5

Used in: ManifestRecord

• bytes raw = 1

• Identifier.Type type = 2

Used in: Identifier

• UNKNOWN = 0

• CONTACT = 1

• GROUPV1 = 2

• GROUPV2 = 3

• ACCOUNT = 4

• STORY_DISTRIBUTION_LIST = 5

• STICKER_PACK = 6

• CALL_LINK = 7

• CHAT_FOLDER = 8

• NOTIFICATION_PROFILE = 9

Used in: StorageRecord

• bytes id = 1

• string name = 2

• optional string emoji = 3

• fixed32 color = 4

  0xAARRGGBB

• uint64 createdAtMs = 5

• bool allowAllCalls = 6

• bool allowAllMentions = 7

• repeated Recipient allowedMembers = 8

• bool scheduleEnabled = 9

• uint32 scheduleStartTime = 10

  24-hour clock int, 0000-2359 (e.g., 15, 900, 1130, 2345)

• uint32 scheduleEndTime = 11

  24-hour clock int, 0000-2359 (e.g., 15, 900, 1130, 2345)

• repeated NotificationProfile.DayOfWeek scheduleDaysEnabled = 12

• uint64 deletedAtTimestampMs = 13

Used in: NotificationProfile

• UNKNOWN = 0

  Interpret as "Monday"

• MONDAY = 1

• TUESDAY = 2

• WEDNESDAY = 3

• THURSDAY = 4

• FRIDAY = 5

• SATURDAY = 6

• SUNDAY = 7

Used in: Content

• optional bytes padding = 1

Used in: AccountRecord, ContactRecord, GroupV2Record

• UNSET = 0

• ENABLED = 1

• DISABLED = 2

• optional string title = 1

• optional string author = 2

• optional Pack.Sticker cover = 3

• repeated Pack.Sticker stickers = 4

Used in: Pack

• optional uint32 id = 1

• optional string emoji = 2

• optional string contentType = 3

• oneof Address

  • PaymentAddress.MobileCoin mobileCoin = 1

Used in: PaymentAddress

• optional bytes publicAddress = 1

• optional bytes signature = 2

Used in: AccountRecord

• bool enabled = 1

• bytes entropy = 2

Used in: Content

• optional bytes pni = 1

• optional bytes signature = 2

  Signature *by* the PNI identity key *of* the ACI identity key

Used in: DataMessage, TextAttachment

• optional string url = 1

• optional string title = 2

• optional AttachmentPointer image = 3

• optional string description = 4

• optional uint64 date = 5

• optional bytes publicKey = 1

• optional bytes body = 2

  Encrypted ProvisionMessage

• optional bytes aciIdentityKeyPublic = 1

• optional bytes aciIdentityKeyPrivate = 2

• optional bytes pniIdentityKeyPublic = 11

• optional bytes pniIdentityKeyPrivate = 12

• optional string aci = 8

• optional string pni = 10

• optional string number = 3

• optional string provisioningCode = 4

• optional string userAgent = 5

• optional bytes profileKey = 6

• optional bool readReceipts = 7

• optional uint32 provisioningVersion = 9

• optional bytes ephemeralBackupKey = 14

  32 bytes

• optional string accountEntropyPool = 15

• optional bytes mediaRootBackupKey = 16

  32-bytes

• optional bytes aciBinary = 17

  16-byte UUID

• optional bytes pniBinary = 18

  16-byte UUID

• optional bytes authCredentialSalt = 19

  16-bytes

An opaque address sent by the server when clients first open a provisioning WebSocket

• optional string address = 1

  The opaque provisioning address for the active provisioning WebSocket session; clients should not attempt to interpret or modify the contents of the address string

• INITIAL = 0

• TABLET_SUPPORT = 1

• CURRENT = 1

• repeated bytes readKey = 1

Used in: Content

• optional ReceiptMessage.Type type = 1

• repeated uint64 timestamp = 2

Used in: ReceiptMessage

• DELIVERY = 0

• READ = 1

• VIEWED = 2

Used in: ChatFolderRecord, NotificationProfile

• oneof identifier

  • Recipient.Contact contact = 1

  • bytes legacyGroupId = 2

  • bytes groupMasterKey = 3

Used in: Recipient

• string serviceId = 1

• string e164 = 2

• bytes serviceIdBinary = 3

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: StorageRecord

• bytes packId = 1

  16 bytes

• bytes packKey = 2

  32 bytes, used to derive the AES-256 key

• uint32 position = 3

  aesKey = HKDF( input = packKey, salt = 32 zero bytes, info = "Sticker Pack" )

  When displayed sticker packs should be first sorted

• uint64 deletedAtTimestamp = 4

  in ascending order by zero-based `position` and then by ascending `packId` (lexicographically, packId can be treated as a hex string). When installing a sticker pack the client should find the maximum `position` among currently known stickers and use `max_position + 1` as the value for the new `position`.

  Timestamp in milliseconds. When present and

Used in: StorageItems, WriteOperation

• bytes key = 1

• bytes value = 2

• repeated StorageItem items = 1

Used in: WriteOperation

• uint64 version = 1

• bytes value = 2

• oneof record

  • ContactRecord contact = 1

  • GroupV1Record groupV1 = 2

  • GroupV2Record groupV2 = 3

  • AccountRecord account = 4

  • StoryDistributionListRecord storyDistributionList = 5

  • StickerPackRecord stickerPack = 6

  • CallLinkRecord callLink = 7

  • ChatFolderRecord chatFolder = 8

  • NotificationProfile notificationProfile = 9

Used in: StorageRecord

• bytes identifier = 1

• string name = 2

• repeated string recipientServiceIds = 3

• uint64 deletedAtTimestamp = 4

• bool allowsReplies = 5

• bool isBlockList = 6

• repeated bytes recipientServiceIdsBinary = 7

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: Content, SyncMessage.Sent

• optional bytes profileKey = 1

• optional GroupContextV2 group = 2

• oneof attachment

  • AttachmentPointer fileAttachment = 3

  • TextAttachment textAttachment = 4

• optional bool allowsReplies = 5

• repeated BodyRange bodyRanges = 6

Used in: Content

• oneof content

  • SyncMessage.Sent sent = 1

  • SyncMessage.Contacts contacts = 2

  • SyncMessage.Request request = 4

  • SyncMessage.Blocked blocked = 6

  • Verified verified = 7

  • SyncMessage.Configuration configuration = 9

  • SyncMessage.ViewOnceOpen viewOnceOpen = 11

  • SyncMessage.FetchLatest fetchLatest = 12

  • SyncMessage.Keys keys = 13

  • SyncMessage.MessageRequestResponse messageRequestResponse = 14

  • SyncMessage.OutgoingPayment outgoingPayment = 15

  • SyncMessage.PniChangeNumber pniChangeNumber = 18

  • SyncMessage.CallEvent callEvent = 19

  • SyncMessage.CallLinkUpdate callLinkUpdate = 20

  • SyncMessage.CallLogEvent callLogEvent = 21

  • SyncMessage.DeleteForMe deleteForMe = 22

  • SyncMessage.DeviceNameChange deviceNameChange = 23

  • SyncMessage.AttachmentBackfillRequest attachmentBackfillRequest = 24

  • SyncMessage.AttachmentBackfillResponse attachmentBackfillResponse = 25

  • SyncMessage.UsernameChange usernameChange = 26

• repeated SyncMessage.Read read = 5

  Protobufs don't allow `repeated` fields to be inside of `oneof` so while the fields below are mutually exclusive with the rest of the values above we have to place them outside of `oneof`.

• repeated SyncMessage.StickerPackOperation stickerPackOperation = 10

• repeated SyncMessage.Viewed viewed = 16

• optional bytes padding = 8

Used in: SyncMessage

• optional AddressableMessage targetMessage = 1

• optional ConversationIdentifier targetConversation = 2

Used in: SyncMessage

• optional AddressableMessage targetMessage = 1

• optional ConversationIdentifier targetConversation = 2

• oneof data

  • AttachmentBackfillResponse.AttachmentDataList attachments = 3

  • AttachmentBackfillResponse.Error error = 4

Used in: AttachmentDataList

• oneof data

  • AttachmentPointer attachment = 1

  • AttachmentData.Status status = 2

Used in: AttachmentData

• PENDING = 0

• TERMINAL_ERROR = 1

Used in: AttachmentBackfillResponse

• repeated AttachmentData attachments = 1

• optional AttachmentData longText = 2

Used in: AttachmentBackfillResponse

• MESSAGE_NOT_FOUND = 0

Used in: SyncMessage

• repeated string numbers = 1

  deprecated: this field will be removed in a future release.

• repeated string acis = 3

• repeated bytes groupIds = 2

  deprecated: this field will be removed in a future release.

• repeated bytes acisBinary = 4

  deprecated: this field will be removed in a future release.

• repeated Blocked.BlockedE164 blockedE164s = 5

• repeated Blocked.BlockedAci blockedAcis = 6

• repeated Blocked.BlockedGroup blockedGroups = 7

Used in: Blocked

• optional bytes aciBinary = 1

  16-byte UUID

• optional uint64 timestamp = 2

Used in: Blocked

• optional string e164 = 1

• optional uint64 timestamp = 2

Used in: Blocked

• optional bytes groupId = 1

• optional uint64 timestamp = 2

Used in: SyncMessage

• optional bytes conversationId = 1

  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/conversationId`.

• optional uint64 callId = 2

  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`.

• optional uint64 timestamp = 3

• optional CallEvent.Type type = 4

• optional CallEvent.Direction direction = 5

• optional CallEvent.Event event = 6

Used in: CallEvent

• UNKNOWN_DIRECTION = 0

• INCOMING = 1

• OUTGOING = 2

Used in: CallEvent

• UNKNOWN_EVENT = 0

• ACCEPTED = 1

• NOT_ACCEPTED = 2

• DELETE = 3

• OBSERVED = 4

Used in: CallEvent

• UNKNOWN_TYPE = 0

• AUDIO_CALL = 1

• VIDEO_CALL = 2

• GROUP_CALL = 3

• AD_HOC_CALL = 4

Used in: SyncMessage

• optional bytes rootKey = 1

• optional bytes adminPasskey = 2

• optional CallLinkUpdate.Type type = 3

  defaults to UPDATE

Used in: CallLinkUpdate

• UPDATE = 0

Used in: SyncMessage

• optional CallLogEvent.Type type = 1

• optional uint64 timestamp = 2

• optional bytes conversationId = 3

  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/conversationId`.

• optional uint64 callId = 4

  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`.

Used in: CallLogEvent

• CLEAR = 0

• MARKED_AS_READ = 1

• MARKED_AS_READ_IN_CONVERSATION = 2

• CLEAR_IN_CONVERSATION = 3

Used in: SyncMessage

• optional bool readReceipts = 1

• optional bool unidentifiedDeliveryIndicators = 2

• optional bool typingIndicators = 3

• optional bool linkPreviews = 6

Used in: SyncMessage

• optional AttachmentPointer blob = 1

• optional bool complete = 2

Used in: SyncMessage

• repeated DeleteForMe.MessageDeletes messageDeletes = 1

• repeated DeleteForMe.ConversationDelete conversationDeletes = 2

• repeated DeleteForMe.LocalOnlyConversationDelete localOnlyConversationDeletes = 3

• repeated DeleteForMe.AttachmentDelete attachmentDeletes = 4

Used in: DeleteForMe

• optional ConversationIdentifier conversation = 1

• optional AddressableMessage targetMessage = 2

• optional bytes clientUuid = 3

  The `clientUuid` from `AttachmentPointer`.

• optional bytes fallbackDigest = 4

  SHA256 hash of the (encrypted, padded, etc.) attachment blob on the CDN.

• optional bytes fallbackPlaintextHash = 5

  SHA256 hash of the plaintext content of the attachment.

Used in: DeleteForMe

• optional ConversationIdentifier conversation = 1

• repeated AddressableMessage mostRecentMessages = 2

• optional bool isFullDelete = 3

• repeated AddressableMessage mostRecentNonExpiringMessages = 4

Used in: DeleteForMe

• optional ConversationIdentifier conversation = 1

Used in: DeleteForMe

• optional ConversationIdentifier conversation = 1

• repeated AddressableMessage messages = 2

Used in: SyncMessage

• optional uint32 deviceId = 2

Used in: SyncMessage

• optional FetchLatest.Type type = 1

Used in: FetchLatest

• UNKNOWN = 0

• LOCAL_PROFILE = 1

• STORAGE_MANIFEST = 2

• SUBSCRIPTION_STATUS = 3

Used in: SyncMessage

• optional string accountEntropyPool = 3

• optional bytes mediaRootBackupKey = 4

Used in: SyncMessage

• optional string threadAci = 2

• optional bytes groupId = 3

• optional MessageRequestResponse.Type type = 4

• optional bytes threadAciBinary = 5

  16-byte UUID

Used in: MessageRequestResponse

• UNKNOWN = 0

• ACCEPT = 1

• DELETE = 2

• BLOCK = 3

• BLOCK_AND_DELETE = 4

• SPAM = 5

• BLOCK_AND_SPAM = 6

Used in: SyncMessage

• optional string recipientServiceId = 1

• optional string note = 2

• oneof attachment_identifier

  • OutgoingPayment.MobileCoin mobileCoin = 3

Used in: OutgoingPayment

• optional bytes recipientAddress = 1

• optional uint64 amountPicoMob = 2

• optional uint64 feePicoMob = 3

• optional bytes receipt = 4

• optional uint64 ledgerBlockTimestamp = 5

• optional uint64 ledgerBlockIndex = 6

• repeated bytes spentKeyImages = 7

• repeated bytes outputPublicKeys = 8

Used in: SyncMessage

• optional bytes identityKeyPair = 1

  Serialized libsignal-client IdentityKeyPair

• optional bytes signedPreKey = 2

  Serialized libsignal-client SignedPreKeyRecord

• optional bytes lastResortKyberPreKey = 5

  Serialized libsignal-client KyberPreKeyRecord

• optional uint32 registrationId = 3

• optional string newE164 = 4

  The e164 we have changed our number to

• optional bytes publicKey = 1

• optional bytes privateKey = 2

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

• optional bytes senderAciBinary = 4

  16-byte UUID

Used in: SyncMessage

• optional Request.Type type = 1

Used in: Request

• UNKNOWN = 0

• CONTACTS = 1

• BLOCKED = 3

• CONFIGURATION = 4

• KEYS = 5

Used in: SyncMessage

• optional string destinationE164 = 1

• optional string destinationServiceId = 7

• optional uint64 timestamp = 2

• optional DataMessage message = 3

• optional uint64 expirationStartTimestamp = 4

• repeated Sent.UnidentifiedDeliveryStatus unidentifiedStatus = 5

• optional bool isRecipientUpdate = 6

• optional StoryMessage storyMessage = 8

• repeated Sent.StoryMessageRecipient storyMessageRecipients = 9

• optional EditMessage editMessage = 10

• optional bytes destinationServiceIdBinary = 12

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: Sent

• optional string destinationServiceId = 1

• repeated string distributionListIds = 2

• optional bool isAllowedToReply = 3

• optional bytes destinationServiceIdBinary = 5

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: Sent

• optional string destinationServiceId = 3

• optional bool unidentified = 2

• optional bytes destinationPniIdentityKey = 5

  Only set for PNI destinations

• optional bytes destinationServiceIdBinary = 6

  service ID binary (i.e. 16 byte UUID for ACI, 1 byte prefix + 16 byte UUID for PNI)

Used in: SyncMessage

• optional bytes packId = 1

• optional bytes packKey = 2

• optional StickerPackOperation.Type type = 3

Used in: StickerPackOperation

• INSTALL = 0

• REMOVE = 1

Used in: SyncMessage

(message has no fields)

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

• optional bytes senderAciBinary = 4

  16-byte UUID

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

• optional bytes senderAciBinary = 4

  16-byte UUID

Used in: StoryMessage

• optional string text = 1

• optional TextAttachment.Style textStyle = 2

• optional uint32 textForegroundColor = 3

  integer representation of hex color

• optional uint32 textBackgroundColor = 4

• optional Preview preview = 5

• oneof background

  • TextAttachment.Gradient gradient = 6

  • uint32 color = 7

Color ordering: 0 degrees: bottom-to-top 90 degrees: left-to-right 180 degrees: top-to-bottom 270 degrees: right-to-left

Used in: TextAttachment

• 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.

• optional uint32 angle = 3

  degrees

• repeated uint32 colors = 4

• repeated float positions = 5

  percent from 0 to 1

Used in: TextAttachment

• DEFAULT = 0

• REGULAR = 1

• BOLD = 2

• SERIF = 3

• SCRIPT = 4

• CONDENSED = 5

Used in: Content

• optional uint64 timestamp = 1

• optional TypingMessage.Action action = 2

• optional bytes groupId = 3

Used in: TypingMessage

• STARTED = 0

• STOPPED = 1

Used in: SyncMessage

• optional string destinationAci = 5

• optional bytes identityKey = 2

• optional Verified.State state = 3

• optional bytes nullMessage = 4

• optional bytes destinationAciBinary = 6

  16-byte UUID

Used in: Verified

• DEFAULT = 0

• VERIFIED = 1

• UNVERIFIED = 2

• optional WebSocketMessage.Type type = 1

• optional WebSocketRequestMessage request = 2

• optional WebSocketResponseMessage response = 3

Used in: WebSocketMessage

• UNKNOWN = 0

• REQUEST = 1

• RESPONSE = 2

Used in: WebSocketMessage

• optional string verb = 1

• optional string path = 2

• optional bytes body = 3

• repeated string headers = 5

• optional uint64 id = 4

Used in: WebSocketMessage

• optional uint64 id = 1

• optional uint32 status = 2

• optional string message = 3

• repeated string headers = 5

• optional bytes body = 4

• optional StorageManifest manifest = 1

• repeated StorageItem insertItem = 2

• repeated bytes deleteKey = 3

• bool clearAll = 4