Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Shared

ModelsExpand Collapse
string code
string message
?array<string,mixed> details
E2EE e2ee

Encrypted messaging setup status.

State state

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

?Matrix matrix

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

?Verification verification

Trusted device verification progress.

Type type

Attachment type.

?string id

Attachment identifier, typically an mxc:// URL. Use the download file endpoint to get a local file path.

?float duration

Duration in seconds (audio/video).

?string fileName

Original filename if available.

?float fileSize

File size in bytes if known.

?bool isGif

True if the attachment is a GIF.

?bool isSticker

True if the attachment is a sticker.

?bool isVoiceNote

True if the attachment is a voice note.

?string mimeType

MIME type if known (e.g., ‘image/png’).

?string posterImg

Preview image URL for video attachments (poster frame). May be temporary or available only on this device; download promptly if durable access is needed.

?Size size

Pixel dimensions of the attachment: width/height in px.

?string srcURL

Public URL or local file path to fetch the file. May be temporary or available only on this device; download promptly if durable access is needed.

?Transcription transcription

Attachment transcription if available.

string code

Machine-readable error code

string message

Error message

?Details details

Additional error details for debugging

string id

Message ID.

string accountID

Beeper account ID the message belongs to.

string chatID

Chat ID. Input routes also accept the local chat ID from this installation when available.

string senderID

Fully qualified sender user ID. Network-backed IDs usually include the network prefix and homeserver.

string sortKey

A unique, sortable key used to sort messages.

\Datetime timestamp

Message timestamp.

?list<Attachment> attachments

Attachments included with this message, if any.

?\Datetime editedTimestamp

Timestamp when the message was edited, if known.

?bool isDeleted

True if the message has been deleted.

?bool isHidden

True if the message is hidden from normal display.

?bool isSender

True if the authenticated user sent the message.

?bool isUnread

True if the message is unread for the authenticated user. May be omitted.

?string linkedMessageID

ID of the message this is a reply to, if any.

?list<string> mentions

Mentioned user IDs, @room, or null for legacy messages that require text scanning.

?list<Reaction> reactions

Reactions to the message, if any.

?Seen seen

Read receipt state for this message, when available.

?string senderName

Resolved sender display name.

?SendStatus sendStatus

Message send status for this message, when reported by the bridge.

?string text

Rich-text message body if present.

?Type type

Message content type. Useful for distinguishing reactions, media messages, and state events from regular text messages.

string id

Reaction ID. When a participant can react more than once, the ID is the participant ID concatenated with the reaction key; otherwise it equals the participant ID.

string participantID

User ID of the participant who reacted.

string reactionKey

The reaction key: an emoji (😄), a network-specific key, or a shortcode like “smiling-face”.

?bool emoji

True if the reactionKey is an emoji.

?string imgURL

URL to the reaction’s image. May be temporary or available only on this device; download promptly if durable access is needed.

string id

Stable Beeper user ID. Use as the primary key when referencing a person.

?bool cannotMessage

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

?string email

Email address if known. Not guaranteed verified.

?string fullName

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

?string imgURL

Avatar image URL if available. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on this device; download promptly if durable access is needed.

?bool isSelf

True if this user represents the authenticated account’s own identity.

?string phoneNumber

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

?string username

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.