Chats

Manage chats

Retrieve chat details

client.chats.retrieve(, ?, ?): Chat { id, accountID, participants, 9 more }

GET/v1/chats/{chatID}

Create or start a chat

client.chats.create(?, ?): ChatCreateResponse { chatID, status }

POST/v1/chats

List chats

client.chats.list(?, ?): CursorNoLimit<ChatListResponse { preview } >

GET/v1/chats

Search chats

client.chats.search(?, ?): CursorSearch<Chat { id, accountID, participants, 9 more } >

GET/v1/chats/search

Archive or unarchive a chat

client.chats.archive(, ?, ?): void

POST/v1/chats/{chatID}/archive

ModelsExpand Collapse

Chat { id, accountID, participants, 9 more }

id: string

Unique identifier of the chat across Beeper.

accountID: string

Account ID this chat belongs to.

participants: Participants { hasMore, items, total }

Chat participants information.

hasMore: boolean

True if there are more participants than included in items.

items: Array<User { id, cannotMessage, email, 5 more } >

Participants returned for this chat (limited by the request; may be a subset).

id: string

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

cannotMessage?: boolean

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?: string

Email address if known. Not guaranteed verified.

fullName?: string

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

imgURL?: string

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

isSelf?: boolean

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

phoneNumber?: string

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

username?: string

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

total: number

Total number of participants in the chat.

title: string

Display title of the chat as computed by the client/server.

type: "single" | "group"

Chat type: ‘single’ for direct messages, ‘group’ for group chats.

One of the following:

"single"

"group"

unreadCount: number

Number of unread messages.

isArchived?: boolean

True if chat is archived.

isMuted?: boolean

True if chat notifications are muted.

isPinned?: boolean

True if chat is pinned.

lastActivity?: string

Timestamp of last activity.

formatdate-time

lastReadMessageSortKey?: string

Last read message sortKey.

localChatID?: string | null

Local chat ID specific to this Beeper Desktop installation.

ChatCreateResponse { chatID, status }

chatID: string

Newly created chat ID.

status?: "existing" | "created"

Only returned in start mode. ‘existing’ means an existing chat was reused; ‘created’ means a new chat was created.

One of the following:

"existing"

"created"

ChatListResponse extends Chat { id, accountID, participants, 9 more } { preview }

preview?: Message { id, accountID, chatID, 11 more }

Last message preview for this chat, if available.

id: string

Message ID.

accountID: string

Beeper account ID the message belongs to.

chatID: string

Unique identifier of the chat.

senderID: string

Sender user ID.

sortKey: string

A unique, sortable key used to sort messages.

timestamp: string

Message timestamp.

formatdate-time

attachments?: Array<Attachment { type, id, duration, 9 more } >

Attachments included with this message, if any.

type: "unknown" | "img" | "video" | "audio"

Attachment type.

One of the following:

"unknown"

"img"

"video"

"audio"

id?: string

Attachment identifier (typically an mxc:// URL). Use with /v1/assets/download to get a local file path.

duration?: number

Duration in seconds (audio/video).

fileName?: string

Original filename if available.

fileSize?: number

File size in bytes if known.

isGif?: boolean

True if the attachment is a GIF.

isSticker?: boolean

True if the attachment is a sticker.

isVoiceNote?: boolean

True if the attachment is a voice note.

mimeType?: string

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

posterImg?: string

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?: Size { height, width }

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

height?: number

width?: number

srcURL?: string

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.

isSender?: boolean

True if the authenticated user sent the message.

isUnread?: boolean

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

linkedMessageID?: string

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

reactions?: Array<Reaction { id, participantID, reactionKey, 2 more } >

Reactions to the message, if any.

id: string

Reaction ID, typically ${participantID}${reactionKey} if multiple reactions allowed, or just participantID otherwise.

participantID: string

User ID of the participant who reacted.

reactionKey: string

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

emoji?: boolean

True if the reactionKey is an emoji.

imgURL?: string

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

senderName?: string

Resolved sender display name (impersonator/full name/username/participant name).

text?: string

Plain-text body if present. May include a JSON fallback with text entities for rich messages.

type?: "TEXT" | "NOTICE" | "IMAGE" | 7 more

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

One of the following:

"TEXT"

"NOTICE"

"IMAGE"

"VIDEO"

"VOICE"

"AUDIO"

"FILE"

"STICKER"

"LOCATION"

"REACTION"

ChatsReminders

Manage reminders for chats

Create a chat reminder

client.chats.reminders.create(, , ?): void

POST/v1/chats/{chatID}/reminders

Delete a chat reminder

client.chats.reminders.delete(, ?): void

DELETE/v1/chats/{chatID}/reminders

ChatsMessages

Manage chat messages

ChatsMessagesReactions

Manage message reactions

Add a reaction

client.chats.messages.reactions.add(, , ?): ReactionAddResponse { chatID, messageID, reactionKey, 2 more }

POST/v1/chats/{chatID}/messages/{messageID}/reactions

Remove a reaction

client.chats.messages.reactions.delete(, , ?): ReactionDeleteResponse { chatID, messageID, reactionKey, success }

DELETE/v1/chats/{chatID}/messages/{messageID}/reactions

ModelsExpand Collapse

ReactionAddResponse { chatID, messageID, reactionKey, 2 more }

chatID: string

Unique identifier of the chat.

messageID: string

Message ID.

reactionKey: string

Reaction key that was added

success: true

Whether the reaction was successfully added

transactionID: string

Transaction ID used for the reaction event

ReactionDeleteResponse { chatID, messageID, reactionKey, success }

chatID: string

Unique identifier of the chat.

messageID: string

Message ID.

reactionKey: string

Reaction key that was removed

success: true

Whether the reaction was successfully removed

Chats

Retrieve chat details

Create or start a chat

List chats

Search chats

Archive or unarchive a chat

ModelsExpand Collapse

ChatsReminders

Create a chat reminder

Delete a chat reminder

ChatsMessages

ChatsMessagesReactions

Add a reaction

Remove a reaction

ModelsExpand Collapse

What can I help you with?

Suggestions