Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Messages

Manage messages in chats

Search messages
messages.search(MessageSearchParams**kwargs) -> SyncCursorSearch[Message]
GET/v1/messages/search
List messages
messages.list(strchat_id, MessageListParams**kwargs) -> SyncCursorNoLimit[Message]
GET/v1/chats/{chatID}/messages
Send a message
messages.send(strchat_id, MessageSendParams**kwargs) -> MessageSendResponse
POST/v1/chats/{chatID}/messages
Retrieve a message
messages.retrieve(strmessage_id, MessageRetrieveParams**kwargs) -> Message
GET/v1/chats/{chatID}/messages/{messageID}
Edit a message
messages.update(strmessage_id, MessageUpdateParams**kwargs) -> MessageUpdateResponse
PUT/v1/chats/{chatID}/messages/{messageID}
Delete a message
messages.delete(strmessage_id, MessageDeleteParams**kwargs)
DELETE/v1/chats/{chatID}/messages/{messageID}
ModelsExpand Collapse
class MessageSendResponse: …
chat_id: str

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

pending_message_id: str

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.

class MessageUpdateResponse: …
Deprecatedmessage_id: str
Use id instead.

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

Deprecatedsuccess: Literal[true]
Use the HTTP 200 response status instead.

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