Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(wwebjs): align the list-timeout and contact-list error docs

Yudhi Armyndharis337406db140b
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index a4b450f46..d1d8e179d 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -2354,7 +2354,7 @@ The `Contact` object returned by the list and get-by-id routes has this shape:
List all contacts for a session, returned as an in-memory paginated window.
-On Baileys the list is the saved address book: contacts with a name saved on the phone (`isMyContact: true`), rebuilt from WhatsApp's app-state contact collection on connect, including after a process restart. A peer known only by its pushname is not listed but still resolves through the get-by-id route below with `isMyContact: false`. whatsapp-web.js lists what the WhatsApp Web page holds, which also includes unsaved chat partners (`isMyContact: false`). An entry the page cannot read, or one without a readable id (for example a device-scoped id), is left out of the list; the gateway logs a warning with the count, and the response does not signal it.
+On Baileys the list is the saved address book: contacts with a name saved on the phone (`isMyContact: true`), rebuilt from WhatsApp's app-state contact collection on connect, including after a process restart. A peer known only by its pushname is not listed but still resolves through the get-by-id route below with `isMyContact: false`. whatsapp-web.js lists what the WhatsApp Web page holds, which also includes unsaved chat partners (`isMyContact: false`). An entry the page cannot read (for example a device-scoped id), or one without a readable id, is left out of the list; the gateway logs a warning with the count, and the response does not signal it.
**Auth:** API key
@@ -2387,7 +2387,7 @@ On Baileys the list is the saved address book: contacts with a name saved on the
]
```
-**Errors:** `400` session is not started · `401` missing/invalid API key, or key not scoped to this session · `409` conflict or engine not ready (retryable) · `500` engine error, including whatsapp-web.js when some entries could not be read and no unblocked contact was readable (a page-wide failure, not an empty address book) · `503` the WhatsApp page died while reading contacts or the command timed out (retry shortly)
+**Errors:** `400` session is not started · `401` missing/invalid API key, or key not scoped to this session · `409` conflict or engine not ready (retryable) · `500` engine error, including whatsapp-web.js when entries could not be read and no unblocked contact was, or when no entry had a readable id (a page-wide failure, not an empty address book) · `503` the WhatsApp page died while reading contacts or the command timed out (retry shortly)
#### GET /api/sessions/:sessionId/contacts/blocked
diff --git a/docs/12-troubleshooting-faq.md b/docs/12-troubleshooting-faq.md
index 50ef465ca..81f87f1b4 100644
--- a/docs/12-troubleshooting-faq.md
+++ b/docs/12-troubleshooting-faq.md
@@ -777,7 +777,7 @@ quoting the message it printed.
> A patch that never applied is not fatal on its own: only the capability it repairs is affected and
> the rest of the gateway runs normally, which is why this is easy to misread as a bug in one route.
-### Issue: Reads on a large account fail with `Runtime.callFunctionOn timed out`
+### Issue: Reads on a large account fail with `did not answer ... in time` or `Runtime.callFunctionOn timed out`
> **Engine:** This issue applies to the `whatsapp-web.js` engine only (Chromium/Puppeteer-based). It does not affect `ENGINE_TYPE=baileys`.
@@ -793,7 +793,8 @@ quoting the message it printed.
**Cause:** Puppeteer gives every browser command a time budget, 180 000 ms by default, and one
`getChats()` over a very large store can run past it. The renderer is still working; only the
command is dropped. That is also why this is **not** treated as a dead page — a transport death
-answers `503` and takes the session down with it, and this is just a slow command on a live page.
+takes the session down with it, while this is just a slow command on a live page. The chat and contact
+lists answer it with a `503` as well, but the session stays `ready`.
**Solution:** raise the budget for that deployment.