Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Chats

Manage chats

Retrieve chat details
$client->chats->retrieve(string chatID, ?int maxParticipantCount): Chat
GET/v1/chats/{chatID}
Create or start a chat
$client->chats->create(string accountID, ?bool allowInvite, ?string messageText, ?Mode mode, ?list<string> participantIDs, ?string title, ?Type type, ?User user): ChatNewResponse
POST/v1/chats
List chats
$client->chats->list(?list<string> accountIDs, ?string cursor, ?Direction direction): CursorNoLimit<ChatListResponse>
GET/v1/chats
Search chats
$client->chats->search(?list<string> accountIDs, ?string cursor, ?Direction direction, ?Inbox inbox, ?bool includeMuted, ?\Datetime lastActivityAfter, ?\Datetime lastActivityBefore, ?int limit, ?string query, ?Scope scope, ?Type type, ?bool unreadOnly): CursorSearch<Chat>
GET/v1/chats/search
Archive or unarchive a chat
$client->chats->archive(string chatID, ?bool archived): void
POST/v1/chats/{chatID}/archive
ModelsExpand Collapse
string id

Unique identifier of the chat across Beeper.

string accountID

Account ID this chat belongs to.

Participants participants

Chat participants information.

string title

Display title of the chat as computed by the client/server.

Type type

Chat type: 'single' for direct messages, 'group' for group chats.

int unreadCount

Number of unread messages.

?bool isArchived

True if chat is archived.

?bool isMuted

True if chat notifications are muted.

?bool isPinned

True if chat is pinned.

?\Datetime lastActivity

Timestamp of last activity.

?string lastReadMessageSortKey

Last read message sortKey.

?string localChatID

Local chat ID specific to this Beeper Desktop installation.

ChatsReminders

Manage reminders for chats

Create a chat reminder
$client->chats->reminders->create(string chatID, Reminder reminder): void
POST/v1/chats/{chatID}/reminders
Delete a chat reminder
$client->chats->reminders->delete(string chatID): void
DELETE/v1/chats/{chatID}/reminders

ChatsMessages

Manage chat messages

ChatsMessagesReactions

Manage message reactions

Add a reaction
$client->chats->messages->reactions->add(string messageID, string chatID, string reactionKey, ?string transactionID): ReactionAddResponse
POST/v1/chats/{chatID}/messages/{messageID}/reactions
Remove a reaction
$client->chats->messages->reactions->delete(string messageID, string chatID, string reactionKey): ReactionDeleteResponse
DELETE/v1/chats/{chatID}/messages/{messageID}/reactions