You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* • The query matches ALL words provided (in any order). Example: query="flight booking" finds messages with both "flight" AND "booking".
21
-
* - Media filters: Use onlyWithMedia for any media, or specific filters like onlyWithVideo, onlyWithImage, onlyWithLink, onlyWithFile for specific types.
22
-
* - Pagination: use 'oldestCursor' + direction='before' for older; 'newestCursor' + direction='after' for newer.
23
-
* - Performance: provide chatIDs/accountIDs when known. Omitted 'query' returns results based on filters only. Partial matches enabled; 'excludeLowPriority' defaults to true.
24
-
* - Workflow tip: To search messages in specific conversations: 1) Use find-chats to get chatIDs, 2) Use search-messages with those chatIDs.
25
-
* - IMPORTANT: Chat names vary widely. ASK the user for clarification:
26
-
* • "Which chat do you mean by family?" (could be "The Smiths", "Mom Dad Kids", etc.)
27
-
* • "What's the name of your work chat?" (could be "Team", company name, project name)
28
-
* • "Who are the participants?" (use participantQuery in find-chats)
29
-
* Returns: matching messages and referenced chats.
* - Idempotent: safe to call repeatedly. Returns an error if chatID is not found.
27
-
* Returns: success.
23
+
* Bring Beeper Desktop to the foreground on this device.
28
24
*
29
25
* @param string $chatID Optional Beeper chat ID to focus after bringing the app to foreground. If omitted, only foregrounds the app. Required if messageSortKey is present. No-op in headless environments.
30
26
* @param string $messageSortKey Optional message sort key. Jumps to that message in the chat when foregrounding.
* Retrieve chat details: metadata, participants (limited), and latest message.
32
-
* - When to use: fetch a complete view of a chat beyond what search returns.
33
-
* - Constraints: not available for iMessage chats ('imsg##'). Participants limited by 'maxParticipantCount' (default 20, max 500).
34
-
* Returns: chat details.Agents: ALWAYS use linkToChat to make clickable links in your response.
31
+
* Retrieve chat details including metadata, participants, and latest message.
35
32
*
36
33
* @param string $chatID Unique identifier of the chat to retrieve. Not available for iMessage chats. Participants are limited by 'maxParticipantCount'.
37
34
* @param int|null $maxParticipantCount Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to 20.
@@ -90,11 +87,6 @@ public function archive(
90
87
91
88
/**
92
89
* Search and filter conversations across all messaging accounts.
93
-
* - When to use: browse chats by inbox (primary/low-priority/archive), type, unread status, or search terms.
94
-
* - Pagination: use cursor + direction for pagination.
95
-
* - Performance: provide accountIDs when known for faster filtering.
96
-
* Returns: matching chats with pagination.
97
-
* Agents: ALWAYS use linkToChat to make clickable links in your response.
98
90
*
99
91
* @param list<string> $accountIDs Provide an array of account IDs to filter chats from specific messaging accounts only
100
92
* @param string $endingBefore A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
* • The query matches ALL words provided (in any order). Example: query="flight booking" finds messages with both "flight" AND "booking".
65
-
* - Media filters: Use onlyWithMedia for any media, or specific filters like onlyWithVideo, onlyWithImage, onlyWithLink, onlyWithFile for specific types.
66
-
* - Pagination: use 'oldestCursor' + direction='before' for older; 'newestCursor' + direction='after' for newer.
67
-
* - Performance: provide chatIDs/accountIDs when known. Omitted 'query' returns results based on filters only. Partial matches enabled; 'excludeLowPriority' defaults to true.
68
-
* - Workflow tip: To search messages in specific conversations: 1) Use find-chats to get chatIDs, 2) Use search-messages with those chatIDs.
69
-
* - IMPORTANT: Chat names vary widely. ASK the user for clarification:
70
-
* • "Which chat do you mean by family?" (could be "The Smiths", "Mom Dad Kids", etc.)
71
-
* • "What's the name of your work chat?" (could be "Team", company name, project name)
72
-
* • "Who are the participants?" (use participantQuery in find-chats)
73
-
* Returns: matching messages and referenced chats.
74
60
*
75
61
* @param list<string> $accountIDs limit search to specific Beeper account IDs (bridge instances)
76
62
* @param list<string> $chatIDs limit search to specific Beeper chat IDs
0 commit comments