API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

App

Manage Beeper account setup and encrypted messaging setup

ModelsExpand Collapse

type RecoveryKeyResetResponse struct{…}

RecoveryKey string

New recovery key. Show it once and ask the user to save it.

Session RecoveryKeyResetResponseSession

Current app sign-in and encrypted messaging setup state after creating the new recovery key.

E2EE RecoveryKeyResetResponseSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets RecoveryKeyResetResponseSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

const RecoveryKeyResetResponseSessionStateNeedsLogin RecoveryKeyResetResponseSessionState = "needs-login"

const RecoveryKeyResetResponseSessionStateInitializing RecoveryKeyResetResponseSessionState = "initializing"

const RecoveryKeyResetResponseSessionStateNeedsCrossSigningSetup RecoveryKeyResetResponseSessionState = "needs-cross-signing-setup"

const RecoveryKeyResetResponseSessionStateNeedsVerification RecoveryKeyResetResponseSessionState = "needs-verification"

const RecoveryKeyResetResponseSessionStateNeedsSecrets RecoveryKeyResetResponseSessionState = "needs-secrets"

const RecoveryKeyResetResponseSessionStateNeedsFirstSync RecoveryKeyResetResponseSessionState = "needs-first-sync"

const RecoveryKeyResetResponseSessionStateReady RecoveryKeyResetResponseSessionState = "ready"

Matrix RecoveryKeyResetResponseSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification RecoveryKeyResetResponseSessionVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const RecoveryKeyResetResponseSessionVerificationAvailableActionAccept RecoveryKeyResetResponseSessionVerificationAvailableAction = "accept"

const RecoveryKeyResetResponseSessionVerificationAvailableActionCancel RecoveryKeyResetResponseSessionVerificationAvailableAction = "cancel"

const RecoveryKeyResetResponseSessionVerificationAvailableActionQRConfirmScanned RecoveryKeyResetResponseSessionVerificationAvailableAction = "qr.confirmScanned"

const RecoveryKeyResetResponseSessionVerificationAvailableActionSASStart RecoveryKeyResetResponseSessionVerificationAvailableAction = "sas.start"

const RecoveryKeyResetResponseSessionVerificationAvailableActionSASConfirm RecoveryKeyResetResponseSessionVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const RecoveryKeyResetResponseSessionVerificationDirectionIncoming RecoveryKeyResetResponseSessionVerificationDirection = "incoming"

const RecoveryKeyResetResponseSessionVerificationDirectionOutgoing RecoveryKeyResetResponseSessionVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const RecoveryKeyResetResponseSessionVerificationMethodQR RecoveryKeyResetResponseSessionVerificationMethod = "qr"

const RecoveryKeyResetResponseSessionVerificationMethodSAS RecoveryKeyResetResponseSessionVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const RecoveryKeyResetResponseSessionVerificationPurposeLogin RecoveryKeyResetResponseSessionVerificationPurpose = "login"

const RecoveryKeyResetResponseSessionVerificationPurposeDevice RecoveryKeyResetResponseSessionVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const RecoveryKeyResetResponseSessionVerificationStateRequested RecoveryKeyResetResponseSessionVerificationState = "requested"

const RecoveryKeyResetResponseSessionVerificationStateReady RecoveryKeyResetResponseSessionVerificationState = "ready"

const RecoveryKeyResetResponseSessionVerificationStateSASReady RecoveryKeyResetResponseSessionVerificationState = "sas_ready"

const RecoveryKeyResetResponseSessionVerificationStateQRScanned RecoveryKeyResetResponseSessionVerificationState = "qr_scanned"

const RecoveryKeyResetResponseSessionVerificationStateDone RecoveryKeyResetResponseSessionVerificationState = "done"

const RecoveryKeyResetResponseSessionVerificationStateCancelled RecoveryKeyResetResponseSessionVerificationState = "cancelled"

const RecoveryKeyResetResponseSessionVerificationStateError RecoveryKeyResetResponseSessionVerificationState = "error"

Error RecoveryKeyResetResponseSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice RecoveryKeyResetResponseSessionVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR RecoveryKeyResetResponseSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS RecoveryKeyResetResponseSessionVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

type SetupCompleteResponse struct{…}

Matrix SetupCompleteResponseMatrix

Account credentials for first-party app setup.

AccessToken string

Beeper account access token. Returned once for first-party app setup.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Session SetupCompleteResponseSession

Current app sign-in and encrypted messaging setup state after sign-in.

E2EE SetupCompleteResponseSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets SetupCompleteResponseSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

const SetupCompleteResponseSessionStateNeedsLogin SetupCompleteResponseSessionState = "needs-login"

const SetupCompleteResponseSessionStateInitializing SetupCompleteResponseSessionState = "initializing"

const SetupCompleteResponseSessionStateNeedsCrossSigningSetup SetupCompleteResponseSessionState = "needs-cross-signing-setup"

const SetupCompleteResponseSessionStateNeedsVerification SetupCompleteResponseSessionState = "needs-verification"

const SetupCompleteResponseSessionStateNeedsSecrets SetupCompleteResponseSessionState = "needs-secrets"

const SetupCompleteResponseSessionStateNeedsFirstSync SetupCompleteResponseSessionState = "needs-first-sync"

const SetupCompleteResponseSessionStateReady SetupCompleteResponseSessionState = "ready"

Matrix SetupCompleteResponseSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification SetupCompleteResponseSessionVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const SetupCompleteResponseSessionVerificationAvailableActionAccept SetupCompleteResponseSessionVerificationAvailableAction = "accept"

const SetupCompleteResponseSessionVerificationAvailableActionCancel SetupCompleteResponseSessionVerificationAvailableAction = "cancel"

const SetupCompleteResponseSessionVerificationAvailableActionQRConfirmScanned SetupCompleteResponseSessionVerificationAvailableAction = "qr.confirmScanned"

const SetupCompleteResponseSessionVerificationAvailableActionSASStart SetupCompleteResponseSessionVerificationAvailableAction = "sas.start"

const SetupCompleteResponseSessionVerificationAvailableActionSASConfirm SetupCompleteResponseSessionVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const SetupCompleteResponseSessionVerificationDirectionIncoming SetupCompleteResponseSessionVerificationDirection = "incoming"

const SetupCompleteResponseSessionVerificationDirectionOutgoing SetupCompleteResponseSessionVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const SetupCompleteResponseSessionVerificationMethodQR SetupCompleteResponseSessionVerificationMethod = "qr"

const SetupCompleteResponseSessionVerificationMethodSAS SetupCompleteResponseSessionVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const SetupCompleteResponseSessionVerificationPurposeLogin SetupCompleteResponseSessionVerificationPurpose = "login"

const SetupCompleteResponseSessionVerificationPurposeDevice SetupCompleteResponseSessionVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const SetupCompleteResponseSessionVerificationStateRequested SetupCompleteResponseSessionVerificationState = "requested"

const SetupCompleteResponseSessionVerificationStateReady SetupCompleteResponseSessionVerificationState = "ready"

const SetupCompleteResponseSessionVerificationStateSASReady SetupCompleteResponseSessionVerificationState = "sas_ready"

const SetupCompleteResponseSessionVerificationStateQRScanned SetupCompleteResponseSessionVerificationState = "qr_scanned"

const SetupCompleteResponseSessionVerificationStateDone SetupCompleteResponseSessionVerificationState = "done"

const SetupCompleteResponseSessionVerificationStateCancelled SetupCompleteResponseSessionVerificationState = "cancelled"

const SetupCompleteResponseSessionVerificationStateError SetupCompleteResponseSessionVerificationState = "error"

Error SetupCompleteResponseSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice SetupCompleteResponseSessionVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR SetupCompleteResponseSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS SetupCompleteResponseSessionVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

type SetupRegistrationRequiredResponse struct{…}

Copy SetupRegistrationRequiredResponseCopy

Copy to display during account creation.

Submit Continue

Submit button label.

Terms ByContinuingYouAgreeToTheTermsOfUseAndAcknowledgeThePrivacyPolicy

Terms and privacy notice to show before account creation.

Title ChooseYourUsername

Title for the username step.

UsernamePlaceholder Username

Placeholder for the username field.

LeadToken string

Registration token returned by Beeper.

RegistrationRequired bool

Indicates that the user needs to create a Beeper account.

SetupRequestID string

Setup request ID to use when creating the account.

UsernameSuggestions []stringOptional

Suggested usernames for the new account.

type SetupResponseOutputUnion interface{…}

One of the following:

SetupResponseOutputSuccess

Matrix SetupResponseOutputSuccessMatrix

Account credentials for first-party app setup.

AccessToken string

Beeper account access token. Returned once for first-party app setup.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Session SetupResponseOutputSuccessSession

Current app sign-in and encrypted messaging setup state after sign-in.

E2EE SetupResponseOutputSuccessSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets SetupResponseOutputSuccessSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

const SetupResponseOutputSuccessSessionStateNeedsLogin SetupResponseOutputSuccessSessionState = "needs-login"

const SetupResponseOutputSuccessSessionStateInitializing SetupResponseOutputSuccessSessionState = "initializing"

const SetupResponseOutputSuccessSessionStateNeedsCrossSigningSetup SetupResponseOutputSuccessSessionState = "needs-cross-signing-setup"

const SetupResponseOutputSuccessSessionStateNeedsVerification SetupResponseOutputSuccessSessionState = "needs-verification"

const SetupResponseOutputSuccessSessionStateNeedsSecrets SetupResponseOutputSuccessSessionState = "needs-secrets"

const SetupResponseOutputSuccessSessionStateNeedsFirstSync SetupResponseOutputSuccessSessionState = "needs-first-sync"

const SetupResponseOutputSuccessSessionStateReady SetupResponseOutputSuccessSessionState = "ready"

Matrix SetupResponseOutputSuccessSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification SetupResponseOutputSuccessSessionVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const SetupResponseOutputSuccessSessionVerificationAvailableActionAccept SetupResponseOutputSuccessSessionVerificationAvailableAction = "accept"

const SetupResponseOutputSuccessSessionVerificationAvailableActionCancel SetupResponseOutputSuccessSessionVerificationAvailableAction = "cancel"

const SetupResponseOutputSuccessSessionVerificationAvailableActionQRConfirmScanned SetupResponseOutputSuccessSessionVerificationAvailableAction = "qr.confirmScanned"

const SetupResponseOutputSuccessSessionVerificationAvailableActionSASStart SetupResponseOutputSuccessSessionVerificationAvailableAction = "sas.start"

const SetupResponseOutputSuccessSessionVerificationAvailableActionSASConfirm SetupResponseOutputSuccessSessionVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const SetupResponseOutputSuccessSessionVerificationDirectionIncoming SetupResponseOutputSuccessSessionVerificationDirection = "incoming"

const SetupResponseOutputSuccessSessionVerificationDirectionOutgoing SetupResponseOutputSuccessSessionVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const SetupResponseOutputSuccessSessionVerificationMethodQR SetupResponseOutputSuccessSessionVerificationMethod = "qr"

const SetupResponseOutputSuccessSessionVerificationMethodSAS SetupResponseOutputSuccessSessionVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const SetupResponseOutputSuccessSessionVerificationPurposeLogin SetupResponseOutputSuccessSessionVerificationPurpose = "login"

const SetupResponseOutputSuccessSessionVerificationPurposeDevice SetupResponseOutputSuccessSessionVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const SetupResponseOutputSuccessSessionVerificationStateRequested SetupResponseOutputSuccessSessionVerificationState = "requested"

const SetupResponseOutputSuccessSessionVerificationStateReady SetupResponseOutputSuccessSessionVerificationState = "ready"

const SetupResponseOutputSuccessSessionVerificationStateSASReady SetupResponseOutputSuccessSessionVerificationState = "sas_ready"

const SetupResponseOutputSuccessSessionVerificationStateQRScanned SetupResponseOutputSuccessSessionVerificationState = "qr_scanned"

const SetupResponseOutputSuccessSessionVerificationStateDone SetupResponseOutputSuccessSessionVerificationState = "done"

const SetupResponseOutputSuccessSessionVerificationStateCancelled SetupResponseOutputSuccessSessionVerificationState = "cancelled"

const SetupResponseOutputSuccessSessionVerificationStateError SetupResponseOutputSuccessSessionVerificationState = "error"

Error SetupResponseOutputSuccessSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice SetupResponseOutputSuccessSessionVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR SetupResponseOutputSuccessSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS SetupResponseOutputSuccessSessionVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

SetupResponseOutputRegistrationRequired

Copy SetupResponseOutputRegistrationRequiredCopy

Copy to display during account creation.

Submit Continue

Submit button label.

Terms ByContinuingYouAgreeToTheTermsOfUseAndAcknowledgeThePrivacyPolicy

Terms and privacy notice to show before account creation.

Title ChooseYourUsername

Title for the username step.

UsernamePlaceholder Username

Placeholder for the username field.

LeadToken string

Registration token returned by Beeper.

RegistrationRequired bool

Indicates that the user needs to create a Beeper account.

SetupRequestID string

Setup request ID to use when creating the account.

UsernameSuggestions []stringOptional

Suggested usernames for the new account.

type SetupStateResponse struct{…}

Session SetupStateResponseSession

Current app sign-in and encrypted messaging setup state.

E2EE SetupStateResponseSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets SetupStateResponseSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

const SetupStateResponseSessionStateNeedsLogin SetupStateResponseSessionState = "needs-login"

const SetupStateResponseSessionStateInitializing SetupStateResponseSessionState = "initializing"

const SetupStateResponseSessionStateNeedsCrossSigningSetup SetupStateResponseSessionState = "needs-cross-signing-setup"

const SetupStateResponseSessionStateNeedsVerification SetupStateResponseSessionState = "needs-verification"

const SetupStateResponseSessionStateNeedsSecrets SetupStateResponseSessionState = "needs-secrets"

const SetupStateResponseSessionStateNeedsFirstSync SetupStateResponseSessionState = "needs-first-sync"

const SetupStateResponseSessionStateReady SetupStateResponseSessionState = "ready"

Matrix SetupStateResponseSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification SetupStateResponseSessionVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const SetupStateResponseSessionVerificationAvailableActionAccept SetupStateResponseSessionVerificationAvailableAction = "accept"

const SetupStateResponseSessionVerificationAvailableActionCancel SetupStateResponseSessionVerificationAvailableAction = "cancel"

const SetupStateResponseSessionVerificationAvailableActionQRConfirmScanned SetupStateResponseSessionVerificationAvailableAction = "qr.confirmScanned"

const SetupStateResponseSessionVerificationAvailableActionSASStart SetupStateResponseSessionVerificationAvailableAction = "sas.start"

const SetupStateResponseSessionVerificationAvailableActionSASConfirm SetupStateResponseSessionVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const SetupStateResponseSessionVerificationDirectionIncoming SetupStateResponseSessionVerificationDirection = "incoming"

const SetupStateResponseSessionVerificationDirectionOutgoing SetupStateResponseSessionVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const SetupStateResponseSessionVerificationMethodQR SetupStateResponseSessionVerificationMethod = "qr"

const SetupStateResponseSessionVerificationMethodSAS SetupStateResponseSessionVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const SetupStateResponseSessionVerificationPurposeLogin SetupStateResponseSessionVerificationPurpose = "login"

const SetupStateResponseSessionVerificationPurposeDevice SetupStateResponseSessionVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const SetupStateResponseSessionVerificationStateRequested SetupStateResponseSessionVerificationState = "requested"

const SetupStateResponseSessionVerificationStateReady SetupStateResponseSessionVerificationState = "ready"

const SetupStateResponseSessionVerificationStateSASReady SetupStateResponseSessionVerificationState = "sas_ready"

const SetupStateResponseSessionVerificationStateQRScanned SetupStateResponseSessionVerificationState = "qr_scanned"

const SetupStateResponseSessionVerificationStateDone SetupStateResponseSessionVerificationState = "done"

const SetupStateResponseSessionVerificationStateCancelled SetupStateResponseSessionVerificationState = "cancelled"

const SetupStateResponseSessionVerificationStateError SetupStateResponseSessionVerificationState = "error"

Error SetupStateResponseSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice SetupStateResponseSessionVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR SetupStateResponseSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS SetupStateResponseSessionVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

type Verification struct{…}

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const VerificationAvailableActionAccept VerificationAvailableAction = "accept"

const VerificationAvailableActionCancel VerificationAvailableAction = "cancel"

const VerificationAvailableActionQRConfirmScanned VerificationAvailableAction = "qr.confirmScanned"

const VerificationAvailableActionSASStart VerificationAvailableAction = "sas.start"

const VerificationAvailableActionSASConfirm VerificationAvailableAction = "sas.confirm"

Direction VerificationDirection

Whether this device started or received the verification.

One of the following:

const VerificationDirectionIncoming VerificationDirection = "incoming"

const VerificationDirectionOutgoing VerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const VerificationMethodQR VerificationMethod = "qr"

const VerificationMethodSAS VerificationMethod = "sas"

Purpose VerificationPurpose

Why this verification exists.

One of the following:

const VerificationPurposeLogin VerificationPurpose = "login"

const VerificationPurposeDevice VerificationPurpose = "device"

State VerificationState

Current trusted-device verification state.

One of the following:

const VerificationStateRequested VerificationState = "requested"

const VerificationStateReady VerificationState = "ready"

const VerificationStateSASReady VerificationState = "sas_ready"

const VerificationStateQRScanned VerificationState = "qr_scanned"

const VerificationStateDone VerificationState = "done"

const VerificationStateCancelled VerificationState = "cancelled"

const VerificationStateError VerificationState = "error"

Error VerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice VerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR VerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS VerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

type VerificationResponse struct{…}

Session VerificationResponseSession

Current app sign-in and encrypted messaging setup state.

E2EE VerificationResponseSessionE2EE

Encrypted messaging setup status.

CrossSigning bool

Whether this account can verify trusted devices.

FirstSyncDone bool

Whether the first encrypted message sync is complete.

HasBackedUpRecoveryKey bool

Whether the user confirmed that they saved their recovery key.

Initialized bool

Whether encrypted messaging setup has started.

KeyBackup bool

Whether encrypted message backup is available.

Secrets VerificationResponseSessionE2EESecrets

Encrypted messaging keys available on this device.

MasterKey bool

Whether the account identity key is available.

MegolmBackupKey bool

Whether the encrypted message backup key is available.

RecoveryKey bool

Whether a recovery key is available.

SelfSigningKey bool

Whether the device trust key is available.

UserSigningKey bool

Whether the user trust key is available.

SecretStorage bool

Whether secure key storage is available.

Verified bool

Whether this device is trusted for encrypted messages.

RecoveryKeyGeneratedAt float64Optional

Unix timestamp for when the recovery key was created.

State string

Current sign-in and encrypted messaging setup state for Beeper Desktop or Beeper Server.

One of the following:

const VerificationResponseSessionStateNeedsLogin VerificationResponseSessionState = "needs-login"

const VerificationResponseSessionStateInitializing VerificationResponseSessionState = "initializing"

const VerificationResponseSessionStateNeedsCrossSigningSetup VerificationResponseSessionState = "needs-cross-signing-setup"

const VerificationResponseSessionStateNeedsVerification VerificationResponseSessionState = "needs-verification"

const VerificationResponseSessionStateNeedsSecrets VerificationResponseSessionState = "needs-secrets"

const VerificationResponseSessionStateNeedsFirstSync VerificationResponseSessionState = "needs-first-sync"

const VerificationResponseSessionStateReady VerificationResponseSessionState = "ready"

Matrix VerificationResponseSessionMatrixOptional

Signed-in account details. Omitted until sign-in is complete.

DeviceID string

Current device ID.

Homeserver string

Beeper homeserver URL for this account.

UserID string

Signed-in Beeper user ID.

Verification VerificationResponseSessionVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const VerificationResponseSessionVerificationAvailableActionAccept VerificationResponseSessionVerificationAvailableAction = "accept"

const VerificationResponseSessionVerificationAvailableActionCancel VerificationResponseSessionVerificationAvailableAction = "cancel"

const VerificationResponseSessionVerificationAvailableActionQRConfirmScanned VerificationResponseSessionVerificationAvailableAction = "qr.confirmScanned"

const VerificationResponseSessionVerificationAvailableActionSASStart VerificationResponseSessionVerificationAvailableAction = "sas.start"

const VerificationResponseSessionVerificationAvailableActionSASConfirm VerificationResponseSessionVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const VerificationResponseSessionVerificationDirectionIncoming VerificationResponseSessionVerificationDirection = "incoming"

const VerificationResponseSessionVerificationDirectionOutgoing VerificationResponseSessionVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const VerificationResponseSessionVerificationMethodQR VerificationResponseSessionVerificationMethod = "qr"

const VerificationResponseSessionVerificationMethodSAS VerificationResponseSessionVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const VerificationResponseSessionVerificationPurposeLogin VerificationResponseSessionVerificationPurpose = "login"

const VerificationResponseSessionVerificationPurposeDevice VerificationResponseSessionVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const VerificationResponseSessionVerificationStateRequested VerificationResponseSessionVerificationState = "requested"

const VerificationResponseSessionVerificationStateReady VerificationResponseSessionVerificationState = "ready"

const VerificationResponseSessionVerificationStateSASReady VerificationResponseSessionVerificationState = "sas_ready"

const VerificationResponseSessionVerificationStateQRScanned VerificationResponseSessionVerificationState = "qr_scanned"

const VerificationResponseSessionVerificationStateDone VerificationResponseSessionVerificationState = "done"

const VerificationResponseSessionVerificationStateCancelled VerificationResponseSessionVerificationState = "cancelled"

const VerificationResponseSessionVerificationStateError VerificationResponseSessionVerificationState = "error"

Error VerificationResponseSessionVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice VerificationResponseSessionVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR VerificationResponseSessionVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS VerificationResponseSessionVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

Verification VerificationResponseVerificationOptional

Trusted device verification progress.

ID string

Verification ID to pass in verification action paths.

AvailableActions []string

Verification actions that are valid for the current state.

One of the following:

const VerificationResponseVerificationAvailableActionAccept VerificationResponseVerificationAvailableAction = "accept"

const VerificationResponseVerificationAvailableActionCancel VerificationResponseVerificationAvailableAction = "cancel"

const VerificationResponseVerificationAvailableActionQRConfirmScanned VerificationResponseVerificationAvailableAction = "qr.confirmScanned"

const VerificationResponseVerificationAvailableActionSASStart VerificationResponseVerificationAvailableAction = "sas.start"

const VerificationResponseVerificationAvailableActionSASConfirm VerificationResponseVerificationAvailableAction = "sas.confirm"

Direction string

Whether this device started or received the verification.

One of the following:

const VerificationResponseVerificationDirectionIncoming VerificationResponseVerificationDirection = "incoming"

const VerificationResponseVerificationDirectionOutgoing VerificationResponseVerificationDirection = "outgoing"

Methods []string

Verification methods supported for this transaction.

One of the following:

const VerificationResponseVerificationMethodQR VerificationResponseVerificationMethod = "qr"

const VerificationResponseVerificationMethodSAS VerificationResponseVerificationMethod = "sas"

Purpose string

Why this verification exists.

One of the following:

const VerificationResponseVerificationPurposeLogin VerificationResponseVerificationPurpose = "login"

const VerificationResponseVerificationPurposeDevice VerificationResponseVerificationPurpose = "device"

State string

Current trusted-device verification state.

One of the following:

const VerificationResponseVerificationStateRequested VerificationResponseVerificationState = "requested"

const VerificationResponseVerificationStateReady VerificationResponseVerificationState = "ready"

const VerificationResponseVerificationStateSASReady VerificationResponseVerificationState = "sas_ready"

const VerificationResponseVerificationStateQRScanned VerificationResponseVerificationState = "qr_scanned"

const VerificationResponseVerificationStateDone VerificationResponseVerificationState = "done"

const VerificationResponseVerificationStateCancelled VerificationResponseVerificationState = "cancelled"

const VerificationResponseVerificationStateError VerificationResponseVerificationState = "error"

Error VerificationResponseVerificationErrorOptional

Verification error details, if verification stopped.

Code string

Verification error code.

Reason string

User-facing verification error message.

OtherDevice VerificationResponseVerificationOtherDeviceOptional

Other device participating in verification.

ID string

Other device ID.

Name stringOptional

Other device display name, if known.

OtherUserID stringOptional

Other Beeper user participating in verification.

QR VerificationResponseVerificationQROptional

QR verification data.

Data string

QR code payload to display for verification.

SAS VerificationResponseVerificationSASOptional

Emoji or number comparison data for verification.

Emojis string

Emoji sequence to compare on both devices.

Decimals stringOptional

Number sequence to compare on both devices.

AppSetup

Complete first-party Beeper app setup

Get Beeper app setup state

client.App.Setup.Get(ctx) (*AppSetupGetResponse, error)

GET/v1/app/setup

Start Beeper app setup

client.App.Setup.Start(ctx) (*AppSetupStartResponse, error)

POST/v1/app/setup/start

Send setup sign-in code

client.App.Setup.Email(ctx, body) error

POST/v1/app/setup/email

Complete setup sign-in with code

client.App.Setup.Response(ctx, body) (*AppSetupResponseResponseUnion, error)

POST/v1/app/setup/response

Create account for setup

client.App.Setup.Register(ctx, body) (*AppSetupRegisterResponse, error)

POST/v1/app/setup/register

AppSetupRecovery Key

Manage recovery-key setup for encrypted messages

Verify with recovery key

client.App.Setup.RecoveryKey.Verify(ctx, body) (*AppSetupRecoveryKeyVerifyResponse, error)

POST/v1/app/setup/verification/recovery-key

AppSetupRecovery KeyReset

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Create new recovery key

client.App.Setup.RecoveryKey.Reset.New(ctx, body) (*AppSetupRecoveryKeyResetNewResponse, error)

POST/v1/app/setup/verification/recovery-key/reset

Confirm new recovery key

client.App.Setup.RecoveryKey.Reset.Confirm(ctx, body) (*AppSetupRecoveryKeyResetConfirmResponse, error)

POST/v1/app/setup/verification/recovery-key/reset/confirm

AppSetupVerifications

Manage device verification transactions

List active verifications

client.App.Setup.Verifications.List(ctx) (*AppSetupVerificationListResponse, error)

GET/v1/app/setup/verifications

Start device verification

client.App.Setup.Verifications.New(ctx, body) (*AppSetupVerificationNewResponse, error)

POST/v1/app/setup/verifications

Get verification

client.App.Setup.Verifications.Get(ctx, verificationID) (*AppSetupVerificationGetResponse, error)

GET/v1/app/setup/verifications/{verificationID}

Accept device verification

client.App.Setup.Verifications.Accept(ctx, verificationID) (*AppSetupVerificationAcceptResponse, error)

POST/v1/app/setup/verifications/{verificationID}/accept

Cancel device verification

client.App.Setup.Verifications.Cancel(ctx, verificationID, body) (*AppSetupVerificationCancelResponse, error)

POST/v1/app/setup/verifications/{verificationID}/cancel

AppSetupVerificationsQR

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Scan verification QR code

client.App.Setup.Verifications.QR.Scan(ctx, body) (*AppSetupVerificationQRScanResponse, error)

POST/v1/app/setup/verifications/qr/scan

Confirm QR code scan

client.App.Setup.Verifications.QR.ConfirmScanned(ctx, verificationID) (*AppSetupVerificationQRConfirmScannedResponse, error)

POST/v1/app/setup/verifications/{verificationID}/qr/confirm-scanned

AppSetupVerificationsSAS

First-party sign-in and encrypted messaging setup for Beeper Desktop and Beeper Server.

Start emoji verification

client.App.Setup.Verifications.SAS.Start(ctx, verificationID) (*AppSetupVerificationSASStartResponse, error)

POST/v1/app/setup/verifications/{verificationID}/sas/start

Confirm emoji verification

client.App.Setup.Verifications.SAS.Confirm(ctx, verificationID) (*AppSetupVerificationSASConfirmResponse, error)

POST/v1/app/setup/verifications/{verificationID}/sas/confirm