Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(api): document the rate-limit 503 on group and channel routes

Yudhi Armyndharisdbf8ac3f7478
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index f21abfe5b..9dd2bf9f8 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -2793,7 +2793,7 @@ Get the group's picture URL.
**Response** `200` — `{ "url": "https://…" }`, or `{ "url": null }` when the group has no picture or
it is hidden by privacy settings.
-**Errors:** `400` the id does not name a group, or the session is not active · `401` missing/invalid API key · `409` engine not ready · `503` WhatsApp did not answer within the request budget — nothing could be read
+**Errors:** `400` the id does not name a group, or the session is not active · `401` missing/invalid API key · `409` engine not ready · `503` WhatsApp did not answer within the request budget — nothing could be read; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### PUT /api/sessions/:sessionId/groups/:groupId/picture
@@ -2811,7 +2811,7 @@ Set the group's picture. The account must be a group admin.
**Response** `200` — `{ "success": true, "message": "Group picture updated" }`
-**Errors:** `400` the id does not name a group, the session is not active, neither `url` nor `base64` was supplied, or the `url` answers non-2xx, times out or cannot be reached · `401` missing/invalid API key · `403` key lacks OPERATOR role, or the engine refused (admin rights required) · `404` no such group · `409` the session is not connected (engine exists but is not `ready`) · `413` base64 or downloaded media over the media cap (see §6.3) · `503` a `url` fetch through the session's egress proxy failed before any response, the proxy or the target at fault (retryable), or WhatsApp did not answer within the request budget — the change may or may not have been applied
+**Errors:** `400` the id does not name a group, the session is not active, neither `url` nor `base64` was supplied, or the `url` answers non-2xx, times out or cannot be reached · `401` missing/invalid API key · `403` key lacks OPERATOR role, or the engine refused (admin rights required) · `404` no such group · `409` the session is not connected (engine exists but is not `ready`) · `413` base64 or downloaded media over the media cap (see §6.3) · `503` a `url` fetch through the session's egress proxy failed before any response, the proxy or the target at fault (retryable), or WhatsApp did not answer within the request budget — the change may or may not have been applied; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### DELETE /api/sessions/:sessionId/groups/:groupId/picture
@@ -2821,7 +2821,7 @@ Remove the group's picture. The account must be a group admin.
**Response** `200` — `{ "success": true, "message": "Group picture removed" }`
-**Errors:** `400` the id does not name a group, or the session is not active · `401` missing/invalid API key · `403` key lacks OPERATOR role, or the engine refused (admin rights required) · `404` no such group · `409` the session is not connected (engine exists but is not `ready`) · `503` WhatsApp did not answer within the request budget — the change may or may not have been applied
+**Errors:** `400` the id does not name a group, or the session is not active · `401` missing/invalid API key · `403` key lacks OPERATOR role, or the engine refused (admin rights required) · `404` no such group · `409` the session is not connected (engine exists but is not `ready`) · `503` WhatsApp did not answer within the request budget — the change may or may not have been applied; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### GET /api/sessions/:sessionId/groups/:groupId/invite-code
@@ -2889,7 +2889,7 @@ Returns the created `Group` directly (raw).
}
```
-**Errors:** `400` validation (missing/empty `name` or `participants`, or any non-DTO field) / session not started, or a participant does not name an individual (phone, `<phone>@c.us` or `<lid>@lid`) · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or WhatsApp refused the create · `409` conflict or engine not ready (retryable) · `429` `SEND_PACING_LIMITED` when send pacing is enabled (cold-reachout cap, see Send pacing) · `501` not supported on the active engine
+**Errors:** `400` validation (missing/empty `name` or `participants`, or any non-DTO field) / session not started, or a participant does not name an individual (phone, `<phone>@c.us` or `<lid>@lid`) · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or WhatsApp refused the create · `409` conflict or engine not ready (retryable) · `429` `SEND_PACING_LIMITED` when send pacing is enabled (cold-reachout cap, see Send pacing) · `501` not supported on the active engine · `503` WhatsApp rate-limited the create on Baileys (code 429; nothing was created, so a retry is safe; a timed-out create is not answered `503`)
#### POST /api/sessions/:sessionId/groups/:groupId/participants
@@ -3323,7 +3323,7 @@ Each entry is a `GroupMembershipRequest`: `participantId` (the user asking to jo
`method` (`invite_link` | `non_admin_add` | `linked_group_join`), optional `requestedAt` (unix
seconds).
-**Errors:** `400` session is not started · `401` missing/invalid `X-API-Key` · `403` the engine refused the read — admin rights required · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget
+**Errors:** `400` session is not started · `401` missing/invalid `X-API-Key` · `403` the engine refused the read — admin rights required · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### POST /api/sessions/:sessionId/groups/:groupId/membership-requests/approve
@@ -3367,14 +3367,14 @@ for every **named** requester is a `403`.
}
```
-**Errors:** `400` validation / session not started · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or the engine refused (admin rights / every named requester failed) · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget
+**Errors:** `400` validation / session not started · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or the engine refused (admin rights / every named requester failed) · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### POST /api/sessions/:sessionId/groups/:groupId/membership-requests/reject
Reject pending join requests. Same body, response shape, batch-guard contract and error map as
`.../membership-requests/approve`; rejecting an empty queue is likewise a no-op.
-**Errors:** `400` validation / session not started · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or the engine refused (admin rights / every named requester failed) · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget
+**Errors:** `400` validation / session not started · `401` missing/invalid `X-API-Key` · `403` key lacks OPERATOR role, or the engine refused (admin rights / every named requester failed) · `404` no such group · `409` engine not ready · `503` WhatsApp did not answer within the request budget; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
```json
{
@@ -3844,7 +3844,7 @@ engine can delete a channel it does not own.
**Response** `201` — the created `Channel`, including its `inviteCode` (the code, not the full
`https://whatsapp.com/channel/…` link — the code is what `POST /channels/subscribe` takes).
-**Errors:** `400` validation, or session not started · `401` · `403` the engine refused (on whatsapp-web.js this includes channel creation being disabled for the account) · `409` conflict or engine not ready (retryable)
+**Errors:** `400` validation, or session not started · `401` · `403` the engine refused (on whatsapp-web.js this includes channel creation being disabled for the account) · `409` conflict or engine not ready (retryable) · `503` WhatsApp rate-limited the create on Baileys (code 429; nothing was created, so a retry is safe; a timed-out create is not answered `503`)
#### POST /api/sessions/:sessionId/channels/:channelId/delete
@@ -3905,7 +3905,7 @@ fails. Rather than ship a route that always errors on that engine, it answers `5
**Response** `200` — `{ "success": true }`
-**Errors:** `400` validation, or session not started · `401` · `403` the engine refused (not the owner, or the user is not an admin) · `409` conflict or engine not ready (retryable) · `501` the whatsapp-web.js engine cannot perform this · `503` WhatsApp did not answer within the request budget
+**Errors:** `400` validation, or session not started · `401` · `403` the engine refused (not the owner, or the user is not an admin) · `409` conflict or engine not ready (retryable) · `501` the whatsapp-web.js engine cannot perform this · `503` WhatsApp did not answer within the request budget; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### POST /api/sessions/:sessionId/channels/:channelId/owner/transfer
@@ -3934,7 +3934,7 @@ repopulate. Rather than ship a route that always fails on that engine, it answer
**Response** `200` — `{ "success": true }`
-**Errors:** `400` validation, or session not started · `401` · `403` WhatsApp refused the transfer · `409` conflict or engine not ready (retryable) · `501` the whatsapp-web.js engine cannot perform this · `503` WhatsApp did not answer within the request budget, and the transfer may or may not have applied
+**Errors:** `400` validation, or session not started · `401` · `403` WhatsApp refused the transfer · `409` conflict or engine not ready (retryable) · `501` the whatsapp-web.js engine cannot perform this · `503` WhatsApp did not answer within the request budget, and the transfer may or may not have applied; on Baileys, also when WhatsApp rate-limits or times out the request (code 429 or 408): retry after a pause
#### POST /api/sessions/:sessionId/channels/subscribe
diff --git a/src/modules/channel/channel.controller.spec.ts b/src/modules/channel/channel.controller.spec.ts
index bf7e9f307..8329f4ae2 100644
--- a/src/modules/channel/channel.controller.spec.ts
+++ b/src/modules/channel/channel.controller.spec.ts
@@ -105,3 +105,28 @@ describe('ChannelController OpenAPI 404 on delete and unsubscribe', () => {
expect(responses['404']?.description).not.toContain('synced');
});
});
+
+describe('ChannelController OpenAPI 503 responses', () => {
+ const responsesOf = (name: string): Record<string, { description?: string }> =>
+ (Reflect.getMetadata(
+ 'swagger/apiResponse',
+ Object.getOwnPropertyDescriptor(ChannelController.prototype, name)!.value as object,
+ ) ?? {}) as Record<string, { description?: string }>;
+
+ // Baileys answers 503 for WhatsApp's own rate limit (429) as well as for an unanswered query.
+ it('names the WhatsApp rate limit on every 503 it declares', () => {
+ const silent = Object.getOwnPropertyNames(ChannelController.prototype).filter(name => {
+ const description = responsesOf(name)['503']?.description;
+ return description !== undefined && !description.includes('429');
+ });
+ expect(silent).toEqual([]);
+ });
+
+ it('declares the rate-limited 503 on channel creation', () => {
+ expect(responsesOf('create')['503']?.description).toContain('429');
+ });
+
+ it('does not describe the lookup 503 as a change that may have applied', () => {
+ expect(responsesOf('findOne')['503']?.description).not.toContain('applied');
+ });
+});
diff --git a/src/modules/channel/channel.controller.ts b/src/modules/channel/channel.controller.ts
index 237419442..5bd424899 100644
--- a/src/modules/channel/channel.controller.ts
+++ b/src/modules/channel/channel.controller.ts
@@ -20,6 +20,12 @@ import {
const CHANNEL_ID_INVALID_404 =
'The id is not a channel id (it does not end in `@newsletter`). Retrying the same id cannot succeed.';
+// Every Baileys channel call maps WhatsApp's own rate-limit and server-timeout answers to 503 as well,
+// so each 503 below ends with this sentence; a throttled caller should back off, not retry at once.
+const THROTTLED_503 =
+ ' On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); ' +
+ 'retry after a pause.';
+
@ApiTags('channels')
@Controller('sessions/:sessionId/channels')
export class ChannelController {
@@ -52,7 +58,7 @@ export class ChannelController {
})
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description: 'WhatsApp did not answer within the request budget — nothing could be read.' + THROTTLED_503,
})
@ApiResponse({
status: 404,
@@ -110,6 +116,12 @@ export class ChannelController {
@ApiResponse({ status: 201, description: 'The created channel', type: ChannelDto })
@ApiResponse({ status: 400, description: 'Session not started, or validation failed' })
@ApiResponse({ status: 403, description: 'The engine refused — channel creation may be disabled for this account' })
+ @ApiResponse({
+ status: 503,
+ description:
+ 'WhatsApp rate-limited the create (code 429, Baileys); nothing was created, so retrying after a pause is ' +
+ 'safe. A timed-out create is not answered 503, because the channel may have been created.',
+ })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async create(@Param('sessionId') sessionId: string, @Body() dto: CreateChannelDto) {
return this.channelService.createChannel(sessionId, dto.name, dto.description);
@@ -130,7 +142,8 @@ export class ChannelController {
@ApiResponse({ status: 200, description: 'Channel deleted', type: ChannelAckResponseDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the operation may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started' })
@ApiResponse({ status: 403, description: 'The engine refused — not found, or this account does not own it' })
@@ -157,7 +170,8 @@ export class ChannelController {
@ApiResponse({ status: 200, description: 'Channel muted or unmuted', type: ChannelAckResponseDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the operation may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started, or validation failed' })
@ApiResponse({ status: 403, description: 'The engine refused' })
@@ -187,7 +201,8 @@ export class ChannelController {
@ApiResponse({ status: 200, description: 'Admin demoted', type: ChannelAckResponseDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the operation may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started, or validation failed' })
@ApiResponse({ status: 403, description: 'The engine refused — not the owner, or the user is not an admin' })
@@ -225,7 +240,8 @@ export class ChannelController {
@ApiResponse({ status: 200, description: 'Ownership transferred', type: ChannelAckResponseDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the transfer may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the transfer may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started, or validation failed' })
@ApiResponse({
@@ -271,7 +287,8 @@ export class ChannelController {
@ApiResponse({ status: 201, description: 'Successfully subscribed to channel', type: ChannelDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the operation may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({
status: 501,
@@ -293,7 +310,8 @@ export class ChannelController {
@ApiResponse({ status: 200, description: 'Successfully unsubscribed from channel', type: ChannelAckResponseDto })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — the operation may or may not have applied.',
+ description:
+ 'WhatsApp did not answer within the request budget — the operation may or may not have applied.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started' })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
diff --git a/src/modules/group/group.controller.spec.ts b/src/modules/group/group.controller.spec.ts
index dfc1c61ff..83e86cc30 100644
--- a/src/modules/group/group.controller.spec.ts
+++ b/src/modules/group/group.controller.spec.ts
@@ -151,4 +151,24 @@ describe('GroupController OpenAPI responses', () => {
});
expect(missing).toEqual([]);
});
+
+ const responsesOf = (name: string): Record<string, { description?: string }> =>
+ (Reflect.getMetadata(
+ 'swagger/apiResponse',
+ Object.getOwnPropertyDescriptor(GroupController.prototype, name)!.value as object,
+ ) ?? {}) as Record<string, { description?: string }>;
+
+ // Baileys answers 503 for WhatsApp's own rate limit (429) as well as for an unanswered query, and a
+ // throttled caller should back off rather than retry at once, so every 503 has to say so.
+ it('names the WhatsApp rate limit on every 503 it declares', () => {
+ const silent = Object.getOwnPropertyNames(GroupController.prototype).filter(name => {
+ const description = responsesOf(name)['503']?.description;
+ return description !== undefined && !description.includes('429');
+ });
+ expect(silent).toEqual([]);
+ });
+
+ it('declares the rate-limited 503 on group creation', () => {
+ expect(responsesOf('create')['503']?.description).toContain('429');
+ });
});
diff --git a/src/modules/group/group.controller.ts b/src/modules/group/group.controller.ts
index 5dbede97b..ec380cf21 100644
--- a/src/modules/group/group.controller.ts
+++ b/src/modules/group/group.controller.ts
@@ -35,17 +35,24 @@ import {
SESSION_NOT_STARTED_400,
} from '../../common/openapi/engine-status-responses';
+// Every Baileys group call maps WhatsApp's own rate-limit and server-timeout answers to 503 as well,
+// so each 503 below ends with this sentence; a throttled caller should back off, not retry at once.
+const THROTTLED_503 =
+ ' On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); ' +
+ 'retry after a pause.';
+
// Reading an invite code is admin-only, but the groups list returns every group the account
// belongs to whatever its role — so these two statuses apply to ids the caller was just given.
const INVITE_CODE_403 = 'The engine refused the request — admin rights required for this group';
-const INVITE_CODE_503 = 'WhatsApp did not answer the invite-code query — retry shortly';
+const INVITE_CODE_503 = 'WhatsApp did not answer the invite-code query — retry shortly.' + THROTTLED_503;
// Shared by the four participant writes, whose 200 reports per-participant refusals inside `results` —
// so this 503 has to say, on all four, that it is not one of those.
const PARTICIPANTS_503 =
'WhatsApp did not answer within the request budget, so no per-participant outcome was read at all. ' +
'Deliberately not folded into the 200 above — a participant WhatsApp turned down is reported inside ' +
- '`results` and is an answer; an update that never came back is not.';
+ '`results` and is an answer; an update that never came back is not.' +
+ THROTTLED_503;
// Shared by group creation and the four participant writes: an entry that does not name an individual
// is rejected here rather than handed to the engine, where it produced an unnamed page-side failure.
@@ -85,7 +92,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. Deliberately not folded into the 404 above — ' +
- 'a query that never came back is not the same claim as a group that does not exist.',
+ 'a query that never came back is not the same claim as a group that does not exist.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 400, description: 'Session not started, or no code supplied' })
@ApiResponse({ status: 404, description: 'No such invite — invalid, expired or revoked' })
@@ -103,7 +111,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. Deliberately not folded into the 404 above — ' +
- 'a query that never came back is not the same claim as a group that does not exist.',
+ 'a query that never came back is not the same claim as a group that does not exist.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 404, description: 'Group not found' })
@ApiResponse({ status: 400, description: SESSION_NOT_STARTED_400 })
@@ -124,7 +133,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async join(@Param('sessionId') sessionId: string, @Body() dto: JoinGroupDto) {
@@ -140,7 +150,7 @@ export class GroupController {
@ApiResponse({ status: 404, description: 'Group not found' })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — nothing could be read.',
+ description: 'WhatsApp did not answer within the request budget — nothing could be read.' + THROTTLED_503,
})
@ApiResponse({ status: 400, description: SESSION_NOT_STARTED_400 })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@@ -163,7 +173,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async updateSettings(
@@ -184,6 +195,12 @@ export class GroupController {
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@ApiResponse({ status: 403, description: ENGINE_REFUSED_403 })
@ApiResponse({ status: 400, description: PARTICIPANT_ID_400 })
+ @ApiResponse({
+ status: 503,
+ description:
+ 'WhatsApp rate-limited the create (code 429); nothing was created, so retrying after a pause is safe. ' +
+ 'A timed-out create is not answered 503, because the group may have been created.',
+ })
@ApiResponse({
status: 501,
description:
@@ -311,7 +328,10 @@ export class GroupController {
@ApiParam({ name: 'sessionId', description: 'Session ID' })
@ApiParam({ name: 'groupId', description: 'Group ID' })
@ApiResponse({ status: 200, description: 'Pending membership requests', type: [GroupMembershipRequestDto] })
- @ApiResponse({ status: 503, description: 'WhatsApp did not answer within the request budget — retry shortly' })
+ @ApiResponse({
+ status: 503,
+ description: 'WhatsApp did not answer within the request budget — retry shortly.' + THROTTLED_503,
+ })
@ApiResponse({ status: 400, description: SESSION_NOT_STARTED_400 })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@ApiResponse({ status: 403, description: ENGINE_REFUSED_403 })
@@ -401,7 +421,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 400, description: BODY_OR_SESSION_400 })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@@ -428,7 +449,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 400, description: BODY_OR_SESSION_400 })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@@ -454,7 +476,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 400, description: SESSION_NOT_STARTED_400 })
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@@ -479,7 +502,7 @@ export class GroupController {
@ApiResponse({ status: 400, description: 'The id does not name a group, or the session is not active' })
@ApiResponse({
status: 503,
- description: 'WhatsApp did not answer within the request budget — nothing could be read.',
+ description: 'WhatsApp did not answer within the request budget — nothing could be read.' + THROTTLED_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
async getPicture(@Param('sessionId') sessionId: string, @Param('groupId') groupId: string) {
@@ -505,7 +528,9 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came. ' +
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503 +
+ ' ' +
MEDIA_URL_PROXY_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@@ -534,7 +559,8 @@ export class GroupController {
status: 503,
description:
'WhatsApp did not answer within the request budget. The change may or may not have been applied — ' +
- 'the gateway stopped waiting for a confirmation that never came.',
+ 'the gateway stopped waiting for a confirmation that never came.' +
+ THROTTLED_503,
})
@ApiResponse({ status: 409, description: ENGINE_NOT_READY_409 })
@ApiResponse({ status: 404, description: GROUP_NOT_FOUND_404 })