Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Messages

Manage messages in chats

Search messages
client.messages.search(MessageSearchParams { accountIDs, chatIDs, chatType, 10 more } query?, RequestOptionsoptions?): CursorSearch<Message { id, accountID, chatID, 18 more } >
GET/v1/messages/search
List messages
client.messages.list(stringchatID, MessageListParams { cursor, direction } query?, RequestOptionsoptions?): CursorNoLimit<Message { id, accountID, chatID, 18 more } >
GET/v1/chats/{chatID}/messages
Send a message
client.messages.send(stringchatID, MessageSendParams { attachment, replyToMessageID, text } body?, RequestOptionsoptions?): MessageSendResponse { chatID, pendingMessageID }
POST/v1/chats/{chatID}/messages
Retrieve a message
client.messages.retrieve(stringmessageID, MessageRetrieveParams { chatID } params, RequestOptionsoptions?): Message { id, accountID, chatID, 18 more }
GET/v1/chats/{chatID}/messages/{messageID}
Edit a message
client.messages.update(stringmessageID, MessageUpdateParams { chatID, text } params, RequestOptionsoptions?): MessageUpdateResponse { messageID, success }
PUT/v1/chats/{chatID}/messages/{messageID}
Delete a message
client.messages.delete(stringmessageID, MessageDeleteParams { chatID, forEveryone } params, RequestOptionsoptions?): void
DELETE/v1/chats/{chatID}/messages/{messageID}
ModelsExpand Collapse
MessageSendResponse { 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.

MessageUpdateResponse extends Message { id, accountID, chatID, 18 more } { messageID, success }
DeprecatedmessageID: string
Use id instead.

DEPRECATED - use id instead. Compatibility alias for older clients.

Deprecatedsuccess: true
Use the HTTP 200 response status instead.

DEPRECATED - compatibility field. Successful responses are already represented by the 200 status code.