package SignalServiceProtos

Get desktop application:
View/edit binary Protocol Buffers messages

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

• optional fixed64 cdnId = 1

  oneof commented out because swift generated enum with associated values can't be converted to objc representation oneof attachment_identifier {

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

• VOICE_MESSAGE = 1

• BORDERLESS = 2

• GIF = 8

Used in: DataMessage, DataMessage.Quote, StoryMessage

• optional uint32 start = 1

• optional uint32 length = 2

• optional string mentionAci = 3

  oneof commented out because swift generated enum with associated values can't be converted to objc representation oneof associatedValue {

• optional BodyRange.Style style = 4

  }

Used in: BodyRange

• NONE = 0

• BOLD = 1

• ITALIC = 2

• SPOILER = 3

• STRIKETHROUGH = 4

• MONOSPACE = 5

Used in: Content

• optional CallMessage.Offer offer = 1

• optional CallMessage.Answer answer = 2

• repeated CallMessage.IceUpdate iceUpdate = 3

• optional CallMessage.Busy busy = 5

• optional bytes profileKey = 6

• optional CallMessage.Hangup hangup = 7

• optional uint32 destinationDeviceId = 9

• optional CallMessage.Opaque opaque = 10

Used in: CallMessage

• optional uint64 id = 1

  @required

• optional bytes opaque = 3

Used in: CallMessage

• optional uint64 id = 1

  @required

Used in: CallMessage

• optional uint64 id = 1

  @required

• 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

  @required

• optional bytes opaque = 5

Used in: CallMessage

• optional uint64 id = 1

  @required

• optional Offer.Type type = 3

• optional bytes opaque = 4

Used in: Offer

• OFFER_AUDIO_CALL = 0

• OFFER_VIDEO_CALL = 1

  next index 3, skip 2 – it was the unused "NEED_PERMISSION" type

Used in: CallMessage

• optional bytes data = 1

• optional Opaque.Urgency urgency = 2

Used in: Opaque

• DROPPABLE = 0

• HANDLE_IMMEDIATELY = 1

• optional string contactE164 = 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

• 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

  Serialized SKDM

• optional bytes decryptionErrorMessage = 8

  Serialized decryption error

• optional StoryMessage storyMessage = 9

• optional PniSignatureMessage pniSignatureMessage = 10

• optional EditMessage editMessage = 11

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

  NEXT ID: 27

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

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

  @required

• END_SESSION = 1

• EXPIRATION_TIMER_UPDATE = 2

• PROFILE_KEY_UPDATE = 4

Used in: DataMessage

• optional bytes receiptCredentialPresentation = 1

Used in: DataMessage

• optional string eraId = 1

Used in: DataMessage

• optional Payment.Notification notification = 1

  oneof commented out oneof Item {

• optional Payment.Activation activation = 2

Used in: Payment

• optional Activation.Type type = 1

Used in: Activation

• REQUEST = 0

• ACTIVATED = 1

• optional Amount.MobileCoin mobileCoin = 1

  oneof commented out oneof Amount {

  }

Used in: Amount

• optional uint64 picoMob = 1

  @required

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

Used in: Payment

• optional Notification.MobileCoin mobileCoin = 1

  oneof commented out oneof Transaction {

  }

• optional string note = 2

Used in: Notification

• optional bytes receipt = 1

  @required

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

Used in: DataMessage

• optional uint64 id = 1

  @required

• 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

  @required

• optional bool remove = 2

• optional string targetAuthorAci = 4

• optional uint64 timestamp = 5

  @required

Used in: DataMessage

• optional bytes packId = 1

  @required

• optional bytes packKey = 2

  @required

• optional uint32 stickerId = 3

  @required

• optional AttachmentPointer data = 4

  @required

• optional string emoji = 5

Used in: DataMessage

• optional string authorAci = 1

• optional uint64 sentTimestamp = 2

• optional bytes ratchetKey = 1

• optional uint64 timestamp = 2

• optional uint32 deviceId = 3

Used in: Content, SyncMessage.Sent

• optional uint64 targetSentTimestamp = 1

• optional DataMessage dataMessage = 2

• optional Envelope.Type type = 1

• optional uint32 sourceDevice = 7

• optional string destinationServiceId = 13

• optional uint64 timestamp = 5

  @required

• optional bytes content = 8

  Contains an encrypted Content

• optional string serverGuid = 9

  We may eventually want to make this required.

• optional uint64 serverTimestamp = 10

  We may eventually want to make this required.

• optional string sourceServiceId = 11

• 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

  On change-number sync messages delivered to linked devices, this will contain the account's new PNI.

• optional bool story = 16

• optional bytes spamReportingToken = 17

Used in: Envelope

• UNKNOWN = 0

• CIPHERTEXT = 1

• PREKEY_BUNDLE = 3

• RECEIPT = 5

• UNIDENTIFIED_SENDER = 6

• PLAINTEXT_CONTENT = 8

Used in: DataMessage, StoryMessage

• optional bytes masterKey = 1

• optional uint32 revision = 2

• optional bytes groupChange = 3

Used in: Content

• optional bytes padding = 1

• 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

  @required

• optional string emoji = 2

• optional string contentType = 3

• optional PaymentAddress.MobileCoin mobileCoin = 1

  oneof commented out oneof Address {

  }

Used in: PaymentAddress

• optional bytes publicAddress = 1

  @required

• optional bytes signature = 2

  @required

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

  @required

• optional string title = 2

• optional AttachmentPointer image = 3

• optional string previewDescription = 4

• optional uint64 date = 5

Used in: Content

• optional ReceiptMessage.Type type = 1

• repeated uint64 timestamp = 2

Used in: ReceiptMessage

• DELIVERY = 0

• READ = 1

• VIEWED = 2

Used in: Content, SyncMessage.Sent

• optional bytes profileKey = 1

• optional GroupContextV2 group = 2

• optional AttachmentPointer fileAttachment = 3

  oneof attachment {

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

• optional SyncMessage.OutgoingPayment outgoingPayment = 15

• 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

Used in: SyncMessage

• repeated string numbers = 1

• repeated string acis = 3

• repeated bytes groupIds = 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_ACTION = 0

• ACCEPTED = 1

• NOT_ACCEPTED = 2

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

• CLEARED = 0

• MARKED_AS_READ = 1

• MARKED_AS_READ_IN_CONVERSATION = 2

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

  @required

• optional bool isComplete = 2

  Signal-iOS renamed this property.

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: AttachmentDelete, ConversationDelete, MessageDeletes

• optional string authorServiceId = 1

  oneof author {

• optional string authorE164 = 2

• optional uint64 sentTimestamp = 3

  }

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

• repeated AddressableMessage mostRecentNonExpiringMessages = 4

• optional bool isFullDelete = 3

Used in: AttachmentDelete, ConversationDelete, LocalOnlyConversationDelete, MessageDeletes

• optional string threadServiceId = 1

  oneof identifier {

• optional bytes threadGroupId = 2

• optional string threadE164 = 3

  }

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

• 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 string recipientServiceId = 1

• optional string note = 2

• optional OutgoingPayment.MobileCoin mobileCoin = 3

  oneof attachment_identifier {

  }

Used in: OutgoingPayment

• optional bytes recipientAddress = 1

• optional uint64 amountPicoMob = 2

  @required

• optional uint64 feePicoMob = 3

  @required

• optional bytes receipt = 4

• optional uint64 ledgerBlockTimestamp = 5

• optional uint64 ledgerBlockIndex = 6

  @required

• 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

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

  @required

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

Used in: SyncMessage

• optional bytes packId = 1

  @required

• optional bytes packKey = 2

  @required

• optional StickerPackOperation.Type type = 3

Used in: StickerPackOperation

• INSTALL = 0

• REMOVE = 1

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

  @required

Used in: SyncMessage

• optional string senderAci = 3

• optional uint64 timestamp = 2

  @required

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

• optional TextAttachment.Gradient gradient = 6

  oneof background {

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

  @required

• 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

Used in: Verified

• DEFAULT = 0

• VERIFIED = 1

• UNVERIFIED = 2