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 a chat
$client->chats->create(string accountID, list<string> participantIDs, Type type, ?string messageText, ?string title): ChatNewResponse
POST/v1/chats
Start a direct chat
$client->chats->start(string accountID, User user, ?bool allowInvite, ?string messageText): ChatStartResponse
POST/v1/chats/start
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
Update chat
$client->chats->update(string chatID, ?string description, ?Draft draft, ?string imgURL, ?bool isArchived, ?bool isLowPriority, ?bool isMuted, ?bool isPinned, ?int messageExpirySeconds, ?string title): Chat
PATCH/v1/chats/{chatID}
Mark a chat as read
$client->chats->markRead(string chatID, ?string messageID): Chat
POST/v1/chats/{chatID}/read
Mark a chat as unread
$client->chats->markUnread(string chatID, ?string messageID): Chat
POST/v1/chats/{chatID}/unread
Notify anyway
$client->chats->notifyAnyway(string chatID): Chat
POST/v1/chats/{chatID}/notify-anyway
ModelsExpand Collapse
string id

Unique identifier of the chat across Beeper.

string accountID

Account ID this chat belongs to.

string network

Display-only human-readable account/network name.

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.

?Capabilities capabilities

Chat capabilities reported by the platform.

?string description

Group chat description/topic when available.

?Draft draft

Current draft object for this chat, or null when no draft is set.

?string imgURL

Local filesystem path to the chat avatar image when available.

?bool isArchived

True if chat is archived.

?bool isLowPriority

True if chat is marked low priority.

?bool isMarkedUnread

True if the chat was explicitly marked unread by the authenticated user.

?bool isMuted

True if chat notifications are muted.

?bool isPinned

True if chat is pinned.

?bool isReadOnly

True if messages cannot be sent in this chat.

?\Datetime lastActivity

Timestamp of last activity.

?string lastReadMessageSortKey

Last read message sortKey.

?string localChatID

Local chat ID specific to this installation.

?int messageExpirySeconds

Disappearing-message timer in seconds when available.

?Reminder reminder

Current reminder for this chat, or null when no reminder is set.

?Snooze snooze

Current snooze state for this chat, or null when no snooze is set.

?int unreadMentionsCount

Number of unread messages that mention the authenticated user or @room.

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 reactionKey, string chatID, string messageID): ReactionDeleteResponse
DELETE/v1/chats/{chatID}/messages/{messageID}/reactions/{reactionKey}