API Reference

Messages

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Send a message

$ beeper-desktop messages send

POST/v1/chats/{chatID}/messages

Send a text message to a specific chat. Supports replying to existing messages. Returns a pending message ID.

ParametersExpand Collapse

--chat-id: string

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

--attachment: optional object { uploadID, duration, fileName, 3 more }

Single attachment to send with the message

--reply-to-message-id: optional string

Provide a message ID to send this as a reply to an existing message

--text: optional string

Draft text. Plain text and Markdown are converted to Beeper rich text with the same rules used by send and edit.

ReturnsExpand Collapse

MessageSendResponse: object { chatID, pendingMessageID }

chatID: string

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

pendingMessageID: string

Pending ID assigned to the message before the network confirms the send. Pass it to GET /v1/chats/{chatID}/messages/{messageID} to resolve, or wait for the matching message.upserted over the WebSocket.

Send a message

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop messages send \
  --access-token 'My Access Token' \
  --chat-id '!NCdzlIaMjZUmvmvyHU:beeper.com'

200 example

{
  "chatID": "!whatsapp_15550101002:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
  "pendingMessageID": "m1694783291234567"
}

Returns Examples

200 example

{
  "chatID": "!whatsapp_15550101002:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
  "pendingMessageID": "m1694783291234567"
}