Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(api): list the whatsapp-web.js 501 on location, contact, poll, reply
Yudhi Armyndharis395edd7b7b31
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.mdindex 18085f140..2b54162f8 100644--- a/docs/06-api-specification.md+++ b/docs/06-api-specification.md@@ -1904,7 +1904,7 @@ Send a location pin.{ "messageId": "[email protected]_3EB0ABCD", "timestamp": 1719312000 }```-**Errors:** `400` invalid coords / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable)+**Errors:** `400` invalid coords / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable) · `501` whatsapp-web.js cannot send a location to a channel (`<id>@newsletter`) or a status or broadcast list (`@broadcast`); nothing is sent#### POST /api/sessions/:sessionId/messages/send-contact@@ -1937,7 +1937,7 @@ Send a contact card (vCard).{ "messageId": "[email protected]_3EB0ABCD", "timestamp": 1719312000 }```-**Errors:** `400` validation failure / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable)+**Errors:** `400` validation failure / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable) · `501` whatsapp-web.js cannot send a contact card to a channel (`<id>@newsletter`) or a status or broadcast list (`@broadcast`); nothing is sent#### POST /api/sessions/:sessionId/messages/send-sticker@@ -2002,7 +2002,7 @@ Send a native WhatsApp poll.{ "messageId": "[email protected]_3EB0ABCD", "timestamp": 1719312000 }```-**Errors:** `400` validation failure (option count/length) / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable)+**Errors:** `400` validation failure (option count/length) / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable) · `501` whatsapp-web.js cannot send a poll to a status or broadcast list (`@broadcast`), nor one with `quotedMessageId` to a channel (`<id>@newsletter`); nothing is sent#### POST /api/sessions/:sessionId/messages/reply@@ -2037,7 +2037,7 @@ Reply to a message, quoting a prior message.The quoted body is best-effort resolved from the DB for the reply preview.-**Errors:** `400` validation failure / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable)+**Errors:** `400` validation failure / session not active / unknown body field · `401` missing/invalid API key · `403` key role below OPERATOR · `500` engine error · `409` conflict or engine not ready (retryable) · `501` whatsapp-web.js cannot send a reply to a channel (`<id>@newsletter`) or a status or broadcast list (`@broadcast`); nothing is sent#### POST /api/sessions/:sessionId/messages/click-button