Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): mark the session proxyType field as ignored

Yudhi Armyndharis43880e36fabf
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index a2b6bb70d..1aee66d63 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -549,7 +549,7 @@ Create a new WhatsApp session.
| `name` | string | Yes | `@IsString`; length 3–50; `@Matches(/^[a-zA-Z0-9-]+$/)` (letters, numbers, hyphens only) | Unique session name; duplicate → `409` |
| `config` | object | No | `@IsOptional`; `@IsObject` (keys not validated) | Session settings. Only `autoRejectCalls` (boolean, Baileys only), `maxReconnectAttempts` (clamped to 0-20, default unlimited) and `reconnectBaseDelay` (ms, clamped to 1000-300000, default 5000) are read; other keys are stored but ignored. Change them later with `PATCH /api/sessions/:sessionId/config`. Defaults to `{}`; never returned in responses |
| `proxyUrl` | string | No | `@IsOptional`; `@IsString`; max 255; `@IsUrl` (protocols `http`/`https`/`socks4`/`socks5`, `require_protocol`, `require_tld:false`, `allow_underscores`) | Per-session proxy egress; credentialed `http://user:pass@host` and single-label hosts allowed; trusted egress, not SSRF-blocked; setting it requires an ADMIN key (`403` otherwise). ⚠ **Must be a real, reachable proxy** — an unreachable value silently blocks the WhatsApp WebSocket (no QR, start → `504`); leave unset unless you need it. See "Per-session egress proxy" below. |
-| `proxyType` | `http` \| `https` \| `socks4` \| `socks5` | No | `@IsOptional`; `@IsIn([...])` | Proxy protocol |
+| `proxyType` | `http` \| `https` \| `socks4` \| `socks5` | No | `@IsOptional`; `@IsIn([...])` | Deprecated and ignored: the `proxyUrl` scheme selects the proxy protocol |
```json
{
@@ -561,13 +561,12 @@ Create a new WhatsApp session.
Minimal: `{ "name": "my-bot" }`.
**Optional — per-session egress proxy.** Route a session's traffic through a proxy only if your
-network cannot reach WhatsApp directly. Set `proxyUrl`/`proxyType` on the same request:
+network cannot reach WhatsApp directly. Set `proxyUrl` on the same request:
```json
{
"name": "my-bot",
- "proxyUrl": "http://user:[email protected]:8080",
- "proxyType": "http"
+ "proxyUrl": "http://user:[email protected]:8080"
}
```