Shared
Shared
ModelsExpand Collapse
class Attachment: …
type: Literal["unknown", "img", "video", "audio"]Attachment type.
Attachment type.
Duration in seconds (audio/video).
Original filename if available.
File size in bytes if known.
True if the attachment is a GIF.
True if the attachment is a sticker.
True if the attachment is a voice note.
MIME type if known (e.g., 'image/png').
Preview image URL for video attachments (poster frame). May be temporary or local-only to this device; download promptly if durable access is needed.
size: Optional[Size]Pixel dimensions of the attachment: width/height in px.
Pixel dimensions of the attachment: width/height in px.
Public URL or local file path to fetch the asset. May be temporary or local-only to this device; download promptly if durable access is needed.
class BaseResponse: …
class Error: …
error: ErrorError details
Error details
Machine-readable error code
Error message
Error type (e.g., invalid_request_error, authentication_error, not_found_error)
Parameter that caused the error
class Message: …
Message ID.
Beeper account ID the message belongs to.
Unique identifier of the chat.
Sender user ID.
A unique key used to sort messages
Message timestamp.
Attachments included with this message, if any.
Attachments included with this message, if any.
type: Literal["unknown", "img", "video", "audio"]Attachment type.
Attachment type.
Duration in seconds (audio/video).
Original filename if available.
File size in bytes if known.
True if the attachment is a GIF.
True if the attachment is a sticker.
True if the attachment is a voice note.
MIME type if known (e.g., 'image/png').
Preview image URL for video attachments (poster frame). May be temporary or local-only to this device; download promptly if durable access is needed.
size: Optional[Size]Pixel dimensions of the attachment: width/height in px.
Pixel dimensions of the attachment: width/height in px.
Public URL or local file path to fetch the asset. May be temporary or local-only to this device; download promptly if durable access is needed.
True if the authenticated user sent the message.
True if the message is unread for the authenticated user. May be omitted.
Reactions to the message, if any.
Reactions to the message, if any.
Reaction ID, typically ${participantID}${reactionKey} if multiple reactions allowed, or just participantID otherwise.
User ID of the participant who reacted.
The reaction key: an emoji (😄), a network-specific key, or a shortcode like "smiling-face".
True if the reactionKey is an emoji.
URL to the reaction's image. May be temporary or local-only to this device; download promptly if durable access is needed.
Resolved sender display name (impersonator/full name/username/participant name).
Plain-text body if present. May include a JSON fallback with text entities for rich messages.
class Reaction: …
Reaction ID, typically ${participantID}${reactionKey} if multiple reactions allowed, or just participantID otherwise.
User ID of the participant who reacted.
The reaction key: an emoji (😄), a network-specific key, or a shortcode like "smiling-face".
True if the reactionKey is an emoji.
URL to the reaction's image. May be temporary or local-only to this device; download promptly if durable access is needed.
class User: …User the account belongs to.
User the account belongs to.
Stable Beeper user ID. Use as the primary key when referencing a person.
True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.
Email address if known. Not guaranteed verified.
Display name as shown in clients (e.g., 'Alice Example'). May include emojis.
Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.
True if this user represents the authenticated account's own identity.
User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.
Human-readable handle if available (e.g., '@alice'). May be network-specific and not globally unique.