Send

API Reference

Messages

Send a message

client.messages.send(MessageSendParamsbody, RequestOptionsoptions?): MessageSendResponse

post/v0/send-message

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

ParametersExpand Collapse

body: MessageSendParams

chatID: string

The identifier of the chat where the message will send (accepts both chatID and local chat ID)

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 extends BaseResponse { messageID }

messageID: string

Stable message ID.

HTTPTypeScript

import BeeperDesktop from '@beeper/desktop-api';

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

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

console.log(response);

200 example

{
  "success": true,
  "error": "error",
  "messageID": "m1694783291234567"
}

Returns Examples

200 example

{
  "success": true,
  "error": "error",
  "messageID": "m1694783291234567"
}