Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(session): say reconnect settings apply on the next start

Yudhi Armyndharis5c26e9fff9ea
diff --git a/openapi.json b/openapi.json
index bd0d32891..2bd3421b2 100644
--- a/openapi.json
+++ b/openapi.json
@@ -10324,7 +10324,7 @@
},
"config": {
"type": "object",
- "description": "Session configuration. Only three keys are read: autoRejectCalls (boolean, default false, Baileys engine only) rejects incoming calls as soon as they ring, and the call.received event is still emitted first; maxReconnectAttempts (0-20, default unlimited) caps consecutive reconnects and reconnectBaseDelay (1000-300000 ms, default 5000) sets the backoff base, both for the gateway's own reconnect only (on Baileys the engine retries a transient drop itself, with a fixed backoff and no cap). Anything else is stored but ignored. All three can be changed later with PATCH /api/sessions/{sessionId}/config, without restarting the session.",
+ "description": "Session configuration. Only three keys are read: autoRejectCalls (boolean, default false, Baileys engine only) rejects incoming calls as soon as they ring, and the call.received event is still emitted first; maxReconnectAttempts (0-20, default unlimited) caps consecutive reconnects and reconnectBaseDelay (1000-300000 ms, default 5000) sets the backoff base, both for the gateway's own reconnect only (on Baileys the engine retries a transient drop itself, with a fixed backoff and no cap). Anything else is stored but ignored. All three can be changed later with PATCH /api/sessions/{sessionId}/config without a restart: autoRejectCalls applies from the next incoming call, the two reconnect settings from the next session start.",
"example": {
"autoRejectCalls": false,
"maxReconnectAttempts": 5,
diff --git a/src/modules/session/dto/create-session.dto.ts b/src/modules/session/dto/create-session.dto.ts
index 376e9f388..44fa3ce3a 100644
--- a/src/modules/session/dto/create-session.dto.ts
+++ b/src/modules/session/dto/create-session.dto.ts
@@ -25,8 +25,9 @@ export class CreateSessionDto {
'reconnectBaseDelay (1000-300000 ms, default 5000) sets the backoff base, both for the ' +
"gateway's own reconnect only (on Baileys the engine retries a transient drop itself, with a " +
'fixed backoff and no cap). Anything else is ' +
- 'stored but ignored. All three can be changed later with PATCH /api/sessions/{sessionId}/config, ' +
- 'without restarting the session.',
+ 'stored but ignored. All three can be changed later with PATCH /api/sessions/{sessionId}/config ' +
+ 'without a restart: autoRejectCalls applies from the next incoming call, the two reconnect settings ' +
+ 'from the next session start.',
example: { autoRejectCalls: false, maxReconnectAttempts: 5, reconnectBaseDelay: 5000 },
})
@IsOptional()