package signalbackups

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Frame

• bytes profileKey = 1

• optional string username = 2

• optional AccountData.UsernameLink usernameLink = 3

• string givenName = 4

• string familyName = 5

• string avatarUrlPath = 6

• optional AccountData.SubscriberData donationSubscriberData = 7

• optional AccountData.AccountSettings accountSettings = 9

• optional AccountData.IAPSubscriberData backupsSubscriberData = 10

• string svrPin = 11

Used in: AccountData

• bool readReceipts = 1

• bool sealedSenderIndicators = 2

• bool typingIndicators = 3

• bool linkPreviews = 4

• bool notDiscoverableByPhoneNumber = 5

• bool preferContactAvatars = 6

• uint32 universalExpireTimerSeconds = 7

  0 means no universal expire timer.

• repeated string preferredReactionEmoji = 8

• bool displayBadgesOnProfile = 9

• bool keepMutedChatsArchived = 10

• bool hasSetMyStoriesPrivacy = 11

• bool hasViewedOnboardingStory = 12

• bool storiesDisabled = 13

• optional bool storyViewReceiptsEnabled = 14

• bool hasSeenGroupStoryEducationSheet = 15

• bool hasCompletedUsernameOnboarding = 16

• PhoneNumberSharingMode phoneNumberSharingMode = 17

• optional ChatStyle defaultChatStyle = 18

• repeated ChatStyle.CustomChatColor customChatColors = 19

• bool optimizeOnDeviceStorage = 20

• optional uint64 backupTier = 21

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

Used in: AccountData

• bytes subscriberId = 1

• oneof iapSubscriptionId

  If unset, importers should ignore the subscriber data without throwing an error.

  • string purchaseToken = 2

    Identifies an Android Play Store IAP subscription.

  • uint64 originalTransactionId = 3

    Identifies an iOS App Store IAP subscription.

Used in: AccountSettings

• UNKNOWN = 0

  Interpret as "Nobody"

• EVERYBODY = 1

• NOBODY = 2

Used in: AccountData

• bytes subscriberId = 1

• string currencyCode = 2

• bool manuallyCancelled = 3

Used in: AccountData

• 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

  Interpret as "Blue"

• BLUE = 1

• WHITE = 2

• GREY = 3

• OLIVE = 4

• GREEN = 5

• ORANGE = 6

• PINK = 7

• PURPLE = 8

Used in: Frame

• uint64 callId = 1

• uint64 recipientId = 2

  Refers to a `CallLink` recipient.

• AdHocCall.State state = 3

• uint64 callTimestamp = 4

Used in: AdHocCall

• UNKNOWN_STATE = 0

  Interpret as "Generic"

• GENERIC = 1

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: Contact, Group, Self

• A100 = 0

• A110 = 1

• A120 = 2

• A130 = 3

• A140 = 4

• A150 = 5

• A160 = 6

• A170 = 7

• A180 = 8

• A190 = 9

• A200 = 10

• A210 = 11

• uint64 version = 1

• uint64 backupTimeMs = 2

• bytes mediaRootBackupKey = 3

  32-byte random value generated when the backup is uploaded for the first time.

• string currentAppVersion = 4

• string firstAppVersion = 5

Used in: Text

• uint32 start = 1

  'start' and 'length' are measured in UTF-16 code units. They may refer to offsets in a longText attachment.

• uint32 length = 2

• oneof associatedValue

  If unset, importers should ignore the body range without throwing an error.

  • bytes mentionAci = 3

  • BodyRange.Style style = 4

Used in: BodyRange

• NONE = 0

  Importers should ignore the body range without throwing an error.

• BOLD = 1

• ITALIC = 2

• SPOILER = 3

• STRIKETHROUGH = 4

• MONOSPACE = 5

* Call Links have some associated data including a call, but unlike other recipients are not tied to threads because they do not have messages associated with them. note: - room id can be derived from the root key - the presence of an admin key means this user is a call admin

Used in: Recipient

• bytes rootKey = 1

• optional bytes adminKey = 2

  Only present if the user is an admin

• string name = 3

• CallLink.Restrictions restrictions = 4

• uint64 expirationMs = 5

Used in: CallLink

• UNKNOWN = 0

  Interpret as "Admin Approval"

• NONE = 1

• ADMIN_APPROVAL = 2

Used in: Frame

• uint64 id = 1

  generated id for reference only within this file

• uint64 recipientId = 2

• bool archived = 3

• optional uint32 pinnedOrder = 4

  will be displayed in ascending order

• optional uint64 expirationTimerMs = 5

• optional uint64 muteUntilMs = 6

  INT64_MAX (2^63 - 1) = "always muted".

• bool markedUnread = 7

• bool dontNotifyForMentionsIfMuted = 8

• optional ChatStyle style = 9

• uint32 expireTimerVersion = 10

Used in: Frame

• string name = 1

• bool showOnlyUnread = 2

• bool showMutedChats = 3

• bool includeAllIndividualChats = 4

  Folder includes all 1:1 chats, unless excluded

• bool includeAllGroupChats = 5

  Folder includes all group chats, unless excluded

• ChatFolder.FolderType folderType = 6

• repeated uint64 includedRecipientIds = 7

  generated recipient id of groups, contacts, and/or note to self

• repeated uint64 excludedRecipientIds = 8

  generated recipient id of groups, contacts, and/or note to self

• bytes id = 9

  should be 16 bytes

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

Used in: ChatFolder

• UNKNOWN = 0

  Interpret as "Custom"

• ALL = 1

• CUSTOM = 2

Used in: Frame

• uint64 chatId = 1

  conversation id

• uint64 authorId = 2

  recipient id

• uint64 dateSent = 3

• optional uint64 expireStartDate = 4

  timestamp of when expiration timer started ticking down

• optional uint64 expiresInMs = 5

  how long timer of message is (ms)

• repeated ChatItem revisions = 6

  ordered from oldest to newest

• bool sms = 7

• oneof directionalDetails

  If unset, importers should skip this item without throwing an error.

  • ChatItem.IncomingMessageDetails incoming = 8

  • ChatItem.OutgoingMessageDetails outgoing = 9

  • ChatItem.DirectionlessMessageDetails directionless = 10

• oneof item

  If unset, importers should skip this item without throwing an error.

  • StandardMessage standardMessage = 11

  • ContactMessage contactMessage = 12

  • StickerMessage stickerMessage = 13

  • RemoteDeletedMessage remoteDeletedMessage = 14

  • ChatUpdateMessage updateMessage = 15

  • PaymentNotification paymentNotification = 16

  • GiftBadge giftBadge = 17

  • ViewOnceMessage viewOnceMessage = 18

  • DirectStoryReplyMessage directStoryReplyMessage = 19

    group story reply messages are not backed up

Used in: ChatItem

(message has no fields)

Used in: ChatItem

• uint64 dateReceived = 1

• optional uint64 dateServerSent = 2

• bool read = 3

• bool sealedSender = 4

Used in: ChatItem

• repeated SendStatus sendStatus = 1

Used in: AccountData.AccountSettings, Chat

• oneof wallpaper

  If unset, importers should consider there to be no wallpaper.

  • ChatStyle.WallpaperPreset wallpaperPreset = 1

  • FilePointer wallpaperPhoto = 2

    This `FilePointer` is expected not to contain a `fileName`, `width`, `height`, or `caption`.

• oneof bubbleColor

  If unset, importers should consider it to be AutomaticBubbleColor

  • ChatStyle.AutomaticBubbleColor autoBubbleColor = 3

    Bubble setting is automatically determined based on the wallpaper setting, or `SOLID_ULTRAMARINE` for `noWallpaper`

  • ChatStyle.BubbleColorPreset bubbleColorPreset = 4

  • uint64 customColorId = 5

    See AccountSettings.customChatColors

• bool dimWallpaperInDarkMode = 7

Used in: ChatStyle

(message has no fields)

Used in: ChatStyle

• UNKNOWN_BUBBLE_COLOR_PRESET = 0

  Interpret as the user's default chat bubble color

• SOLID_ULTRAMARINE = 1

• SOLID_CRIMSON = 2

• SOLID_VERMILION = 3

• SOLID_BURLAP = 4

• SOLID_FOREST = 5

• SOLID_WINTERGREEN = 6

• SOLID_TEAL = 7

• SOLID_BLUE = 8

• SOLID_INDIGO = 9

• SOLID_VIOLET = 10

• SOLID_PLUM = 11

• SOLID_TAUPE = 12

• SOLID_STEEL = 13

• GRADIENT_EMBER = 14

• GRADIENT_MIDNIGHT = 15

• GRADIENT_INFRARED = 16

• GRADIENT_LAGOON = 17

• GRADIENT_FLUORESCENT = 18

• GRADIENT_BASIL = 19

• GRADIENT_SUBLIME = 20

• GRADIENT_SEA = 21

• GRADIENT_TANGERINE = 22

Used in: AccountData.AccountSettings

• uint64 id = 1

• oneof color

  If unset, use the default chat color

  • fixed32 solid = 2

    0xAARRGGBB

  • Gradient gradient = 3

Used in: CustomChatColor

• uint32 angle = 1

  degrees

• repeated fixed32 colors = 2

  0xAARRGGBB

• repeated float positions = 3

  percent from 0 to 1

Used in: ChatStyle

• UNKNOWN_WALLPAPER_PRESET = 0

  Interpret as the wallpaper being unset

• SOLID_BLUSH = 1

• SOLID_COPPER = 2

• SOLID_DUST = 3

• SOLID_CELADON = 4

• SOLID_RAINFOREST = 5

• SOLID_PACIFIC = 6

• SOLID_FROST = 7

• SOLID_NAVY = 8

• SOLID_LILAC = 9

• SOLID_PINK = 10

• SOLID_EGGPLANT = 11

• SOLID_SILVER = 12

• GRADIENT_SUNSET = 13

• GRADIENT_NOIR = 14

• GRADIENT_HEATMAP = 15

• GRADIENT_AQUA = 16

• GRADIENT_IRIDESCENT = 17

• GRADIENT_MONSTERA = 18

• GRADIENT_BLISS = 19

• GRADIENT_SKY = 20

• GRADIENT_PEACH = 21

Used in: ChatItem

• oneof update

  If unset, importers should ignore the update message without throwing an error.

  • SimpleChatUpdate simpleUpdate = 1

  • GroupChangeChatUpdate groupChange = 2

  • ExpirationTimerChatUpdate expirationTimerChange = 3

  • ProfileChangeChatUpdate profileChange = 4

  • ThreadMergeChatUpdate threadMerge = 5

  • SessionSwitchoverChatUpdate sessionSwitchover = 6

  • IndividualCall individualCall = 7

  • GroupCall groupCall = 8

  • LearnedProfileChatUpdate learnedProfileChange = 9

Used in: Recipient

• optional bytes aci = 1

  should be 16 bytes

• optional bytes pni = 2

  should be 16 bytes

• optional string username = 3

• optional uint64 e164 = 4

• bool blocked = 5

• Contact.Visibility visibility = 6

• oneof registration

  If unset, consider the user to be registered

  • Contact.Registered registered = 7

  • Contact.NotRegistered notRegistered = 8

• optional bytes profileKey = 9

• bool profileSharing = 10

• optional string profileGivenName = 11

• optional string profileFamilyName = 12

• bool hideStory = 13

• optional bytes identityKey = 14

• Contact.IdentityState identityState = 15

• optional Contact.Name nickname = 16

  absent iff both `given` and `family` are empty

• string note = 17

• string systemGivenName = 18

• string systemFamilyName = 19

• string systemNickname = 20

• optional AvatarColor avatarColor = 21

Used in: Contact

• DEFAULT = 0

  A valid value -- indicates unset by the user

• VERIFIED = 1

• UNVERIFIED = 2

  Was once verified and is now unverified

Used in: Contact

• string given = 1

• string family = 2

Used in: Contact

• uint64 unregisteredTimestamp = 1

Used in: Contact

(message has no fields)

Used in: Contact

• VISIBLE = 0

  A valid value -- the contact is not hidden

• HIDDEN = 1

• HIDDEN_MESSAGE_REQUEST = 2

Used in: ContactMessage

• optional ContactAttachment.Name name = 1

• repeated ContactAttachment.Phone number = 3

• repeated ContactAttachment.Email email = 4

• repeated ContactAttachment.PostalAddress address = 5

• optional FilePointer avatar = 6

• string organization = 7

Used in: ContactAttachment

• string value = 1

• Email.Type type = 2

• string label = 3

Used in: Email

• UNKNOWN = 0

  Intepret as "Home"

• HOME = 1

• MOBILE = 2

• WORK = 3

• CUSTOM = 4

Used in: ContactAttachment

• string givenName = 1

• string familyName = 2

• string prefix = 3

• string suffix = 4

• string middleName = 5

• string nickname = 6

Used in: ContactAttachment

• string value = 1

• Phone.Type type = 2

• string label = 3

Used in: Phone

• UNKNOWN = 0

  Interpret as "Home"

• HOME = 1

• MOBILE = 2

• WORK = 3

• CUSTOM = 4

Used in: ContactAttachment

• PostalAddress.Type type = 1

• string label = 2

• string street = 3

• string pobox = 4

• string neighborhood = 5

• string city = 6

• string region = 7

• string postcode = 8

• string country = 9

Used in: PostalAddress

• UNKNOWN = 0

  Interpret as "Home"

• HOME = 1

• WORK = 2

• CUSTOM = 3

Used in: ChatItem

• optional ContactAttachment contact = 1

• repeated Reaction reactions = 2

Used in: ChatItem

• oneof reply

  If unset, importers should ignore the message without throwing an error.

  • DirectStoryReplyMessage.TextReply textReply = 1

  • string emoji = 2

• repeated Reaction reactions = 3

Used in: DirectStoryReplyMessage

• optional Text text = 1

• optional FilePointer longText = 2

Used in: DistributionListItem

• string name = 1

• bool allowReplies = 2

• DistributionList.PrivacyMode privacyMode = 3

• repeated uint64 memberRecipientIds = 4

  generated recipient id

Used in: DistributionList

• UNKNOWN = 0

  Interpret as "Only with"

• ONLY_WITH = 1

• ALL_EXCEPT = 2

• ALL = 3

Used in: Recipient

• bytes distributionId = 1

  distribution ids are UUIDv4s. "My Story" is represented by an all-0 UUID (00000000-0000-0000-0000-000000000000).

  distribution list ids are uuids

• oneof item

  If unset, importers should skip the item entirely without showing an error.

  • uint64 deletionTimestamp = 2

  • DistributionList distributionList = 3

For 1:1 chat updates only. For group thread updates use GroupExpirationTimerUpdate.

Used in: ChatUpdateMessage

• uint64 expiresInMs = 1

  0 means the expiration timer was disabled

Used in: ChatStyle, ContactAttachment, DirectStoryReplyMessage.TextReply, LinkPreview, MessageAttachment, StandardMessage, Sticker

• oneof locator

  If unset, importers should consider it to be an InvalidAttachmentLocator without throwing an error. DEPRECATED; use locatorInfo instead.

  • FilePointer.BackupLocator backupLocator = 1

  • FilePointer.AttachmentLocator attachmentLocator = 2

  • FilePointer.InvalidAttachmentLocator invalidAttachmentLocator = 3

  • FilePointer.LocalLocator localLocator = 12

• optional string contentType = 4

• optional bytes incrementalMac = 5

• optional uint32 incrementalMacChunkSize = 6

• optional string fileName = 7

• optional uint32 width = 8

• optional uint32 height = 9

• optional string caption = 10

• optional string blurHash = 11

• optional FilePointer.LocatorInfo locatorInfo = 13

References attachments in the transit storage tier. May be downloaded or not when the backup is generated; primarily for free-tier users who cannot copy the attachments to the backup (media) storage tier. DEPRECATED; use LocatorInfo instead if available.

Used in: FilePointer

• string cdnKey = 1

• uint32 cdnNumber = 2

• optional uint64 uploadTimestamp = 3

• bytes key = 4

• bytes digest = 5

• uint32 size = 6

References attachments in the backup (media) storage tier. DEPRECATED; use LocatorInfo instead if available.

Used in: FilePointer

• string mediaName = 1

• optional uint32 cdnNumber = 2

  If present, the cdn number of the succesful upload. If empty/0, may still have been uploaded, and clients can discover the cdn number via the list endpoint.

• bytes key = 3

• bytes digest = 4

• uint32 size = 5

• optional string transitCdnKey = 6

  Fallback in case backup tier upload failed.

• optional uint32 transitCdnNumber = 7

References attachments that are invalid in such a way where download cannot be attempted. Could range from missing digests to missing CDN keys or anything else that makes download attempts impossible. This serves as a 'tombstone' so that the UX can show that an attachment did exist, but for whatever reason it's not retrievable. DEPRECATED; use LocatorInfo instead if available.

Used in: FilePointer

(message has no fields)

References attachments in a local encrypted backup. Importers should first attempt to read the file from the local backup, and on failure fallback to backup and transit cdn if possible. DEPRECATED; use LocatorInfo instead if available.

Used in: FilePointer

• string mediaName = 1

• optional bytes localKey = 2

  Separate key used to encrypt this file for the local backup. Generally required. Missing field indicates attachment was not available locally when the backup was generated, but remote backup or transit info was available.

• bytes remoteKey = 3

• bytes remoteDigest = 4

• uint32 size = 5

• optional uint32 backupCdnNumber = 6

• optional string transitCdnKey = 7

• optional uint32 transitCdnNumber = 8

Used in: FilePointer

• bytes key = 1

  Must be non-empty if transitCdnKey or plaintextHash are set/nonempty. Otherwise must be empty.

• bytes legacyDigest = 2

  From the sender of the attachment (incl. ourselves) Will be reserved once all clients start reading integrityCheck

• oneof integrityCheck

  • bytes plaintextHash = 10

    Set if file was at one point downloaded and its plaintextHash was calculated

  • bytes encryptedDigest = 11

    Set if file has not been downloaded so its integrity has not been verified From the sender of the attachment

• uint32 size = 3

  NB: This is the plaintext size, and empty content attachments are legal, so this may be zero even if transitCdnKey or mediaName are set/nonempty.

• optional string transitCdnKey = 4

  Either both transit cdn key and number are set or neither should be set. Upload timestamp is optional but should only be set if key/number are set.

• optional uint32 transitCdnNumber = 5

• optional uint64 transitTierUploadTimestamp = 6

• optional uint32 mediaTierCdnNumber = 7

  If present, the cdn number of the succesful upload to media tier. If unset, may still have been uploaded, and clients can discover the cdn number via the list endpoint. Exporting clients should set this as long as their subscription has not rotated since last upload; even if currently free tier.

• string legacyMediaName = 8

  Nonempty any time the attachment was downloaded and its digest validated, whether free tier or paid subscription. Will be reserved once all clients start reading integrityCheck, when mediaName will be derived from the plaintextHash and encryption key

• optional bytes localKey = 9

  Separate key used to encrypt this file for the local backup. Generally required for local backups. Missing field indicates attachment was not available locally when the backup was generated, but remote backup or transit info was available.

Frames must follow in the following ordering rules: 1. There is exactly one AccountData and it is the first frame. 2. A frame referenced by ID must come before the referencing frame. e.g. a Recipient must come before any Chat referencing it. 3. All ChatItems must appear in global Chat rendering order. (The order in which they were received by the client.) 4. ChatFolders must appear in render order (e.g., left to right for LTR locales), but can appear anywhere relative to other frames respecting rule 2 (after Recipients and Chats). Recipients, Chats, StickerPacks, AdHocCalls, and NotificationProfiles can be in any order. (But must respect rule 2.) For example, Chats may all be together at the beginning, or may each immediately precede its first ChatItem.

• oneof item

  If unset, importers should skip this frame without throwing an error.

  • AccountData account = 1

  • Recipient recipient = 2

  • Chat chat = 3

  • ChatItem chatItem = 4

  • StickerPack stickerPack = 5

  • AdHocCall adHocCall = 6

  • NotificationProfile notificationProfile = 7

  • ChatFolder chatFolder = 8

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

Used in: ChatItem

• bytes receiptCredentialPresentation = 1

• GiftBadge.State state = 2

Used in: GiftBadge

• UNOPENED = 0

  A valid state

• OPENED = 1

• REDEEMED = 2

• FAILED = 3

Used in: Recipient

• bytes masterKey = 1

• bool whitelisted = 2

• bool hideStory = 3

• Group.StorySendMode storySendMode = 4

• optional Group.GroupSnapshot snapshot = 5

• bool blocked = 6

• optional AvatarColor avatarColor = 7

Used in: GroupSnapshot

• AccessControl.AccessRequired attributes = 1

• AccessControl.AccessRequired members = 2

• AccessControl.AccessRequired addFromInviteLink = 3

Used in: AccessControl

• UNKNOWN = 0

  Intepret as "Unsatisfiable"

• ANY = 1

• MEMBER = 2

• ADMINISTRATOR = 3

• UNSATISFIABLE = 4

Used in: GroupSnapshot

• oneof content

  If unset, consider the field it represents to not be present

  • string title = 1

  • bytes avatar = 2

  • uint32 disappearingMessagesDuration = 3

  • string descriptionText = 4

These are simply plaintext copies of the groups proto from Groups.proto. They should be kept completely in-sync with Groups.proto. These exist to allow us to have the latest snapshot of a group during restoration without having to hit the network. We would use Groups.proto if we could, but we want a plaintext version to improve export readability. For documentation, defer to Groups.proto. The only name change is Group -> GroupSnapshot to avoid the naming conflict.

Used in: Group

• optional GroupAttributeBlob title = 2

• optional GroupAttributeBlob description = 11

• string avatarUrl = 3

• optional GroupAttributeBlob disappearingMessagesTimer = 4

• optional AccessControl accessControl = 5

• uint32 version = 6

• repeated Member members = 7

• repeated MemberPendingProfileKey membersPendingProfileKey = 8

• repeated MemberPendingAdminApproval membersPendingAdminApproval = 9

• bytes inviteLinkPassword = 10

• bool announcements_only = 12

• repeated MemberBanned members_banned = 13

Used in: GroupSnapshot, MemberPendingProfileKey

• bytes userId = 1

• Member.Role role = 2

• uint32 joinedAtVersion = 5

Used in: Member

• UNKNOWN = 0

  Intepret as "Default"

• DEFAULT = 1

• ADMINISTRATOR = 2

Used in: GroupSnapshot

• bytes userId = 1

• uint64 timestamp = 2

Used in: GroupSnapshot

• bytes userId = 1

• uint64 timestamp = 4

Used in: GroupSnapshot

• optional Member member = 1

• bytes addedByUserId = 2

• uint64 timestamp = 3

Used in: Group

• DEFAULT = 0

  A valid value -- indicates unset by the user

• DISABLED = 1

• ENABLED = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bytes memberAci = 2

  The aci who had admin status granted or revoked.

• bool wasAdminStatusGranted = 3

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bool isAnnouncementOnly = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• GroupV2AccessLevel accessLevel = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bool wasRemoved = 2

Used in: ChatUpdateMessage

• optional uint64 callId = 1

• GroupCall.State state = 2

• optional uint64 ringerRecipientId = 3

• optional uint64 startedCallRecipientId = 4

• uint64 startedCallTimestamp = 5

• optional uint64 endedCallTimestamp = 6

  The time the call ended.

• bool read = 7

Used in: GroupCall

• UNKNOWN_STATE = 0

  Interpret as "Generic"

• GENERIC = 1

  A group call was started without ringing.

• JOINED = 2

  We joined a group call that was started without ringing.

• RINGING = 3

  An incoming group call is actively ringing.

• ACCEPTED = 4

  We accepted an incoming group ring.

• DECLINED = 5

  We declined an incoming group ring.

• MISSED = 6

  We missed an incoming group ring, for example because it expired.

• MISSED_NOTIFICATION_PROFILE = 7

  We auto-declined an incoming group ring due to a notification profile.

• OUTGOING_RING = 8

  An outgoing ring was started. We don't track any state for outgoing rings beyond that they started.

Used in: ChatUpdateMessage

• repeated GroupChangeChatUpdate.Update updates = 1

  Must be one or more; all updates batched together came from a single batched group state update.

Used in: GroupChangeChatUpdate

• oneof update

  If unset, importers should consider it to be a GenericGroupUpdate with unset updaterAci

  • GenericGroupUpdate genericGroupUpdate = 1

  • GroupCreationUpdate groupCreationUpdate = 2

  • GroupNameUpdate groupNameUpdate = 3

  • GroupAvatarUpdate groupAvatarUpdate = 4

  • GroupDescriptionUpdate groupDescriptionUpdate = 5

  • GroupMembershipAccessLevelChangeUpdate groupMembershipAccessLevelChangeUpdate = 6

  • GroupAttributesAccessLevelChangeUpdate groupAttributesAccessLevelChangeUpdate = 7

  • GroupAnnouncementOnlyChangeUpdate groupAnnouncementOnlyChangeUpdate = 8

  • GroupAdminStatusUpdate groupAdminStatusUpdate = 9

  • GroupMemberLeftUpdate groupMemberLeftUpdate = 10

  • GroupMemberRemovedUpdate groupMemberRemovedUpdate = 11

  • SelfInvitedToGroupUpdate selfInvitedToGroupUpdate = 12

  • SelfInvitedOtherUserToGroupUpdate selfInvitedOtherUserToGroupUpdate = 13

  • GroupUnknownInviteeUpdate groupUnknownInviteeUpdate = 14

  • GroupInvitationAcceptedUpdate groupInvitationAcceptedUpdate = 15

  • GroupInvitationDeclinedUpdate groupInvitationDeclinedUpdate = 16

  • GroupMemberJoinedUpdate groupMemberJoinedUpdate = 17

  • GroupMemberAddedUpdate groupMemberAddedUpdate = 18

  • GroupSelfInvitationRevokedUpdate groupSelfInvitationRevokedUpdate = 19

  • GroupInvitationRevokedUpdate groupInvitationRevokedUpdate = 20

  • GroupJoinRequestUpdate groupJoinRequestUpdate = 21

  • GroupJoinRequestApprovalUpdate groupJoinRequestApprovalUpdate = 22

  • GroupJoinRequestCanceledUpdate groupJoinRequestCanceledUpdate = 23

  • GroupInviteLinkResetUpdate groupInviteLinkResetUpdate = 24

  • GroupInviteLinkEnabledUpdate groupInviteLinkEnabledUpdate = 25

  • GroupInviteLinkAdminApprovalUpdate groupInviteLinkAdminApprovalUpdate = 26

  • GroupInviteLinkDisabledUpdate groupInviteLinkDisabledUpdate = 27

  • GroupMemberJoinedByLinkUpdate groupMemberJoinedByLinkUpdate = 28

  • GroupV2MigrationUpdate groupV2MigrationUpdate = 29

  • GroupV2MigrationSelfInvitedUpdate groupV2MigrationSelfInvitedUpdate = 30

  • GroupV2MigrationInvitedMembersUpdate groupV2MigrationInvitedMembersUpdate = 31

  • GroupV2MigrationDroppedMembersUpdate groupV2MigrationDroppedMembersUpdate = 32

  • GroupSequenceOfRequestsAndCancelsUpdate groupSequenceOfRequestsAndCancelsUpdate = 33

  • GroupExpirationTimerUpdate groupExpirationTimerUpdate = 34

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• optional string newDescription = 2

  Null value means the group description was removed.

For 1:1 timer updates, use ExpirationTimerChatUpdate.

Used in: GroupChangeChatUpdate.Update

• uint64 expiresInMs = 1

  0 means the expiration timer was disabled

• optional bytes updaterAci = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes inviterAci = 1

• bytes newMemberAci = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes inviterAci = 1

• optional bytes inviteeAci = 2

  Note: if invited by pni, just set inviteeAci to nil.

These invitees should never be the local user. Use GroupSelfInvitationRevokedUpdate in those cases. The inviter or updater can be the local user.

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

  The member that revoked the invite(s), not the inviter! Assumed to be an admin (at the time, may no longer be an admin or even a member).

• repeated GroupInvitationRevokedUpdate.Invitee invitees = 2

Used in: GroupInvitationRevokedUpdate

• optional bytes inviterAci = 1

• optional bytes inviteeAci = 2

  Prefer to use aci over pni. No need to set pni if aci is set. Both can be missing.

• optional bytes inviteePni = 3

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bool linkRequiresAdminApproval = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bool linkRequiresAdminApproval = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

Used in: GroupChangeChatUpdate.Update

• bytes requestorAci = 1

• optional bytes updaterAci = 2

  The aci that approved or rejected the request.

• bool wasApproved = 3

Used in: GroupChangeChatUpdate.Update

• bytes requestorAci = 1

Used in: GroupChangeChatUpdate.Update

• bytes requestorAci = 1

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• bytes newMemberAci = 2

• bool hadOpenInvitation = 3

• optional bytes inviterAci = 4

  If hadOpenInvitation is true, optionally include aci of the inviter.

Used in: GroupChangeChatUpdate.Update

• bytes newMemberAci = 1

Used in: GroupChangeChatUpdate.Update

• bytes newMemberAci = 1

Used in: GroupChangeChatUpdate.Update

• bytes aci = 1

Used in: GroupChangeChatUpdate.Update

• optional bytes removerAci = 1

• bytes removedAci = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• GroupV2AccessLevel accessLevel = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes updaterAci = 1

• optional string newGroupName = 2

  Null value means the group name was removed.

An invitation to self was revoked.

Used in: GroupChangeChatUpdate.Update

• optional bytes revokerAci = 1

A single requestor has requested to join and cancelled their request repeatedly with no other updates in between. The last action encompassed by this update is always a cancellation; if there was another open request immediately after, it will be a separate GroupJoinRequestUpdate, either in the same frame or in a subsequent frame.

Used in: GroupChangeChatUpdate.Update

• bytes requestorAci = 1

• uint32 count = 2

Used in: GroupChangeChatUpdate.Update

• optional bytes inviterAci = 1

  Can be the self user.

• uint32 inviteeCount = 2

Used in: GroupAttributesAccessLevelChangeUpdate, GroupMembershipAccessLevelChangeUpdate

• UNKNOWN = 0

  Interpret as "Unsatisfiable"

• ANY = 1

• MEMBER = 2

• ADMINISTRATOR = 3

• UNSATISFIABLE = 4

The local user migrated gv1->gv2 but was unable to add or invite some members and dropped them instead. (Happens for e164 members where we don't have an aci).

Used in: GroupChangeChatUpdate.Update

• uint32 droppedMembersCount = 1

The local user migrated gv1->gv2 but was unable to add some members and invited them instead. (Happens if we don't have the invitee's profile key)

Used in: GroupChangeChatUpdate.Update

• uint32 invitedMembersCount = 1

Another user migrated gv1->gv2 but was unable to add the local user and invited them instead.

Used in: GroupChangeChatUpdate.Update

(message has no fields)

A gv1->gv2 migration occurred.

Used in: GroupChangeChatUpdate.Update

(message has no fields)

Used in: ChatUpdateMessage

• optional uint64 callId = 1

• IndividualCall.Type type = 2

• IndividualCall.Direction direction = 3

• IndividualCall.State state = 4

• uint64 startedCallTimestamp = 5

• bool read = 6

Used in: IndividualCall

• UNKNOWN_DIRECTION = 0

  Interpret as "Incoming"

• INCOMING = 1

• OUTGOING = 2

Used in: IndividualCall

• UNKNOWN_STATE = 0

  Interpret as "Accepted"

• ACCEPTED = 1

• NOT_ACCEPTED = 2

• MISSED = 3

  An incoming call that is no longer ongoing, which we neither accepted not actively declined. For example, it expired, was canceled by the sender, or was rejected due to being in another call.

• MISSED_NOTIFICATION_PROFILE = 4

  We auto-declined an incoming call due to a notification profile.

Used in: IndividualCall

• UNKNOWN_TYPE = 0

  Interpret as "Audio call"

• AUDIO_CALL = 1

• VIDEO_CALL = 2

Used in: ChatUpdateMessage

• oneof previousName

  If unset, importers should consider the previous name to be an empty string.

  • uint64 e164 = 1

  • string username = 2

Used in: StandardMessage

• string url = 1

• optional string title = 2

• optional FilePointer image = 3

• optional string description = 4

• optional uint64 date = 5

A FilePointer on a message that has additional metadata that applies only to message attachments.

Used in: Quote.QuotedAttachment, StandardMessage, ViewOnceMessage

• optional FilePointer pointer = 1

• MessageAttachment.Flag flag = 2

• bool wasDownloaded = 3

• optional bytes clientUuid = 4

  Cross-client identifier for this attachment among all attachments on the owning message. See: SignalService.AttachmentPointer.clientUuid.

Similar to SignalService.AttachmentPointer.Flags, but explicitly mutually exclusive. Note the different raw values (non-zero starting values are not supported in proto3.)

Used in: MessageAttachment

• NONE = 0

  A valid value -- no flag applied

• VOICE_MESSAGE = 1

• BORDERLESS = 2

• GIF = 3

Used in: Frame

• string name = 1

• optional string emoji = 2

• fixed32 color = 3

  0xAARRGGBB

• uint64 createdAtMs = 4

• bool allowAllCalls = 5

• bool allowAllMentions = 6

• repeated uint64 allowedMembers = 7

  generated recipient id for allowed groups and contacts

• bool scheduleEnabled = 8

• uint32 scheduleStartTime = 9

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

• uint32 scheduleEndTime = 10

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

• repeated NotificationProfile.DayOfWeek scheduleDaysEnabled = 11

• bytes id = 12

  should be 16 bytes

Used in: NotificationProfile

• UNKNOWN = 0

  Interpret as "Monday"

• MONDAY = 1

• TUESDAY = 2

• WEDNESDAY = 3

• THURSDAY = 4

• FRIDAY = 5

• SATURDAY = 6

• SUNDAY = 7

Used in: ChatItem

• optional string amountMob = 1

  stored as a decimal string, e.g. 1.00001

• optional string feeMob = 2

  stored as a decimal string, e.g. 1.00001

• optional string note = 3

• optional PaymentNotification.TransactionDetails transactionDetails = 4

Used in: PaymentNotification

• oneof payment

  If unset, importers should treat the transaction as successful with no metadata.

  • TransactionDetails.Transaction transaction = 1

  • TransactionDetails.FailedTransaction failedTransaction = 2

Failed payments can't be synced from the ledger

Used in: TransactionDetails

• FailedTransaction.FailureReason reason = 1

Used in: FailedTransaction

• GENERIC = 0

  A valid value -- reason unknown

• NETWORK = 1

• INSUFFICIENT_FUNDS = 2

Used to map to payments on the ledger

Used in: Transaction

• repeated bytes publicKey = 1

  for received transactions

• repeated bytes keyImages = 2

  for sent transactions

Used in: TransactionDetails

• Transaction.Status status = 1

• optional MobileCoinTxoIdentification mobileCoinIdentification = 2

  This identification is used to map the payment table to the ledger and is likely required otherwise we may have issues reconciling with the ledger

• optional uint64 timestamp = 3

• optional uint64 blockIndex = 4

• optional uint64 blockTimestamp = 5

• optional bytes transaction = 6

  mobile coin blobs

• optional bytes receipt = 7

  mobile coin blobs

Used in: Transaction

• INITIAL = 0

  A valid value -- state unconfirmed

• SUBMITTED = 1

• SUCCESSFUL = 2

Used in: ChatUpdateMessage

• string previousName = 1

• string newName = 2

Used in: StandardMessage

• optional uint64 targetSentTimestamp = 1

  null if the target message could not be found at time of quote insert

• uint64 authorId = 2

• optional Text text = 3

• repeated Quote.QuotedAttachment attachments = 4

• Quote.Type type = 5

Used in: Quote

• optional string contentType = 1

• optional string fileName = 2

• optional MessageAttachment thumbnail = 3

Used in: Quote

• UNKNOWN = 0

  Interpret as "Normal"

• NORMAL = 1

• GIFT_BADGE = 2

• VIEW_ONCE = 3

Used in: ContactMessage, DirectStoryReplyMessage, StandardMessage, StickerMessage, ViewOnceMessage

• string emoji = 1

• uint64 authorId = 2

• uint64 sentTimestamp = 3

• uint64 sortOrder = 4

  A higher sort order means that a reaction is more recent. Some clients may export this as incrementing numbers (e.g. 1, 2, 3), others as timestamps.

Used in: Frame

• uint64 id = 1

  generated id for reference only within this file

• oneof destination

  If unset, importers should skip this frame without throwing an error.

  • Contact contact = 2

  • Group group = 3

  • DistributionListItem distributionList = 4

  • Self self = 5

  • ReleaseNotes releaseNotes = 6

  • CallLink callLink = 7

Used in: Recipient

(message has no fields)

Tombstone for remote delete

Used in: ChatItem

(message has no fields)

Used in: Recipient

• optional AvatarColor avatarColor = 1

Used in: GroupChangeChatUpdate.Update

• bytes inviteeServiceId = 1

  If no invitee id available, use GroupUnknownInviteeUpdate

Used in: GroupChangeChatUpdate.Update

• optional bytes inviterAci = 1

Used in: ChatItem.OutgoingMessageDetails

• uint64 recipientId = 1

• uint64 timestamp = 2

  the time the status was last updated -- if from a receipt, it should be the sentTime of the receipt

• oneof deliveryStatus

  If unset, importers should consider the status to be "pending"

  • SendStatus.Pending pending = 3

  • SendStatus.Sent sent = 4

  • SendStatus.Delivered delivered = 5

  • SendStatus.Read read = 6

  • SendStatus.Viewed viewed = 7

  • SendStatus.Skipped skipped = 8

  • SendStatus.Failed failed = 9

Used in: SendStatus

• bool sealedSender = 1

Used in: SendStatus

• Failed.FailureReason reason = 1

Used in: Failed

• UNKNOWN = 0

  A valid value -- could indicate a crash or lack of information

• NETWORK = 1

• IDENTITY_KEY_MISMATCH = 2

Used in: SendStatus

(message has no fields)

Used in: SendStatus

• bool sealedSender = 1

Used in: SendStatus

• bool sealedSender = 1

e.g. user in group was blocked, so we skipped sending to them

Used in: SendStatus

(message has no fields)

Used in: SendStatus

• bool sealedSender = 1

Used in: ChatUpdateMessage

• uint64 e164 = 1

Used in: ChatUpdateMessage

• SimpleChatUpdate.Type type = 1

Used in: SimpleChatUpdate

• UNKNOWN = 0

  Importers should skip the update without throwing an error.

• JOINED_SIGNAL = 1

• IDENTITY_UPDATE = 2

• IDENTITY_VERIFIED = 3

• IDENTITY_DEFAULT = 4

  marking as unverified

• CHANGE_NUMBER = 5

• RELEASE_CHANNEL_DONATION_REQUEST = 6

• END_SESSION = 7

• CHAT_SESSION_REFRESH = 8

• BAD_DECRYPT = 9

• PAYMENTS_ACTIVATED = 10

• PAYMENT_ACTIVATION_REQUEST = 11

• UNSUPPORTED_PROTOCOL_MESSAGE = 12

• REPORTED_SPAM = 13

• BLOCKED = 14

• UNBLOCKED = 15

• MESSAGE_REQUEST_ACCEPTED = 16

Used in: ChatItem

• optional Quote quote = 1

• optional Text text = 2

• repeated MessageAttachment attachments = 3

• repeated LinkPreview linkPreview = 4

• optional FilePointer longText = 5

• repeated Reaction reactions = 6

Used in: StickerMessage

• bytes packId = 1

• bytes packKey = 2

• uint32 stickerId = 3

• optional string emoji = 4

• optional FilePointer data = 5

  Stickers are uploaded to be sent as attachments; we also back them up as normal attachments when they are in messages. DO NOT treat this as the definitive source of a sticker in an installed StickerPack that shares the same packId.

Used in: ChatItem

• optional Sticker sticker = 1

• repeated Reaction reactions = 2

Used in: Frame

• bytes packId = 1

• bytes packKey = 2

Used in: DirectStoryReplyMessage.TextReply, Quote, StandardMessage

• string body = 1

• repeated BodyRange bodyRanges = 2

Used in: ChatUpdateMessage

• uint64 previousE164 = 1

Used in: ChatItem

• optional MessageAttachment attachment = 1

  Will be null for viewed messages

• repeated Reaction reactions = 2