Skip to content
  • Auto
  • Light
  • Dark
Download Beeper

Send

Send a message
client.messages.send(stringchatID, MessageSendParams { replyToMessageID, text } body?, RequestOptionsoptions?): MessageSendResponse { chatID, pendingMessageID }
post/v1/chats/{chatID}/messages

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

ParametersExpand Collapse
chatID: string

Unique identifier of the chat.

body: MessageSendParams { replyToMessageID, text }
replyToMessageID?: string

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

text?: string

Text content of the message you want to send. You may use markdown.

ReturnsExpand Collapse
MessageSendResponse { chatID, pendingMessageID }
chatID: string

Unique identifier of the chat.

pendingMessageID: string

Pending message ID

Send a message
import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: 'My Access Token',
});

const response = await client.messages.send('!NCdzlIaMjZUmvmvyHU:beeper.com');

console.log(response.chatID);
{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "pendingMessageID": "m1694783291234567"
}
Returns Examples
{
  "chatID": "!signal_adamvy:local-signal.localhost",
  "pendingMessageID": "m1694783291234567"
}