package signalservice

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Group

• AccessControl.AccessRequired attributes = 1

  Who can modify the group title, avatar, disappearing messages timer

• AccessControl.AccessRequired members = 2

  Who can add people to the group

• AccessControl.AccessRequired addFromInviteLink = 3

Used in: AccessControl, GroupChange.Actions.ModifyAddFromInviteLinkAccessControlAction, GroupChange.Actions.ModifyAttributesAccessControlAction, GroupChange.Actions.ModifyAvatarAccessControlAction, GroupChange.Actions.ModifyMembersAccessControlAction, GroupJoinInfo

• UNKNOWN = 0

• ANY = 1

• MEMBER = 2

  Any group member can make the modification

• ADMINISTRATOR = 3

  Only administrators can make the modification

• UNSATISFIABLE = 4

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

• uint32 universalExpireTimer = 17

• repeated string preferredReactionEmoji = 20

• bytes donorSubscriberId = 21

• string donorSubscriberCurrencyCode = 22

• bool displayBadgesOnProfile = 23

• bool donorSubscriptionManuallyCancelled = 24

• bool keepMutedChatsArchived = 25

• bool hasSetMyStoriesPrivacy = 26

• bool hasViewedOnboardingStory = 27

  Whether the user has opened and played back the

• bool storiesDisabled = 29

• OptionalBool storyViewReceiptsEnabled = 30

• bool hasSeenGroupStoryEducationSheet = 32

  Whether the user has seen the group story education

• string username = 33

  sheet. This is a sticky value.

  Format: `nickname.discriminator`, e.g. `signalapp.123`

• bool hasCompletedUsernameOnboarding = 34

  Updated only when username is confirmed or deleted on server.

  Whether the user has completed username

• optional AccountRecord.UsernameLink usernameLink = 35

  onboarding.

• optional bool hasBackup = 39

  Set to true after backups are enabled and one is uploaded.

• 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 uint64 backupTier = 1

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

• optional uint64 endedAtTimestamp = 2

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

• UNKNOWN = 0

• EVERYBODY = 1

• NOBODY = 2

Used in: AccountRecord

• oneof identifier

  • PinnedConversation.Contact contact = 1

  • bytes legacyGroupId = 3

  • bytes groupMasterKey = 4

Used in: PinnedConversation

• string serviceId = 1

• string e164 = 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

  color of the QR code itself

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

• optional uint64 sentTimestamp = 3

• optional bytes publicKey = 1

• optional bytes ciphertext = 2

• optional string username = 1

• optional string password = 2

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

  Next ID: 21

Our parser does not handle reserved in enums: DESKTOP-1569

• VOICE_MESSAGE = 1

• BORDERLESS = 2

• GIF = 8

  reserved 4;

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

• string key = 1

• string credential = 2

• string acl = 3

• string algorithm = 4

• string date = 5

• string policy = 6

• string signature = 7

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

Used in: BodyRange

• NONE = 0

• BOLD = 1

• ITALIC = 2

• SPOILER = 3

• STRIKETHROUGH = 4

• MONOSPACE = 5

• optional bytes aci_uak_pairs = 1

  Each ACI/UAK pair is a 32-byte buffer, containing the 16-byte ACI followed by its 16-byte UAK.

• optional bytes prev_e164s = 2

  Each E164 is an 8-byte big-endian number, as 8 bytes.

• optional bytes new_e164s = 3

• optional bytes discard_e164s = 4

• optional bool has_more = 5

  If true, the client has more pairs or e164s to send. If false or unset, this is the client's last request, and processing should commence.

• optional bytes token = 6

  If set, a token which allows rate limiting to discount the e164s in the request's prev_e164s, only counting new_e164s. If not set, then rate limiting considers both prev_e164s' and new_e164s' size.

• optional bool token_ack = 7

  After receiving a new token from the server, send back a message just containing a token_ack.

• optional bool return_acis_without_uaks = 8

  Request that, if the server allows, both ACI and PNI be returned even if the aci_uak_pairs don't match.

• optional bytes e164_pni_aci_triples = 1

  Each triple is an 8-byte e164, a 16-byte PNI, and a 16-byte ACI. If the e164 was not found, PNI and ACI are all zeros. If the PNI was found but the ACI was not, the PNI will be non-zero and the ACI will be all zeros. ACI will be returned if one of the returned PNIs has an ACI/UAK pair that matches. Should the request be successful (IE: a successful status returned), |e164_pni_aci_triple| will always equal |e164| of the request, so the entire marshalled size of the response will be (2+32)*|e164|, where the additional 2 bytes are the id/type/length additions of the protobuf marshaling added to each byte array. This avoids any data leakage based on the size of the encrypted output.

• optional bytes token = 3

  A token which allows subsequent calls' rate limiting to discount the e164s sent up in this request, only counting those in the next request's new_e164s.

Used in: StorageRecord

• bytes rootKey = 1

  16 bytes

• bytes adminPasskey = 2

  Non-empty when the current user is an admin

• uint64 deletedAtTimestampMs = 3

  When present and non-zero, `adminPasskey`

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 id = 1

• string name = 2

• uint32 position = 3

  Position order of folder, low-to-high from start-to-end

• 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 ChatFolderRecord.Recipient includedRecipients = 9

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

Used in: ChatFolderRecord

• oneof identifier

  • Recipient.Contact contact = 1

  • bytes legacyGroupId = 2

  • bytes groupMasterKey = 3

Used in: Recipient

• string serviceId = 1

• string e164 = 2

• optional string number = 1

• optional string aci = 9

• 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

  Next ID: 25

Used in: ContactRecord

• DEFAULT = 0

• VERIFIED = 1

• UNVERIFIED = 2

Used in: ContactRecord

• string given = 1

• string family = 2

• optional DataMessage dataMessage = 1

• optional SyncMessage syncMessage = 2

• optional CallMessage callMessage = 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

• optional EditMessage editMessage = 11

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

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

  NEXT ID: 24

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

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: DataMessage

• optional uint64 targetSentTimestamp = 1

• END_SESSION = 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

• INITIAL = 0

• MESSAGE_TIMERS = 1

• VIEW_ONCE = 2

• VIEW_ONCE_VIDEO = 3

• REACTIONS = 4

• CDN_SELECTOR_ATTACHMENTS = 5

• MENTIONS = 6

• PAYMENTS = 7

• CURRENT = 7

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

Used in: Quote

• optional string contentType = 1

• optional string fileName = 2

• optional AttachmentPointer thumbnail = 3

Used in: Quote

• NORMAL = 0

• GIFT_BADGE = 1

Used in: DataMessage

• optional string emoji = 1

• optional bool remove = 2

• optional string targetAuthorAci = 4

• optional uint64 targetSentTimestamp = 5

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

• optional Envelope.Type type = 1

• optional string sourceServiceId = 11

• optional uint32 sourceDevice = 7

• optional string destinationServiceId = 13

• optional uint64 timestamp = 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

Our parser does not handle reserved in enums: DESKTOP-1569

Used in: Envelope

• UNKNOWN = 0

• CIPHERTEXT = 1

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

• PREKEY_BUNDLE = 3

  reserved 2; reserved "KEY_EXCHANGE";

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

• SERVER_DELIVERY_RECEIPT = 5

  legacyMessage => [] AND content => []

• UNIDENTIFIED_SENDER = 6

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

• SENDERKEY_MESSAGE = 7

  legacyMessage => [] AND content => (version byte | SenderKeyMessage)

• PLAINTEXT_CONTENT = 8

  legacyMessage => [] AND content => (marker byte | Content)

• string token = 1

Used in: GroupChanges.GroupChangeState, GroupResponse

• bytes publicKey = 1

  GroupPublicParams

• bytes title = 2

  Encrypted title

• string avatar = 3

  Pointer to encrypted avatar (‘key’ from AvatarUploadAttributes)

• bytes disappearingMessagesTimer = 4

  Encrypted timer

• optional AccessControl accessControl = 5

• uint32 version = 6

  Current group version number

• repeated Member members = 7

• repeated MemberPendingProfileKey membersPendingProfileKey = 8

• repeated MemberPendingAdminApproval membersPendingAdminApproval = 9

• bytes inviteLinkPassword = 10

• bytes descriptionBytes = 11

• bool announcementsOnly = 12

• repeated MemberBanned membersBanned = 13

  next: 14

• oneof content

  • string title = 1

  • bytes avatar = 2

  • uint32 disappearingMessagesDuration = 3

  • string descriptionText = 4

Used in: GroupChangeResponse, GroupChanges.GroupChangeState

• bytes actions = 1

  The serialized actions

• bytes serverSignature = 2

  Server’s signature over serialized actions

• uint32 changeEpoch = 3

  Allows clients to decide whether their change logic can successfully apply this diff

• bytes sourceUserId = 1

  Who made the change

• uint32 version = 2

  The change version number

• bytes groupId = 25

  clients should not provide this value; the server will provide it in the response buffer to ensure the signature is binding to a particular group if clients set it during a request the server will respond with 400.

• repeated Actions.AddMemberAction addMembers = 3

  Members added

• repeated Actions.DeleteMemberAction deleteMembers = 4

  Members deleted

• repeated Actions.ModifyMemberRoleAction modifyMemberRoles = 5

  Modified member roles

• repeated Actions.ModifyMemberProfileKeyAction modifyMemberProfileKeys = 6

  Modified member profile keys

• repeated Actions.AddMemberPendingProfileKeyAction addPendingMembers = 7

  Pending members added

• repeated Actions.DeleteMemberPendingProfileKeyAction deletePendingMembers = 8

  Pending members deleted

• repeated Actions.PromoteMemberPendingProfileKeyAction promotePendingMembers = 9

  Pending invitations accepted

• optional Actions.ModifyTitleAction modifyTitle = 10

  Changed title

• optional Actions.ModifyAvatarAction modifyAvatar = 11

  Changed avatar

• optional Actions.ModifyDisappearingMessagesTimerAction modifyDisappearingMessagesTimer = 12

  Changed timer

• optional Actions.ModifyAttributesAccessControlAction modifyAttributesAccess = 13

  Changed attributes access control

• optional Actions.ModifyMembersAccessControlAction modifyMemberAccess = 14

  Changed membership access control

• optional Actions.ModifyAddFromInviteLinkAccessControlAction modifyAddFromInviteLinkAccess = 15

  change epoch = 1

• repeated Actions.AddMemberPendingAdminApprovalAction addMemberPendingAdminApprovals = 16

  change epoch = 1

• repeated Actions.DeleteMemberPendingAdminApprovalAction deleteMemberPendingAdminApprovals = 17

  change epoch = 1

• repeated Actions.PromoteMemberPendingAdminApprovalAction promoteMemberPendingAdminApprovals = 18

  change epoch = 1

• optional Actions.ModifyInviteLinkPasswordAction modifyInviteLinkPassword = 19

  change epoch = 1

• optional Actions.ModifyDescriptionAction modifyDescription = 20

  change epoch = 2

• optional Actions.ModifyAnnouncementsOnlyAction modifyAnnouncementsOnly = 21

  change epoch = 3

• repeated Actions.AddMemberBannedAction addMembersBanned = 22

  change epoch = 4

• repeated Actions.DeleteMemberBannedAction deleteMembersBanned = 23

  change epoch = 4

• repeated Actions.PromoteMemberPendingPniAciProfileKeyAction promoteMembersPendingPniAciProfileKey = 24

  change epoch = 5

Used in: Actions

• optional Member added = 1

• bool joinFromInviteLink = 2

Used in: Actions

• optional MemberBanned added = 1

Used in: Actions

• optional MemberPendingAdminApproval added = 1

Used in: Actions

• optional MemberPendingProfileKey added = 1

Used in: Actions

• bytes deletedUserId = 1

Used in: Actions

• bytes deletedUserId = 1

Used in: Actions

• bytes deletedUserId = 1

Used in: Actions

• bytes deletedUserId = 1

Used in: Actions

• AccessControl.AccessRequired addFromInviteLinkAccess = 1

Used in: Actions

• bool announcementsOnly = 1

Used in: Actions

• AccessControl.AccessRequired attributesAccess = 1

• AccessControl.AccessRequired avatarAccess = 1

Used in: Actions

• string avatar = 1

Used in: Actions

• bytes descriptionBytes = 1

Used in: Actions

• bytes timer = 1

Used in: Actions

• bytes inviteLinkPassword = 1

Used in: Actions

• bytes presentation = 1

• bytes user_id = 2

• bytes profile_key = 3

Used in: Actions

• bytes userId = 1

• Member.Role role = 2

Used in: Actions

• AccessControl.AccessRequired membersAccess = 1

Used in: Actions

• bytes title = 1

Used in: Actions

• bytes userId = 1

• Member.Role role = 2

Used in: Actions

• bytes presentation = 1

• bytes user_id = 2

• bytes pni = 3

• bytes profile_key = 4

Used in: Actions

• bytes presentation = 1

• bytes user_id = 2

• bytes profile_key = 3

• optional GroupChange groupChange = 1

• bytes groupSendEndorsementResponse = 2

• repeated GroupChanges.GroupChangeState groupChanges = 1

• bytes groupSendEndorsementResponse = 2

Used in: GroupChanges

• optional GroupChange groupChange = 1

• optional Group groupState = 2

Used in: DataMessage, StoryMessage

• optional bytes masterKey = 1

• optional uint32 revision = 2

• optional bytes groupChange = 3

• oneof contents

  • GroupInviteLink.GroupInviteLinkContentsV1 v1Contents = 1

Used in: GroupInviteLink

• bytes groupMasterKey = 1

• bytes inviteLinkPassword = 2

• bytes publicKey = 1

• bytes title = 2

• string avatar = 3

• uint32 memberCount = 4

• AccessControl.AccessRequired addFromInviteLink = 5

• uint32 version = 6

• bool pendingAdminApproval = 7

• bytes descriptionBytes = 8

• optional Group group = 1

• bytes groupSendEndorsementResponse = 2

Used in: StorageRecord

• bytes id = 1

Used in: StorageRecord

• bytes masterKey = 1

• bool blocked = 2

• bool whitelisted = 3

• bool archived = 4

• bool markedUnread = 5

• uint64 mutedUntilTimestamp = 6

• bool dontNotifyForMentionsIfMuted = 7

• bool hideStory = 8

• GroupV2Record.StorySendMode storySendMode = 10

• optional AvatarColor avatarColor = 11

Used in: GroupV2Record

• DEFAULT = 0

• DISABLED = 1

• ENABLED = 2

Used in: JumbomojiPack

• string name = 1

• bytes image = 2

• repeated JumbomojiItem items = 1

• 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

Used in: Group, GroupChange.Actions.AddMemberAction, MemberPendingProfileKey

• bytes userId = 1

  The UuidCiphertext

• Member.Role role = 2

• bytes profileKey = 3

  The ProfileKeyCiphertext

• bytes presentation = 4

  ProfileKeyCredentialPresentation

• uint32 joinedAtVersion = 5

  The Group.version this member joined at

Used in: GroupChange.Actions.ModifyMemberRoleAction, GroupChange.Actions.PromoteMemberPendingAdminApprovalAction, Member

• UNKNOWN = 0

• DEFAULT = 1

  Normal member

• ADMINISTRATOR = 2

  Group admin

Used in: Group, GroupChange.Actions.AddMemberBannedAction

• bytes userId = 1

• uint64 timestamp = 2

  ms since epoch

Used in: Group, GroupChange.Actions.AddMemberPendingAdminApprovalAction

• bytes userId = 1

• bytes profileKey = 2

• bytes presentation = 3

• uint64 timestamp = 4

Used in: Group, GroupChange.Actions.AddMemberPendingProfileKeyAction

• optional Member member = 1

  The “invited” member

• bytes addedByUserId = 2

  The UID who invited this member

• uint64 timestamp = 3

  The time the invitation occurred

Used in: Content

• optional bytes padding = 1

Used in: AccountRecord

• UNSET = 0

• ENABLED = 1

• DISABLED = 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 masterKey = 13

• optional bytes ephemeralBackupKey = 14

  32 bytes

• optional string accountEntropyPool = 15

• optional bytes mediaRootBackupKey = 16

  32-bytes

• optional string uuid = 1

• 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: UnidentifiedSenderMessage.Message

• optional bytes certificate = 1

• optional bytes signature = 2

• optional string senderE164 = 1

• optional string senderUuid = 6

• optional uint32 senderDevice = 2

• optional fixed64 expires = 3

• optional bytes identityKey = 4

• optional ServerCertificate signer = 5

Used in: SenderCertificate.Certificate

• optional bytes certificate = 1

• optional bytes signature = 2

• optional uint32 id = 1

• optional bytes key = 2

• optional string title = 1

• optional string author = 2

• optional StickerPack.Sticker cover = 3

• repeated StickerPack.Sticker stickers = 4

Used in: StickerPack

• optional uint32 id = 1

• optional string emoji = 2

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 descending 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

Used in: StorageRecord

• bytes identifier = 1

• string name = 2

• repeated string recipientServiceIds = 3

• uint64 deletedAtTimestamp = 4

• bool allowsReplies = 5

• bool isBlockList = 6

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

• optional SyncMessage.Sent sent = 1

• optional SyncMessage.Contacts contacts = 2

• optional SyncMessage.Request request = 4

• repeated SyncMessage.Read read = 5

• optional SyncMessage.Blocked blocked = 6

• optional Verified verified = 7

• optional SyncMessage.Configuration configuration = 9

• optional bytes padding = 8

• repeated SyncMessage.StickerPackOperation stickerPackOperation = 10

• optional SyncMessage.ViewOnceOpen viewOnceOpen = 11

• optional SyncMessage.FetchLatest fetchLatest = 12

• optional SyncMessage.Keys keys = 13

• optional SyncMessage.MessageRequestResponse messageRequestResponse = 14

• repeated SyncMessage.Viewed viewed = 16

• optional SyncMessage.PniChangeNumber pniChangeNumber = 18

• optional SyncMessage.CallEvent callEvent = 19

• optional SyncMessage.CallLinkUpdate callLinkUpdate = 20

• optional SyncMessage.CallLogEvent callLogEvent = 21

• optional SyncMessage.DeleteForMe deleteForMe = 22

• optional SyncMessage.DeviceNameChange deviceNameChange = 23

• optional SyncMessage.AttachmentBackfillRequest attachmentBackfillRequest = 24

• optional SyncMessage.AttachmentBackfillResponse attachmentBackfillResponse = 25

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

• repeated string acis = 3

• repeated bytes groupIds = 2

Used in: SyncMessage

• optional bytes peerId = 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/peerId`.

• 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 peerId = 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/peerId`.

• 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 uint32 provisioningVersion = 5

• 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 bytes master = 2

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

• optional string accountEntropyPool = 3

• optional bytes mediaRootBackupKey = 4

Used in: SyncMessage

• optional string threadAci = 2

• optional bytes groupId = 3

• optional MessageRequestResponse.Type type = 4

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

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

Used in: Sent

• optional string destinationServiceId = 1

• repeated string distributionListIds = 2

• optional bool isAllowedToReply = 3

Used in: Sent

• optional string destinationServiceId = 3

• optional bool unidentified = 2

• optional bytes destinationPniIdentityKey = 5

  Only set for PNI destinations

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

• optional string senderAci = 3

• optional uint64 timestamp = 2

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

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

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

• optional bytes ephemeralPublic = 1

• optional bytes encryptedStatic = 2

• optional bytes encryptedMessage = 3

• optional Message.Type type = 1

• optional SenderCertificate senderCertificate = 2

• optional bytes content = 3

• optional Message.ContentHint contentHint = 4

• optional bytes groupId = 5

Used in: Message

• DEFAULT = 0

  Show an error immediately; it was important but we can't retry.

• RESENDABLE = 1

  Sender will try to resend; delay any error UI if possible

• IMPLICIT = 2

  Don't show any error UI at all; this is something sent implicitly like a typing message or a receipt

Used in: Message

• PREKEY_MESSAGE = 1

• MESSAGE = 2

  Further cases should line up with Envelope.Type, even though old cases don't.

• SENDERKEY_MESSAGE = 7

• PLAINTEXT_CONTENT = 8

Used in: SyncMessage

• optional string destinationAci = 5

• optional bytes identityKey = 2

• optional Verified.State state = 3

• optional bytes nullMessage = 4

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