Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Client

Focus Beeper Desktop app

$client->focus(?string chatID, ?string draftAttachmentPath, ?string draftText, ?string messageID): BeeperDesktopClientServiceFocusResponse
POST/v1/focus

Focus Beeper Desktop and optionally open a specific chat, jump to a message, or pre-fill text and an image.

ParametersExpand Collapse
chatID?:optional string

Optional Beeper chat ID (or local chat ID) to focus after opening the app. If omitted, only opens/focuses the app.

draftAttachmentPath?:optional string

Optional local image path to populate in the message input field.

draftText?:optional string

Optional plain text to populate in the message input field.

messageID?:optional string

Optional message ID. Jumps to that message in the chat when opening.

ReturnsExpand Collapse
bool success

Whether the app was successfully opened/focused.

Focus Beeper Desktop app

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$response = $client->focus(
  chatID: '!NCdzlIaMjZUmvmvyHU:beeper.com',
  draftAttachmentPath: 'draftAttachmentPath',
  draftText: 'draftText',
  messageID: 'messageID',
);

var_dump($response);
{
  "success": true
}
Returns Examples
{
  "success": true
}