package org.signal.chat.messages
Get desktop application:
View/edit binary Protocol Buffers messages
service Messages
messages.proto:22Provides methods for sending "unsealed sender" messages.
rpc GetMessages (stream , stream )
messages.proto:51Retrieve messages for the authenticated device. When the caller receives and successfully processes a message returned in a GetMessagesResponse they must send a corresponding GetMessagesRequest indicating that the message has been processed (an ack). Acks should only be sent for messages delivered via the currently open RPC. Only the first GetMessagesRequest may contain request parameters that configure the stream. The first request must not contain an ack. The server will keep the stream open until the client disconnects. Only one GetMessages stream may be open per device. If a second GetMessages stream is opened, the server may terminate any of the streams with a STREAM_CLOSED error reason. A GetMessagesStreamClosed message will be present in the error details.
message
messages.proto:54oneof request
options = 1
Configuration options for the message stream. Required for the first request of the stream, forbidden on subsequent reqeusts.
bytes server_guid_ack = 2
The server_guid of an envelope previously returned in a GetMessagesResponse that has been successfully processed by the caller. Forbidden on the first request of the stream, required on subsequent requests.
message
messages.proto:82oneof response
envelope = 1
A message. On successful receipt of an envelope the caller should ack the envelope by sending a GetMessagesRequest with the envelope's server guid. Acks should only be sent for envelopes received on the currently open RPC.
queue_empty = 2
An indicator that all outstanding messages for the device have been drained and acked by the client. The stream will remain open and continue to deliver newly arrived messages.
rpc SendMessage (, )
messages.proto:31Sends an "unsealed sender" message to all devices linked to a single destination account. The destination account must not be the same as the authenticated caller. Callers should use `SendSyncMessage` to send messages to themselves.
message
messages.proto:189optional destination = 1
The service identifier of the account to which to deliver the message.
bool ephemeral = 2
If true, this message will only be delivered to destination devices that have an active message delivery channel with a Signal server.
bool urgent = 3
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional messages = 4
The messages to send to the destination account.
rpc SendSyncMessage (, )
messages.proto:35Sends a "sync" message to all other devices linked to the authenticated sender's account.
message
messages.proto:231bool urgent = 1
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional messages = 2
The messages to send to the destination account.
Provides methods for sending "sealed sender" messages.
Sends a "sealed sender" message with a common payload to all devices linked to multiple destination accounts.
message
messages.proto:322bool ephemeral = 1
If true, this message will only be delivered to destination devices that have an active message delivery channel with a Signal server.
bool urgent = 2
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional message = 3
The multi-recipient message to send to all destination accounts and devices.
bytes group_send_token = 4
A group send endorsement token for the destination account.
Sends a story message with a common payload to devices linked to devices linked to multiple destination accounts.
message
messages.proto:341bool urgent = 1
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional message = 2
The multi-recipient story message to send to all destination accounts and devices.
Sends a "sealed sender" message to all devices linked to a single destination account. If this RPC is authorized with an unidentified access key, it will fail with an authorization failure if the credential is invalid OR if the destination account was not found. If it is authorized using a group send token, it will fail with an authorization failure if the credential is invalid and with an destination not found error if the account does not exist
message
messages.proto:242optional destination = 1
The service identifier of the account to which to deliver the message.
bool ephemeral = 2
If true, this message will only be delivered to destination devices that have an active message delivery channel with a Signal server.
bool urgent = 3
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional messages = 4
The messages to send to the destination account.
oneof authorization
A means to authorize the request.
bytes unidentified_access_key = 5
The unidentified access key (UAK) for the destination account.
bytes group_send_token = 6
A group send endorsement token for the destination account.
unrestricted_access = 7
The destination account allows unrestricted unidentified access
rpc SendStory (, )
messages.proto:118Sends a story message to devices linked to a single destination account.
message
messages.proto:273optional destination = 1
The service identifier of the account to which to deliver the message.
bool urgent = 2
Indicates whether this message is urgent and should trigger a high-priority notification if the destination device does not have an active message delivery channel with a Signal server
optional messages = 3
The messages to send to the destination account.
message
messages.proto:411Used in:
string token = 1
An opaque token identifying this challenge request. Clients must generally submit this token when submitting a challenge response.
repeated ChallengeRequired.ChallengeType challenge_options = 2
A list of challenge types callers may choose to complete to resolve the challenge requirement. May be empty, in which case callers cannot resolve the challenge by any means other than waiting.
optional uint64 retry_after_seconds = 3
A duration (in seconds) after which the challenge requirement may be resolved by simply waiting. May not be set if the challenge cannot be resolved by waiting.
Used in:
UNSPECIFIED = 0
CAPTCHA = 1
A challenge that callers can fulfill by completing a captcha.
PUSH_CHALLENGE = 2
A challenge that callers can fulfill by supplying a token delivered via push notification.
message
messages.proto:55Used in:
bool drop_stories = 1
If present and true, the server will not deliver any messages with the story flag set. This flag may only be set on the first GetMessagesRequest sent from the client to the server in an RPC stream.
message
messages.proto:75The reason why a GetMessages RPC is being closed by the server.
oneof reason
conflicting_stream = 1
Another caller has opened a GetMessages stream for the same device.
message
messages.proto:125Used in: , , , ,
uint64 timestamp = 1
The time, in milliseconds since the epoch, at which this message was originally sent from the perspective of the sender. Note that the maximum allowable timestamp for JavaScript clients is less than Long.MAX_VALUE; see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#the_epoch_timestamps_and_invalid_date for additional details and discussion.
map<uint32, > messages = 2
A map of device IDs to individual messages. Generally, callers must include one message for each device linked to the destination account. In cases of "sync messages" where a sender is distributing information to other devices linked to the sender's account, senders may omit a message for the sending device.
message
messages.proto:128A message for an individual device linked to a destination account.
Used in:
uint32 registration_id = 1
The registration ID for the destination device.
bytes payload = 2
The content of the message to deliver to the destination device.
256 KiB
SendMessageType type = 3
The message type of the message. If this message is part of an unidentified send, this must be UNIDENTIFIED_SENDER
message
messages.proto:379Used in: , , ,
optional service_identifier = 1
The service identifier to which the devices named in this object are linked.
repeated uint32 missing_devices = 2
A list of device IDs that are linked to the destination account, but were not included in the collection of messages bound for the destination account.
repeated uint32 extra_devices = 3
A list of device IDs that were included in the collection of messages bound for the destination account, but are not currently linked to the destination account.
repeated uint32 stale_devices = 4
A list of device IDs that present in the collection of messages bound for the destination account and are linked to the destination account, but have a different registration ID than the registration ID presented by the sender (indicating that the destination device has likely been replaced by another device).
message
messages.proto:309Used in: ,
uint64 timestamp = 1
The time, in milliseconds since the epoch, at which this message was originally sent from the perspective of the sender. Note that the maximum allowable timestamp for JavaScript clients is less than Long.MAX_VALUE; see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#the_epoch_timestamps_and_invalid_date for additional details and discussion.
bytes payload = 2
The serialized multi-recipient message payload.
256 KiB payload + (5000 * 100) of overhead
message
messages.proto:403Used in:
repeated mismatched_devices = 1
A list of sets of discrepancies between the destination devices identified in a request to send a message and the devices that are actually linked to a destination account.
message
messages.proto:353Used in:
repeated unresolved_recipients = 1
A list of destination service identifiers that could not be resolved to registered Signal accounts. The message in the original request was sent to all service identifiers/devices in the original request except for the destination devices associated with the service identifiers in this list.
message
messages.proto:207Used as response type in: Messages.SendMessage, Messages.SendSyncMessage
oneof response
The outcome of the message delivery
success = 1
The message was successfully delivered to all destination devices
mismatched_devices = 2
A list of discrepancies between the destination devices identified in a request to send a message and the devices that are actually linked to an account.
challenge_required = 3
A description of a challenge callers must complete before sending additional messages.
destination_not_found = 4
The destination account did not exist
message
messages.proto:287Used as response type in: MessagesAnonymous.SendSingleRecipientMessage, MessagesAnonymous.SendStory
oneof response
The outcome of the message delivery
success = 1
The message was successfully delivered to all destination devices
mismatched_devices = 2
A list of discrepancies between the destination devices identified in a request to send a message and the devices that are actually linked to an account.
failed_unidentified_authorization = 3
The provided unidentified authorization credential was invalid
destination_not_found = 4
The destination account did not exist
Used in:
UNSPECIFIED = 0
DOUBLE_RATCHET = 1
A double-ratchet message represents a "normal," "unsealed-sender" message encrypted using the Double Ratchet within an established Signal session.
PREKEY_MESSAGE = 2
A prekey message begins a new Signal session. The `content` of a prekey message is a superset of a double-ratchet message's `content` and contains the sender's identity public key and information identifying the pre-keys used in the message's ciphertext.
PLAINTEXT_CONTENT = 3
A plaintext message is used solely to convey encryption error receipts and never contains encrypted message content. Encryption error receipts must be delivered in plaintext because encryption/decryption of a prior message failed and there is no reason to believe that encryption/decryption of subsequent messages with the same key material would succeed. Critically, plaintext messages never have "real" message content generated by users. Plaintext messages include sender information.
UNIDENTIFIED_SENDER = 4
An unidentified sender message is an encrypted message. No other information about the type of the encrypted message is known to the server. Unidenitfied sender messages require an unidentified access token or a group send endorsement token to prove the unidentified sender is authorized to send messages to the destination.
message
messages.proto:361Used as response type in: MessagesAnonymous.SendMultiRecipientMessage, MessagesAnonymous.SendMultiRecipientStory
oneof response
The outcome of the message delivery
success = 1
The message was sent to at least some of the destination accounts/devices identified in the original request.
mismatched_devices = 2
A list of sets of discrepancies between the destination devices identified in a request to send a message and the devices that are actually linked to a destination account.
failed_unidentified_authorization = 3
The provided unidentified authorization credential was invalid