Skip to content

Releases

v0.31.0

Choose a tag to compare

@rmyndharis rmyndharis released this 21 Nov 04:16
7933167

Added

  • GET /api/sessions/{sessionId}/chats lists phone for a Baileys privacy-id chat the session can map, and the JavaScript, Python, Go and Java SDK types carry it (#2134). Thanks @juanbracamonte.
  • Dashboard: an open chat's header has a search button for that chat's stored messages, by text and optionally by day; a day alone jumps to its first loaded message. A hit older than the loaded messages is not scrolled to: the bar asks you to scroll up first (#2129). Thanks @juanbracamonte.
  • MCP: every tool is advertised with a title, the name a client shows: the tool name split into words, or the title its descriptor sets (#2098). Thanks @sudipta-prodevs.
  • MCP: MCP_MAX_RESULT_BYTES, an opt-in cap for clients that put a whole tool result in the model's context. When set, every result, an error answer included, is one text item, cut at that many bytes with a note of its full size, and none is offloaded as a base64 resource; unset or 0, the default, changes nothing (#2100). Thanks @sudipta-prodevs.
  • Dashboard: a message typed in a chat but not sent is listed on that chat's row, after a Draft: label, in place of the last message until the chat is opened again (#2125). Thanks @juanbracamonte.
  • Dashboard: /name typed in the chat composer offers the session's templates by name, and Enter or a click puts the chosen one in the message field, to be sent like any other message; a template that still holds a placeholder is not sent until its text is edited (#2123). Thanks @juanbracamonte.
  • whatsapp-web.js: the 409 answered while WhatsApp Web reloads its page carries code ENGINE_PAGE_RELOADING and retryAfterSeconds, the interval to ask again at, so a client can tell it from other conflicts and retry (#2139).

Changed

  • Baileys: GET /api/sessions/{sessionId}/chats lists name as "" for a privacy-id chat that has no name, where it was the id's own digits (see Upgrade notes) (#2134). Thanks @juanbracamonte.
  • Baileys: a chat's name in GET /api/sessions/{sessionId}/chats is trimmed, and a blank one of a chat not held under a privacy id lists the contact's name or the id's digits, where it was listed as it came (see Upgrade notes).
  • whatsapp-web.js: block and unblock use the library's own LID handling, so an unblock no longer also removes an entry the same person holds under a second id, such as a phone-keyed block from before the LID migration (see Upgrade notes), and a number WhatsApp holds no privacy id for answers 400. The install-time block patch is retired.
  • The MCP MessageList tool lists a media message without its payload unless the call sets inlineMedia: true, where it carried the base64 inline up to the 8 MiB budget, so one photo made the result larger than an MCP client takes.
  • Dashboard: a document in a chat shows as a card with its file name, its size where known and a PDF mark, and a click still downloads it; one left out of the message list showed only Media (#2105). Thanks @mbdali.
  • Dashboard: the message field of a chat is multi-line and grows with its draft: Enter sends, Shift+Enter breaks the line (#2123). Thanks @juanbracamonte.
  • The amd64 image's Chrome for Testing 157.0.8103.78 to 158.0.8127.36, picking up the browser security fixes released since; the arm64 image keeps the chromium package Debian ships.
  • The SSRF guard also refuses the documentation and benchmarking address ranges and the 6a44 relay anycast address 192.88.99.2 in webhook, media, plugin download and plugin request urls (see Upgrade notes).
  • The local media store (STORAGE_LOCAL_PATH, ./data/media by default) is owner-only: its root is set 0700 at every boot when the gateway owns it, and a warning is logged when it does not; new directories and files are written 0700 and 0600, as the databases and the engine auth directories already are (see Upgrade notes).
  • The storage export archive is written 0600 in a 0700 data/exports, where it was 0644 in 0755, so it is as private as the media it copies; the next boot closes the directory of an archive an earlier version left.
  • whatsapp-web.js: the 409 answered while WhatsApp Web reloads its page says to retry every few seconds for up to a few minutes, where it said to retry in a few seconds (#2139).

Fixed

  • Dashboard: an unnamed chat WhatsApp holds under a privacy id is titled by its phone number, in the list and in the header, where both showed the privacy id's own digits (#2134). Thanks @juanbracamonte.
  • Dashboard: the chat search and the webhook chat filter find a chat by its number typed with spaces, a plus sign or parentheses, and an unnamed privacy-id chat by the phone that titles it; the filter's chip and suggestions call that chat by it (#2134). Thanks @juanbracamonte.
  • Dashboard: opening a chat with a mouse click on its row, or from the New chat panel, puts focus in the message field, where typing first needed a click on it; a tap, or a row selected with the keyboard, does not move focus (#2124). Thanks @juanbracamonte.
  • Dashboard: starting an audio or video message pauses the one already playing, where both kept playing at once (#2106). Thanks @mbdali.
  • Baileys: POST /api/sessions/{sessionId}/chats/read sets the chat's unreadCount back to 0 when the receipt names the chat's newest received message, and undoes an unread mark set by hand (chats/unread or on the phone) on every record of the chat, also when a message received after the mark put its count in its place; the count and the mark used to stay, so the dashboard's unread badge came back on every reload (#2109). Thanks @juanbracamonte.
  • Dashboard: a shared contact shows as a card with its name and phone, in the thread, the chat list and a quoted reply, where the raw BEGIN:VCARD text was printed (#2110). Thanks @juanbracamonte.
  • whatsapp-web.js: a message that shares several contacts had an empty body; it now holds their vCards, newline-joined as on Baileys. The chat list preview and a quote of such a message carry them too.
  • whatsapp-web.js: block asks WhatsApp for a number's privacy id when the page holds none, so a number the session never talked to can be blocked.
  • Baileys: a contact's encrypted edit, encrypted reaction, pin, keep-in-chat toggle, album header, event RSVP, encrypted comment or lone fast-ratchet sender-key distribution no longer lists the chat as unread on its own, lists no chat the session holds no record of, and no longer brings back a chat WhatsApp deleted; the engine counts each as a received message. Two or more of them for one chat that reach the socket in one batch, as after a reconnect, are recognised the same way when no message of its own came in that batch.
  • Baileys: such a message merged into a history chunk that counts only that message no longer dates a chat that has a time of its own or brings back a deleted one, and a chat the session holds no other time for is listed at the time the phone gave it; the count it adds stays in the chunk, and a chunk that counts more is left as before.
  • Baileys: a message whose decrypted parts include a fast-ratchet sender-key distribution is typed and announced by its content, and its media is downloaded, its buttons clicked and its text quoted as for any other message; a history sync skips such a distribution when it stands alone, where either reached consumers as an unknown message.
  • Baileys: a history sync's chat title that is only a privacy id no longer replaces the saved, verified or push name a contact holds, so GET /api/sessions/{sessionId}/contacts and the chat list keep the name.
  • Baileys: encrypted edits and reactions of one message are applied in the order they arrived, where the older one could end as the final text or emoji after an offline replay on PostgreSQL.
  • Baileys: a pin, mute, archive, read mark or timer change synced under the other spelling (lid or phone) of a chat shows on its row instead of a second row at the epoch.
  • Baileys: a lid-keyed chat with a pinned, muted or archived state no longer lists a second row under its phone.
  • Baileys: a contact whose only name is its privacy id's digits no longer reports them as its push name or saved name in contact reads, the contact list or a status's poster name.
  • whatsapp-web.js: POST /api/sessions/{sessionId}/messages/send-sticker answers 400 for a video ffmpeg refuses and 503 when the host ffmpeg is missing or cannot run, where both were a 500 that counted toward the session send breaker and kept the Idempotency-Key.
  • whatsapp-web.js: GET /api/sessions/{sessionId}/groups/join-info answers 501 on a WhatsApp Web build with no invite preview job, where every code, valid ones included, was the 404 of an unknown invite. A page reload that lands on the call answers the retryable 409 with code ENGINE_PAGE_RELOADING.
  • whatsapp-web.js: deleting a channel or unsubscribing from one on a page that has not installed the library helpers answers the retryable 409, where it was a bare 500.
  • Baileys: a reaction, edit, delete or poll vote no longer keeps about 1 KB of memory until the account is unlinked.
  • Answer 503, not 500, when the database drops the row read a stop, delete, logout or force-kill makes, the write that records a stop or delete, or the check a stop record makes after a missed write; nothing was stopped, deleted, logged out or killed.
  • Log that another node holds a session only when a live peer does, not on every start or delete of a missing session.
  • whatsapp-web.js: a send, reply, forward or status post that a page reload cuts while it runs answers a 409 that says it may or may not have gone out, where it was a bare 500 that counted toward the session send breaker; a keyed send keeps its Idempotency-Key.
  • Baileys: a media send or product send that fails before the message reaches WhatsApp (the media host refusing the upload, a failed catalog lookup) frees its pacing admission and no longer counts toward the send breaker, and a media sen...
Read more

v0.30.3

Choose a tag to compare

@rmyndharis rmyndharis released this 16 Nov 00:54
c4e19cd

Added

  • Session config key linkPreview: the default for a send-text or send-template that sets neither linkPreview nor customLinkPreview; a value in the request wins (#2080). Thanks @ArraisFilho.
  • List the linkPreview session config key in the JavaScript, Python, Go and Java SDK types.
  • whatsapp-web.js: log the raw type of a message kept as an empty unknown (wwebjs_keep_unmapped, at LOG_LEVEL=debug), so a kind the gateway does not map can be named.
  • Log how many linked sessions stay disconnected because AUTO_START_SESSIONS is off, and how to start them: at boot, and when a session a vanished node left behind is marked disconnected (action=auto_start_disabled) (#2082). Thanks @ArraisFilho.

Fixed

  • A message:sending plugin that rewrites a send-text to carry both linkPreview: false and customLinkPreview now gets the 400 the same request gets directly; Baileys sent it with the preview.
  • whatsapp-web.js: the header of an album no longer arrives as an empty unknown message, live, in the chat history or as a chat's last message; its photos and videos arrive as their own messages, as on Baileys (#2076).
  • whatsapp-web.js: the chat history (REST, MCP and plugin reads) returns a message deleted for everyone under the id of its stored row when its delete notice names the chat, or in a group the author, in the other id form (phone number or lid) and the gateway knows the two to be one person (#2076).
  • Dashboard: a message deleted for everyone is shown once when its history entry and its stored row name the chat or the author in different id forms, phone number and lid (#2076).
  • PATCH /sessions/{sessionId}/config no longer writes the characters of a string or the items of an array back as keys when the stored config is JSON but not an object, as a restored backup can hold.

v0.30.2

Choose a tag to compare

@rmyndharis rmyndharis released this 15 Nov 03:52
3dcaf49

Added

  • Report poll votes as poll.vote on Baileys, as whatsapp-web.js already does. A vote is read while the poll's creation message is still in the session's message store (BAILEYS_MESSAGE_STORE_LIMIT); earlier votes are not backfilled (#2063). Thanks @Shreyas1702003 for the report.

Fixed

  • whatsapp-web.js: an entry WhatsApp Web keeps in a chat that nobody sent (a group or security notice, or a kind the library does not list that carries neither text nor media) is no longer stored or announced as an unknown message, returned by the chat history, seeded as an empty status or reported as a chat's last message (#2076). Thanks @OneArmArmy for the report.
  • whatsapp-web.js: the chat history returns a message deleted for everyone under the id the message had, where it returned the id of the delete notice, so it no longer shows beside its stored copy (#2076).
  • whatsapp-web.js: GET /sessions/{sessionId}/channels/{channelId}/messages no longer returns a deleted channel update as an entry with an empty body (#2077). Thanks @OneArmArmy for the report.
  • Dashboard: a message deleted for everyone is shown once in the chat window of a whatsapp-web.js session, where the stored row and WhatsApp Web's own placeholder for it were both drawn (#2076).
  • Dashboard: an entry with nothing to show no longer draws an empty bubble: an unknown message with no text, media or quote in the chat window, or a channel update with neither text nor media in the Channels tab (#2076, #2077).
  • Dashboard: a message known only from WhatsApp Web's history no longer shows read ticks, since the history carries no delivery status.
  • ctx.mappings.get and ctx.mappings.getByProvider report the handover a plugin instance holds for a chat across its @lid and phone rows (human, else closed, else bot), so a plugin reading one row no longer misses a takeover recorded under the other.
  • Store the contact statuses WhatsApp delivers to some Baileys accounts as a top-level <status> stanza, which 0.30.1 acknowledged and dropped: scripts/patch-baileys-status-ack.js now decodes a stanza shaped as the status message it replaces, so it reaches the status list and the status.received webhook. A status that fails to decrypt is dropped, not retried (#2064). Thanks @damar-glh for the report.
  • A Baileys message or status that decrypts only in part and is left with no content is no longer stored or announced as an empty unknown message, so a redelivery that carries the content is not skipped as a duplicate.
  • A status the account posted is no longer listed among contact statuses on Baileys when WhatsApp names its poster by the account's lid.
  • Cap poll.vote at 32 selectedOptions of 1024 characters each and pollName at 1024 characters on both engines, as an inbound poll already is.
  • Read a contact's encrypted edit or reaction on Baileys when its key names one party by lid and the other by phone number without the alternate id, using the pairing the session already holds.

v0.30.1

Choose a tag to compare

@rmyndharis rmyndharis released this 14 Nov 04:48
fee345d

Added

  • Log when an unlink clears the stored messages and chat states of a Baileys session, where only a failed clear was logged, and document that a reply, forward or reaction to a message from before the unlink answers 404 from then on (#2061). Thanks @rivenash for the report.

Changed

  • The amd64 image's Chrome for Testing 157.0.8103.50 to 157.0.8103.78, the current Stable; the arm64 image keeps the chromium package Debian ships.

Fixed

  • Acknowledge the top-level <status> stanza that WhatsApp now sends some Baileys accounts in place of a status message, so the server stops closing the stream about 50 minutes later with Stream Errored (ack): a new install-time patch, scripts/patch-baileys-status-ack.js, acknowledges and drops it, and a status delivered this way still does not reach the status store (#2064). Thanks @damar-glh for the report.

v0.30.0

Choose a tag to compare

@rmyndharis rmyndharis released this 10 Nov 11:04
f70899d

Added

  • Say how far a Baileys connection had got when it closed: the baileys_connection_dropped log line carries stage and aliveMs, and lastError of a reconnect-looping session ends with a sentence naming the stage.
  • Warn once per connection when WhatsApp asks for a passkey to finish a Baileys link (action=baileys_passkey_required); the link stalled with no word of why (#560).
  • Report a passkey request on a Baileys link as a passkey_required restriction: it reaches GET /api/sessions/{sessionId}, the session.restriction webhook and the dashboard with no status change, and is lifted when a link reaches ready.
  • List the passkey_required restriction kind in the JavaScript, Python, Go and Java SDK types.
  • Accept inlineMedia on the MCP MessageList tool, so an agent can list messages without the base64 of their media, as inlineMedia=false does on GET /api/sessions/{sessionId}/messages; unset keeps the media inline.
  • Accept an idempotencyKey on the eleven MCP send tools, as Idempotency-Key works on the REST send routes: a retry with the same key and arguments returns the first result instead of sending again.
  • Accept the REST message-list filters after, direction, type, since, until, orderBy and messageId on the MCP MessageList tool, and type on MessageSearch.

Changed

  • Log the restart WhatsApp asks for right after it accepts a Baileys link (close 515) as baileys_link_restart, where it was logged as a dropped connection.
  • The MCP SessionGetPresence tool answers observedAt as an ISO date-time, as GET /api/sessions/{sessionId}/presence/{chatId} does, where it answered unix milliseconds.
  • Refuse an MCP tool argument the tool does not name, an unknown key inside customLinkPreview included, with Unrecognized key: "x", where it was dropped and the call ran without it; the published input schemas now say additionalProperties: false.
  • Carry the code of an HTTP error, such as IDEMPOTENCY_KEY_IN_PROGRESS, in an MCP tool error, which returned only its name and message.
  • Show a session restriction on the dashboard card of a session that is waiting for a scan or a pairing code, where the pairing placeholder showed none.
  • The amd64 image's Chrome for Testing 157.0.8103.38 to 157.0.8103.50, picking up the browser security fixes released since; the arm64 image keeps the chromium package Debian ships.
  • Refuse an MCP tool call whose arguments hold more than 10,000 array items and object keys before validating them, where a map of tens of thousands of entries with one wrong value was answered with an issue per entry, megabytes of text.
  • Refuse a from filter of more than 255 characters on the MCP MessageList and MessageSearch tools, as chatId already is.

Fixed

  • Stop an abandoned or cut-off Baileys inbound media download from crashing the gateway with TypeError: terminated, by tying the response body to its decrypting stream in a new install-time patch (#2034). Thanks @voidm4p.
  • Cut the text of an MCP tool error and its log line at 4096 characters, so a long id a caller sent (a group id, a webhook id, a phone number) no longer comes back whole.
  • Accept linkPreview on the MCP MessageSendTemplate tool, as send-template does over REST, and say in both text tools that Baileys attaches a preview only for true.
  • Answer 404 for an MCP GroupFindAll call on an unknown session, as GET /api/sessions/{sessionId}/groups does, where it answered 400 Session is not started.
  • Return an MCP tool result of up to 32 KiB as text, where anything over 4 KiB was offloaded to a base64 resource that Claude Code saves to a local file and shows the model only as a path.

Documentation

  • Add a troubleshooting entry for a Baileys link that is accepted and never becomes ready: what a first login does, and how to tell which step fails.
  • State in CONTRIBUTING.md and docs/08-development-guidelines.md that the dashboard unit tests need Node.js 22.22.2+ on 22, 24.15+ on 24 or 26+ (jsdom), above the Node.js 22.19 floor of the gateway.
  • Document in docs/24-mcp-integration.md how an MCP result over the inline limit and a long tool error are shaped and that tool calls are not forwarded between nodes.
  • Say in the README and .env.example that MCP_READONLY mounts only the read tools unless set to false.
  • Name the fields of a GroupFindAll entry in the MCP tool description.
  • Correct docs/24-mcp-integration.md: with MCP disabled only the MCP module and SDK are skipped, the tool registry is still built.
  • Correct the MCP result limit (32 KiB) and the argument rule in docs/06-api-specification.md, and list the changes to MCP answers in the upgrade hazards of docs/14-migration-guide.md.

Dependencies

  • Update undici to 8.12.4, which fixes six advisories in its cache and redirect interceptors and in fetch integrity checks; the gateway uses none of those features.
  • Update @aws-sdk/client-s3 to 3.1163.0, bullmq to 6.7.1, @bull-board/api, @bull-board/express and @bull-board/nestjs to 9.11.0 and @nestjs/swagger to 11.4.8 in the gateway.
  • Update @tanstack/react-query to 5.107.1, i18next to 26.7.2, i18next-browser-languagedetector to 8.3.0, lucide-react to 1.70.0, react-i18next to 17.1.13 and yet-another-react-lightbox to 3.33.0 in the dashboard bundle.
  • Update jsdom to 31.0.0 in the dashboard tests; the restart progress test compares the bar width numerically, since jsdom now rounds style numbers to six digits.
  • Update eslint to 10.14.0 and globals to 17.14.0 in the gateway and the dashboard, vite to 8.3.6 and @vitejs/plugin-react to 6.2.1 in the dashboard and vitest to 5.1.0 in the JavaScript SDK; these are build, lint and test tooling only.

Upgrade notes (behavior changes)

  • An MCP tool call that carries an argument the tool does not declare, an unknown key inside customLinkPreview included, is refused with Unrecognized key: "x", and the published input schemas say additionalProperties: false; before, the argument was dropped and the call ran without it, so a misspelled quotedMessageId sent the message unquoted.
  • MCP arguments that were dropped before now take effect: idempotencyKey on the eleven send tools (a key reused for a different send answers IDEMPOTENCY_KEY_REUSED, and a retry after a failure that may have sent answers IDEMPOTENCY_OUTCOME_UNKNOWN), linkPreview on MessageSendTemplate, the filters after, direction, type, since, until, orderBy and messageId on MessageList, and type on MessageSearch. Send a fresh key for each intended send and drop a filter the caller did not mean to apply.
  • An MCP call whose arguments hold more than 10,000 array items and object keys, or a from filter of more than 255 characters on MessageList or MessageSearch, is refused; before, neither had a limit.
  • The MCP SessionGetPresence tool answers observedAt as an ISO date-time, as GET /api/sessions/{sessionId}/presence/{chatId} does, where it answered unix milliseconds.
  • The MCP GroupFindAll tool answers NotFoundException for an unknown session, as GET /api/sessions/{sessionId}/groups does, where it answered BadRequestException (Session is not started); a session that exists and is not started still answers that.
  • An MCP tool result of up to 32 KiB arrives as one text block, where anything over 4 KiB was an embedded base64 resource; a larger result is still offloaded. A tool error carries the code of an HTTP error, and its text is cut at 4096 characters.
  • A new restriction kind, passkey_required, reaches GET /api/sessions/{sessionId}, the session.restriction webhook and socket event, the dashboard, the openwa_sessions_restricted gauge and an audit row when WhatsApp asks a Baileys link for a passkey, where nothing was reported. The status does not change and a link that reaches ready lifts it; a stop, start or logout does not, so delete the session or restart the gateway to drop it. A client with a closed list of kinds must accept the new value.
  • The close WhatsApp asks for right after it accepts a Baileys link (code 515) is logged as baileys_link_restart, not baileys_connection_dropped; that line gains stage and aliveMs, the reconnect_loop warning gains stage and statusCode, and the lastError of a reconnect-looping session ends with a sentence on where the last connection closed. A filter or alert on action=baileys_connection_dropped no longer matches the restart, and a consumer should match the start of lastError.

v0.29.1

Choose a tag to compare

@rmyndharis rmyndharis released this 07 Nov 12:01
79d7f86

Added

  • Mark a forwarded message with isForwarded: true and, when positive, forwardingScore on message.received and message.sent on both engines, and on the whatsapp-web.js chat history (#2029). Thanks @visualpathpaulpraksh.

Fixed

  • Pin the next settled WhatsApp Web build from the registry read that named a logged-out page, so a second registry read that fails no longer leaves the session unpinned (#1997). Thanks @Mr4sR.
  • Stop a Baileys session start from blocking the whole process for seconds to tens of seconds on default SQLite when the account has many stored chats it only ever sent to: the chat-name lookup scanned every stored incoming message instead of seeking by chat.

v0.29.0

Choose a tag to compare

@rmyndharis rmyndharis released this 06 Nov 04:48
af348ed

Changed

  • The amd64 image's Chrome for Testing 156.0.8078.80 to 157.0.8103.38, picking up the browser security fixes released since; the arm64 image keeps the chromium package Debian ships.

Fixed

  • A whatsapp-web.js session whose proxy asks for a username and password failed every start after the first with net::ERR_INVALID_AUTH_CREDENTIALS, because WhatsApp Web's service worker, registered in the saved profile, took the page's requests out of reach of the proxy login; the page now ignores the service worker for such a session (#819). Thanks @gudge25 and @lHumanizado for the report.
  • Refuse a WhatsApp Web build whose registry page is the logged-out landing page and pin the next older settled build instead (up to three are tried, warning web_version_html_rejected); every whatsapp-web.js session start used to fail with Cannot read properties of null (reading 'Socket') until the process restarted (#1997). Thanks @ScalingMBA for the report.

Upgrade notes (behavior changes)

  • The amd64 image moves from Chrome for Testing 156 to 157, so an amd64 rollback to 0.28.0 or earlier crosses a browser major and deletes the stored whatsapp-web.js logins unless sessions/ is restored from a backup taken before the first start on the new image (see docs/11-operational-runbooks.md); Baileys sessions are unaffected.

v0.28.0

Choose a tag to compare

@rmyndharis rmyndharis released this 06 Nov 00:14
f963e1f

Added

  • Add GET /api/sessions/{sessionId}/messages/{chatId}/{messageId}/receipts, which lists who received, read and played a message the account sent on whatsapp-web.js (Baileys answers 501), and messages.receipts in all five SDKs (#1748). Thanks @Purushotham-Prajapati-24, and @berodcdev for the request.
  • Plugin ingress routes can set dedupBodyMismatchAsNew to treat a repeated delivery id with a different body as a new delivery; a mismatch is logged and counted in openwa_ingress_dedup_body_mismatches_total either way.

Changed

  • Log the page visibility, the H.264/AAC playback answer and the browser version when a whatsapp-web.js video send or video status post times out in WhatsApp Web's 20 second video load, and document how to read that timeout (#1902). Thanks @benjaminb10 for the report.
  • The Docker image no longer ships the TypeScript compiler and ts-node, about 24 MiB less per architecture; nothing loads them at run time.
  • Refuse POST /api/sessions with 400 for a config over 16384 bytes as JSON; the limit applies at creation, and a stored session above it still loads and takes PATCH /api/sessions/{sessionId}/config.
  • Answer 404, not 400, for an id of letters, digits and hyphens (up to 128 characters) that is not a UUID and that no session has, including a session name, and say the routes take the id.
  • SESSION_PROXY_TIMEOUT_MS covers only the first 4 MiB of a session owner's answer, so a larger one is no longer cut by it, and an owner failure once the relay of such an answer has begun cuts the connection instead of answering 502.
  • Answer 400, before the session's engine is looked up, for an id that names no group on the group read, settings, subject, description, leave, invite code, participants and membership request routes and their MCP tools (such an id reached the engine and was reported as its refusal, 403 or 404), and give the engine the id as <id>@g.us.
  • List a Baileys session's stored chats right after a restart, groups included, with their newest stored message as preview and time and the contact's pushname (#1978). Thanks @farresyh.
  • Record a session's lastActive at most once every 30 seconds instead of on every message, so it can lag the latest message by up to that long.
  • A PUT /api/plugins/{id}/config write to a built-in plugin merges nested objects into the stored config instead of replacing them, and a null clears a key at any depth.
  • Add a partial index on status_updates.mediaPath, created by a migration when the gateway starts, for the status orphan sweep's lookups.

Fixed

  • Install Trivy for the release and scheduled image scans from its GitHub release against a pinned SHA-256, since the action's own installer needs a host that no longer resolves.
  • Stop storing, listing and announcing (status.received) a whatsapp-web.js story that arrives already deleted, live or in the backfill made on connect.
  • Ignore a Baileys edit, delete, reaction or RSVP that carries a lid and the sender's own number when it names a message of another chat or author.
  • Share one lid table lookup between the events of a chat when the gateway expands it for chat-restricted delivery (Redis fan-out on, or a chat-restricted socket connected to the node), and reuse a lookup that found a mapping for 5 seconds.
  • Print no part of an API_MASTER_KEY in the startup banner: the first boot names the key file, and later boots show no fingerprint of a key seeded from it by this release or still configured.
  • Hold Create and Save in the webhook form for a URL with whitespace, <, > or an underscore in the host name, which the gateway refuses, and show the standard URL hint.
  • Drop the 00 exit code from international numbers of any length in the Message Tester, Number Checker and bulk recipients.
  • Stop the new-chat privacy-id lookup when the API key is removed or replaced, the selected session changes or the panel is closed.
  • Keep a search result that waits for the session list from overriding a session, chat or newer result chosen meanwhile, or from raising a notice after the page is left.
  • End a search result's privacy-id phone lookups when the page is left or another session, chat or result is chosen.
  • Report a Message Tester send that the gateway accepted with an empty message id as sent instead of failed.
  • Show a stored plugin choice that the field no longer lists as the selected option, and a null choice as a blank one, so the form saves what it shows.
  • Use the theme text and card colors for chart legends and tooltips so they stay readable in the light and dark themes.
  • Keep the Infrastructure Save Configuration button clear of the notification stack.
  • whatsapp-web.js: a reloaded page whose event listeners fail to attach is no longer counted as recovered, so the watchdog restarts the session instead of leaving it READY without inbound messages.
  • whatsapp-web.js: an auth timeout or browser network error behind a SOCKS proxy URL with credentials now says in lastError that Chromium cannot send them.
  • Metrics scrapes that arrive together share one render, so the cached event-loop delay no longer reads zero after an overlap.
  • Treat the phone and lid forms of a chat as one contact in send pacing when the gateway holds a reported phone pairing for the lid, so replies and group adds for a contact known by its lid are no longer charged as new conversations.
  • Keep the payload of a media send the pending reaper failed while it was in flight when the own-send echo already holds its message id.
  • Answer 503, not 500, when a transient database failure interrupts a read a start, stop or delete makes before it acts (the cap check, the ownership check, a delete's row read, the read after a refused claim); nothing was started, stopped or deleted.
  • Answer 503, not 500, when a transient database failure interrupts the owner lookup a node with NODE_URL makes before routing a session request; nothing was done.
  • Report delivered and then read through message.ack for a Baileys group message once every member has received or read it, instead of leaving it at sent; a status post still stays at sent.
  • List a key seeded from API_MASTER_KEY as (master key) instead of its first 12 characters; keys seeded by earlier releases keep their stored prefix until replaced.
  • Key Baileys chat writes and read receipts to the newest stored message of the account the session is linked to, so a session relinked to another number no longer names the previous account's messages.
  • Warn when a session delete removes only a symlinked auth directory and leaves the WhatsApp login at its target, instead of logging it as purged.
  • Report the chat id of a whatsapp-web.js message.reaction as a string if WhatsApp Web sends it as an object.
  • Clear the stored body, media and metadata of a message deleted on whatsapp-web.js by its bare key id, which stayed in place before.
  • Fold a whatsapp-web.js mention given as a padded, upper-case, @s.whatsapp.net, :device or hosted id to the neutral id before it reaches WhatsApp Web, in text, media, sticker, reply and edit sends, as Baileys already does.
  • Cap the chat media and status orphan sweeps at 100,000 tracked files per pass, so a session delete or a retention run over a large archive no longer grows memory with the number of files left behind.
  • Remove a status, with its media file, from GET /status, GET /status/:id and the status media route when its poster deletes it, instead of serving it until it expires.
  • List a built-in Redis, MinIO or PostgreSQL under removal.errors instead of removal.stopped when a restart could not ask Docker for its container.
  • Keep a working directory .env out of the e2e and unit boots, which read the environment their harness sets; a .env that cannot be read still stops the boot, and the error names the file.
  • Stop the boot, naming the file, when data/.env.generated exists but cannot be read (a directory where a bind mount found no file, or a file the app user cannot open), instead of starting on the defaults without the database and storage settings saved there.
  • Stop the migration CLI, naming the file, when .env or data/.env.generated exists but cannot be read, instead of migrating without that file's settings.
  • Keep a Baileys receipt from another chat from advancing or announcing an own message whose row is still being written.
  • Preview each Baileys chat from its own history message when two chats' messages share an id.
  • Store a Baileys history-sync admin delete of the account's group message as the account's deleted message, and clear a member's own group message deleted in another history chunk.
  • Make the forwarded-message spec wait for the ack to be stored instead of a fixed pause, so it no longer fails intermittently on the PostgreSQL lane.
  • Stop announcing message.ack for the acks of whatsapp-web.js system notices, which are no longer delivered as messages.
  • Stop delivering whatsapp-web.js system notices (a changed security code, the encryption notice, business and broadcast notices) as unknown messages on message.received and message.sent, so they are no longer stored, passed to the message hooks or answered by automation rules (#1864). Thanks @dwimnofan.
  • Compile a chat-restricted key's allowlist once per request instead of once per chat id.
  • Return keyboard focus to the chat list row, or the search field, when the open chat, channel or status is closed.
  • Keep focus in the Number Checker phone field during and after a single check.
  • Keep dialogs that open over the phone navigation drawer usable and release the page scroll lock when they close.
  • Return keyboard focus to Save Configuration after the restart prompt is put off or a save is refused.
  • JavaScript SDK: client.request(), requestBytes() and buildUrl() send the entries of a URLSearchParams or Map query instead of sending the request without them.
  • Allow typing time i...
Read more

v0.27.1

Choose a tag to compare

@rmyndharis rmyndharis released this 01 Nov 20:47
877d59a

Added

  • Add GET /api/sessions/{sessionId}/contacts/{number}/lid, which looks up the @lid WhatsApp holds for a phone number without sending a message and needs an OPERATOR key, and contacts.lid in all five SDKs (#1969). Thanks @farresyh for the report.
  • Python SDK: client.request() takes an idempotency_key.

Fixed

  • Answer GET /api/sessions/{sessionId}/contacts/{contactId}/phone for a phone id from the id itself on whatsapp-web.js, which no longer asks WhatsApp whether the number exists and so no longer works as a number check for keys below OPERATOR.
  • Answer 503, not 500, to GET /api/sessions/{sessionId}/contacts/check/{number} when WhatsApp rate-limits, refuses or drops the query on Baileys, or the whatsapp-web.js page does not answer in time.
  • Read a whatsapp-web.js group whose refresh fails one of WhatsApp Web's own invariants from the metadata the page already holds, so GET /api/sessions/{sessionId}/groups/{groupId} and /labels/{labelId}/chats no longer answer 404 for it, and the chat lookups behind its group setting, chat action, chat label and message routes use that metadata too (#1962).
  • Reload the active API key index after seeding the first admin key, so a failed first read no longer leaves body admission without it until the next refresh. Thanks @Purushotham-Prajapati-24.
  • Stop sending message.edited on the webhook and socket for an edit that reaches a message already deleted, for everyone or, through POST /api/sessions/{sessionId}/messages/delete, for this account only, which handed consumers new text for a message that was already gone. Thanks @rupeshreddynagolu.
  • Keep the @lid and @s.whatsapp.net previews of one Baileys chat in step when a history-sync revoke, or a live edit or revoke, names the chat under the other id.
  • Keep a Baileys chat preview cleared when an edit reaches a message already deleted for everyone, so GET /api/sessions/{sessionId}/chats and the dashboard sidebar no longer show the deleted text.
  • Refuse a Baileys send or status post with 409, rather than sending on a replacement socket, when its connection changes during the media fetch, quote or recipient lookup, preview upload or product lookup; a send cut off by reconnect backoff now answers 409, where it answered 503.
  • Answer 503 (not sent) instead of 500 for a Baileys product send whose catalog lookup is cut off by a closed connection, and hand back its pacing admission.
  • Stop an old engine's disconnect report, sent while a reconnect tears it down, from using up a second reconnect attempt.
  • Record and announce a WhatsApp unlink whose session row could not be read when the session is stopped, logged out or deleted, or the gateway shuts down, instead of dropping it.
  • Stop a disconnect read retry that is still re-reading from overwriting a session that has become READY and tearing down its recovered engine.
  • Make a session delete wait for a logout that is still waiting on the session's initial status, instead of purging its data while the logout runs.
  • Reject chat and group ids with more than one @ or an empty local part, in the API and in the API Keys form.
  • Pass the canonical groupId to the engine on the /groups/{groupId}/picture routes, which forwarded an upper-case, padded or device-suffixed id as sent.
  • Answer 404 to a malformed channelId, a bare @newsletter or an id with more than one @, on the channel delete, mute, unsubscribe, admin demote and owner transfer routes; demote and transfer passed any value to the engine, the others accepted such an id.
  • Answer 400 to a boolean limit in POST /api/webhooks/delivery-failures/redrive instead of redriving one delivery.
  • Retract the secrets of retired or rolled-back wildcard plugin instances from the plugin base config and registry.json when an infrastructure backup is imported, on the node that runs the import.
  • Keep a valid key's GET /api/health check from freeing the limiter slot of a newer failed attempt.
  • Log an unreadable API key store on GET /api/health, at most once a minute, instead of recording it as an API_KEY_AUTH_FAILED credential failure.
  • Stop throttled dashboard media downloads from retrying after the API key changes or is cleared.
  • Keep the dashboard chat composer's in-flight send state per conversation, so a slow send in one chat no longer disables Send in another.
  • Restore keyboard focus to the Export data, Import data or Download backup first control after a backup finishes, without scrolling the page.
  • Refuse . and .. path segments, percent-encoded ones too, in raw Python and PHP SDK request paths, as the JavaScript, Go and Java SDKs do.
  • Keep the first segment of a raw Python SDK request path that starts with //, which httpx read as a host name and dropped.
  • Type GroupInfo.owner as a non-null JID in the JavaScript SDK, and ChatHistoryMessage.mentionedIds and MessageContact.labels as list[str] in the Python SDK.
  • Answer 503 instead of 500 when the Baileys connection drops under a group or channel request (a create excepted), a catalog, label, contact, profile, block, chat or call request.
  • Answer 404 instead of 500 when WhatsApp refuses a Baileys group read with a 4xx code other than the ones already mapped.
  • Answer 503 instead of 500, with nothing sent and a keyed send's Idempotency-Key freed, when the identity check behind a Baileys reply, forward, button click, reaction, edit, delete, star, pin or unpin is rate-limited or loses its connection; the chat writes and read receipts that run the same check answer 503 too.
  • Free a keyed Baileys sticker send's Idempotency-Key when sharp cannot load, and keep that failure out of the send breaker.
  • Refuse with 403 a Baileys edit of a message that has no text or caption, as whatsapp-web.js does, instead of answering 200 and rewriting the stored body.
  • Send a Baileys contact card with its display name.
  • Clear a Baileys message and its chat preview when a contact's delete for everyone reaches history sync in a later chunk than the message.
  • Stop recording a Baileys history-sync group delete, for a message the session does not hold, as a deleted message sent by the account.
  • Answer 409 to a Baileys pairing-code request when the session stops or reconnects while the code is being requested, instead of returning a code nothing can link or a 500.
  • Answer GET /api/sessions/{sessionId}/presence/{chatId} for a chat id written with @s.whatsapp.net, a :device suffix or in upper case, and on Baileys for a contact whose presence WhatsApp reports from its @lid once that pairing has been reported, all of which answered null.
  • Keep a whatsapp-web.js session READY when a WhatsApp Web reload cuts a page call short, which marked it disconnected and forced a full reconnect; a read cut short this way answers the retryable reload 409, where it answered 503.
  • Apply whatsapp-web.js chat label adds and removes addressed by a contact's <phone>@c.us id to its chat when WhatsApp Web keys that chat by @lid, which answered 200 and changed nothing.
  • Free the Idempotency-Key of a whatsapp-web.js send refused before anything was sent (an unknown chat or quoted message; a reply, location or contact card to a channel, status or broadcast list; a poll or sticker to a status or broadcast list; media to a channel; a custom link preview), which a retry answered with 409 outcome unknown.
  • Answer 503 (not sent) instead of 500 when the chat read before a whatsapp-web.js reply or forward outruns the page's protocol timeout.
  • Answer 400 (not sent) to a whatsapp-web.js sticker whose type is neither an image nor a video, instead of a 500 the send breaker counted.
  • Resolve a whatsapp-web.js send to <phone>@s.whatsapp.net, an upper-case @C.US or a :device id like its <phone>@c.us form, so a contact WhatsApp addresses by @lid is reached instead of refused with 500.
  • Answer 503 instead of 500 when the whatsapp-web.js blocklist read outruns the page's protocol timeout.
  • Answer 403, where it answered 200 or 500, to whatsapp-web.js participant remove, promote and demote, to the membership requests read, and to approving or rejecting every pending request, for an account that is not an admin of the group, as the routes document.
  • Pin the browser locale on whatsapp-web.js Chromium args stored through the plugin config API, as on the built-in defaults.
  • Retry a whatsapp-web.js pairing code request that lands on a freshly reloaded QR page instead of answering 500.
  • Kill the Chromium a whatsapp-web.js stop or delete left launching once the init deadline force-destroys the engine, instead of leaving it running on the session's profile.
  • Detect whatsapp-web.js onboarding dialogs drawn with position: fixed, which the onboarding probes never saw.
  • Keep contact.id in whatsapp-web.js contact details (WEBHOOK_CONTACT_DETAILS=true) on a WhatsApp Web build that renamed its id field.
  • Refuse with 400 a start sent while a whatsapp-web.js reconnect waits for the same profile removal, which launched a second engine and left the reconnect's running where stop, force-kill, delete and shutdown could not reach it.
  • Keep a whatsapp-web.js session's push name when it becomes ready while its account info cannot be read, instead of blanking it.
  • Store the forwarded message's type, text and media on the row POST /api/sessions/{sessionId}/messages/forward writes, instead of a [Forwarded] placeholder that the message list, the dashboard and search kept showing; a new forward is no longer typed forward in ?type=forward and in the byType statistics.
  • Read unfinished bulk batches one at a time when failing them at startup, on a session takeover, delete or data import, so a restart after a crash mid-run no longer loads every batch's media payloads at once, nor a live peer's.
  • Answer 400 to POST /api/sessions/{sessionId}/messages/send-template ...
Read more

v0.27.0

Choose a tag to compare

@rmyndharis rmyndharis released this 31 Oct 03:27
d99fa20

Added

  • Add a session switcher to the dashboard Chats page that lists every session with its state, picture, push name and number, and lets only a ready one be selected. Thanks @rjsebening.
  • Add a contact info panel to the dashboard chat room with the contact's picture, name, number and copyable chat id. Thanks @rjsebening.
  • Add Today, Yesterday and date separators to the dashboard chat thread. Thanks @rjsebening.
  • Add match=contains to GET /api/search, which needs SEARCH_CONTAINS_ENABLED=true: case- and accent-insensitive substring search on a trigram index (FTS5 on SQLite, pg_trgm and unaccent on PostgreSQL) that ranks the 1,000 most recently stored matches, so total is at most 1,000 in this mode; match=word stays the default and the SDKs accept match (#1899). Thanks @luisffm.
  • Add the MessageSearch MCP tool, which runs the global message search for agents, with match=contains by default only when SEARCH_CONTAINS_ENABLED=true (#1899). Thanks @luisffm.
  • Add PUT /api/sessions/{sessionId}/groups/{groupId}/member-label to set this account's member label in a group on Baileys; whatsapp-web.js answers 501, and setMemberLabel in all five SDKs (#1918). Thanks @xwork1 for the report.
  • Add thumbnailUrl and thumbnailBase64 to customLinkPreview on Baileys for an image that renders the large preview card, at most 5 MiB, also in the typed SDKs (#1917). Thanks @lrissatto.
  • Add a warning log and a phone_second_lid_reported audit row, filed under the reporting session, when a session reports a privacy id the gateway did not hold, or held only outside its mapping cache, for a phone number the lid table already maps to another reported id.
  • Add a hint to the dashboard API Keys form that an @lid chat entry also admits the phone number mapped to it.

Changed

  • Redesign the dashboard Chats page in a WhatsApp Web style, full height without the page header, with its own light and dark palette, a patterned wallpaper behind the thread, coloured avatars, tailed bubbles and a single-pill composer; every existing chat feature stays (#1887). Thanks @rjsebening.
  • Show the dashboard Chats page's message search behind a toggle in the chat list header, still hidden for read-only keys. Thanks @rjsebening.
  • Show the raw chat id of a dashboard chat in its contact info panel instead of the room header. Thanks @rjsebening.
  • Show a dashboard chat message's time and delivery ticks inside its last line of text, with the delivery status still named for screen readers. Thanks @rjsebening.
  • Show dashboard chat list times as the clock today, Yesterday, the weekday within the last week and a short date before that. Thanks @rjsebening.
  • Move the dashboard sidebar's collapse button from the sidebar edge into its header, beside the logo or under it when collapsed, with a panel icon mirrored for right-to-left languages. Thanks @rjsebening.
  • Offer Clear chat and Delete chat in the dashboard on Baileys sessions too, now that the phone applies both (#1891).
  • Show each audit row's message under its action on the dashboard Logs page.

Fixed

  • List a whatsapp-web.js group from the metadata the page already holds when WhatsApp Web fails one of its own invariants while refreshing it, so one such group no longer turns GET /api/sessions/{sessionId}/groups and /chats into a permanent 500 (#1950). Thanks @Bhavikg27.
  • Index a Baileys clear, delete, archive or unread by the same chat jid as its message key, so the phone applies it (#1891). Thanks @rjsebening.
  • Key Baileys chat writes and read receipts to the gateway's newest stored message when the session holds none in memory (#1891). Thanks @rjsebening.
  • Send a Baileys archive or mark unread without a range for a chat the session knows but holds no message for, where it answered success: false (#1891). Thanks @rjsebening.
  • Group dashboard phone numbers in threes and fours, so +49 157 333 4 4455 now reads +49 157 3334 4455; 10-digit numbers keep their shape (#1940).
  • Make the deleted-message and omitted-media labels in outgoing dashboard chat bubbles readable in dark mode.
  • Match the dashboard New chat search against contact numbers only when the query reads as a phone number, so a name with a digit no longer lists every contact whose number holds that digit.
  • Read the dashboard Chats page's session list again when the page is shown, so a session deleted elsewhere no longer stays open.
  • Draw group sender names in dashboard chat threads in colours that clear 4.5:1 on the incoming bubble in light and dark themes.
  • Draw links inside a quoted dashboard chat message in the chat link colours, which clear 4.5:1 on the quote in light and dark themes.
  • Draw the selection check in the dashboard New group list dark on its green fill, where white measured under 3:1.
  • Name the buttons that remove a staged file and close a reply above the dashboard chat composer for screen readers.
  • Announce the unread badges on dashboard chat list rows to screen readers, including the dot of a chat marked as unread.
  • Mark dashboard chat messages as tappable on touch screens, so iOS reveals their reply, react and delete actions on a tap as hover does with a mouse.
  • Fit the dashboard chat room's menu to the room's height, scrolling its entries, so a short window no longer cuts off the last ones.
  • Keep a member's name and number at the start edge of the dashboard group dialog in right-to-left languages, where a Latin name and every number sat at the left.
  • Name an unnamed dashboard chat by its formatted number on its list row, in its menu, dialogs and toasts and on the reply banner, instead of the bare digits of its id.
  • Close the connection of a refused /events handshake, or of a subscribe refused because its key is no longer valid, which stayed open with no namespace.
  • Name the refused API key in the audit row of a WebSocket refusal, and answer a key store that cannot be read with INTERNAL_ERROR instead of a refused key.
  • Show the caption of a Baileys photo, video or document, the text of a disappearing or view-once message, and the button label of a native-flow reply, in the chat list preview instead of a blank line, and the native-flow label and envelope text in quotedMessage.body of a message quoting it.
  • Keep a Baileys chat list preview from taking an edit or delete sent by someone other than the message's author; in a group a delete from any member still counts, as an admin may delete.
  • Report message.ack only for messages the account sent, so reading a received message on the phone no longer marks it read (both engines).
  • Answer 409 "nothing to unlink" for a logout of a Baileys session with no linked device, instead of a 502 that asked to retry.
  • Show a QR on the next start of a Baileys session whose pairing code was never entered.
  • End the wait for a Baileys pairing code nobody enters after 5 minutes and show a new QR.
  • Bound the Baileys group invite-code read and revoke at 30 s like the other group calls.
  • Answer 503 (not sent) for a Baileys send or status post cut off by a closed connection, instead of an opaque 500, handing back its pacing admission and a keyed send's Idempotency-Key.
  • Free a keyed send's Idempotency-Key when it was refused before anything was sent: its media could not be fetched, its session was not ready or its WhatsApp Web page was reloading, or, on Baileys, its sticker or preview image could not be read, its recipient is not registered, its quoted or forwarded message is not stored or is stored under another chat, or its connection was replaced or stopped before the write, so the retry is sent instead of answering 409 IDEMPOTENCY_OUTCOME_UNKNOWN.
  • List a Baileys chat again, with its unread count, when a message arrives in the same second as its deletion.
  • Keep a Baileys receipt from one chat off another chat's message with the same id.
  • Answer the engine error instead of 400 "not on WhatsApp" for a whatsapp-web.js send whose recipient lookup did not answer, without counting it toward the send breaker.
  • Recycle a whatsapp-web.js session whose page reloaded without re-injecting its helpers once it has gone 3 minutes that way, without recycling a slow reload that did re-inject.
  • Skip the whatsapp-web.js message-id backport of a --best-effort install on a read-only tree it never wrote to, instead of failing it.
  • Keep a session start or reconnect that lost its claim to another node from marking that node's session disconnected.
  • Link the number that scans the reconnect QR after WhatsApp unlinks a session, also when a reconnect was already pending, instead of logging it out and failing the session.
  • Say a session with reconnect disabled was marked failed when it drops.
  • Return reconnectBaseDelay as an integer from session config, so the Go and Java SDKs decode a value stored with a fraction before validation.
  • Run the graceful drain on one Ctrl+C or stop signal under npm or the Nest CLI, which delivered it twice and forced exit 130; a repeat 1 s or more later still forces the exit.
  • Write the env loader's boot lines at the configured LOG_LEVEL and format, after .env is read.
  • Name an unknown LOG_FORMAT at boot, with the format used instead.
  • Log a failed chmod of the generated env or bootstrap key file through the structured logger, at the configured LOG_LEVEL and after the env loader's first-run line, instead of a raw console line.
  • Boot through PgBouncer in session mode: the PostgreSQL statement timeout and a custom schema's search path are set after connect, as the time zone already was, instead of in the startup packet.
  • Back up only the configured non-public POSTGRES_SCHEMA with its search extensions, and pgcrypto when it lives in that schema, so a database shared with other applications no longer fails the backup or comes back with their schemas on restore.
  • Stream chat and status media downloads from the store instead of reading the whole file into memory.
  • ...
Read more