Read inbox
read_inboxFetch recent messages across connected accounts and chats, newest first; filter by channel, connection, or chat and page with before. Set mark_read false to inspect without marking read.
Instructions
Read recent messages across all your connected accounts, newest first (each says which account it is on) — from every chat except ones the account holder ignored. Filter by channel, connection, or one chat (chat_id from list_chats). Page back with before. A message with media carries a photo, video, voice note, document or sticker (its text is the caption, or a placeholder like "[photo]"): call get_media to see it. reactions lists who reacted with what. new_since_last_read says how much came in from the other side since these chats were last read (messages and reactions, per chat); new messages and reactions carry new: true, and new_reactions lists every new reaction with the message it's on (even one on an old message not shown). Reading marks what it shows as read, for every agent on the account; pass mark_read: false to just look. Paging back with before never marks anything. Reading that marks read also sends read receipts on WhatsApp by default (blue ticks, if that number's WhatsApp has them on; the account holder can turn this off per number in Parley): pass read_receipts: false to read without telling the sender. Looking (mark_read: false) or paging back sends none unless read_receipts is true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many messages (default 50). | |
| before | No | Only messages sent before this ISO time — pass the `at` of the oldest message you have to page back. | |
| channel | No | Only this channel, e.g. "whatsapp". Omit for every connected channel. | |
| chat_id | No | Only this chat (a chat_id from list_chats or from an earlier message). | |
| mark_read | No | Mark what this returns as read (default true). Pass false to look without changing what counts as new. | |
| connection_id | No | Only this account: a connection id from list_connections, or its number (e.g. "+65 9136 3557"). | |
| read_receipts | No | Also mark the messages this returns read on WhatsApp itself, as opening the chat on the phone would. On by default whenever this marks them read (each number's setting in Parley); pass false to read without telling the sender. The senders see blue ticks only if that number's WhatsApp has read receipts on; otherwise only its own devices mark the chat read. On a number whose read receipts the account holder turned off in Parley, none are sent. |