Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(openapi): refresh the snapshot for group and channel 503s
Yudhi Armyndharis842b0f0d6d95
diff --git a/openapi.json b/openapi.jsonindex 6c1509a8c..7ecf00a76 100644--- a/openapi.json+++ b/openapi.json@@ -1886,7 +1886,7 @@}},"400": {- "description": "A participant does not name an individual. Pass a phone number, `<phone>@c.us` or `<lid>@lid`; a group id or free text is rejected.",+ "description": "A participant does not name an individual. Pass a phone number, `<phone>@c.us` or `<lid>@lid`; a group id or free text is rejected. With send pacing on, also answered (without `retryAfterSeconds`) when the request names more new contacts than the whole day's cold-reachout allowance; split it into smaller batches.","content": {"application/json": {"schema": {@@ -1934,6 +1934,16 @@}}}+ },+ "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.",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ErrorResponse"+ }+ }+ }}},"summary": "Create a new group",@@ -9197,7 +9207,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9298,7 +9308,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9390,7 +9400,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9491,7 +9501,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9610,7 +9620,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9671,7 +9681,7 @@}},"400": {- "description": "A participant does not name an individual. Pass a phone number, `<phone>@c.us` or `<lid>@lid`; a group id or free text is rejected.",+ "description": "A participant does not name an individual. Pass a phone number, `<phone>@c.us` or `<lid>@lid`; a group id or free text is rejected. With send pacing on, also answered (without `retryAfterSeconds`) when the request names more new contacts than the whole day's cold-reachout allowance; split it into smaller batches.","content": {"application/json": {"schema": {@@ -9721,7 +9731,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9830,7 +9840,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -9941,7 +9951,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10052,7 +10062,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10157,7 +10167,7 @@}},"503": {- "description": "WhatsApp did not answer within the request budget — retry shortly",+ "description": "WhatsApp did not answer within the request budget — retry shortly. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10269,7 +10279,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10381,7 +10391,7 @@}},"503": {- "description": "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.",+ "description": "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10492,7 +10502,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10603,7 +10613,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10704,7 +10714,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10795,7 +10805,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -10914,7 +10924,7 @@}},"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 session routes its `url` fetches through an egress proxy, and the fetch failed or timed out before any response arrived, so the request was not carried out. The proxy or the target behind it may be at fault; the gateway cannot tell which. Retryable, but a `503` that persists while the proxy works points at the `url`. Without a session proxy the same failure answers `400`.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause. The session routes its `url` fetches through an egress proxy, and the fetch failed or timed out before any response arrived, so the request was not carried out. The proxy or the target behind it may be at fault; the gateway cannot tell which. Retryable, but a `503` that persists while the proxy works points at the `url`. Without a session proxy the same failure answers `400`.","content": {"application/json": {"schema": {@@ -11013,7 +11023,7 @@}},"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.",+ "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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -11114,7 +11124,7 @@}},"503": {- "description": "WhatsApp did not answer the invite-code query — retry shortly",+ "description": "WhatsApp did not answer the invite-code query — retry shortly. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -11215,7 +11225,7 @@}},"503": {- "description": "WhatsApp did not answer the invite-code query — retry shortly",+ "description": "WhatsApp did not answer the invite-code query — retry shortly. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -12841,6 +12851,16 @@}}}+ },+ "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.",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ErrorResponse"+ }+ }+ }}},"summary": "Create a channel",@@ -12934,7 +12954,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13033,7 +13053,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13248,7 +13268,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13360,7 +13380,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13472,7 +13492,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13584,7 +13604,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {@@ -13706,7 +13726,7 @@}},"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. On Baileys, also answered when WhatsApp rate-limits or times out the request (code 429 or 408); retry after a pause.","content": {"application/json": {"schema": {