Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(sdk): say how to recover from the idempotency 409 outcomes
Yudhi Armyndharisf17d2a028aa6
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 272d7a99a..b474f8892 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -96,7 +96,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0- Keep a re-sent ingress delivery redrivable when an earlier dead letter for its id was already redriven.- Deliver Baileys API edit and revoke events to webhook and WebSocket consumers.- Preserve chat-scoped WebSocket event order while resolving chat identities.-- Serialize explicitly selected empty Go redrive slices as empty arrays.- Emit Baileys API reaction updates, including reaction removal.- Restore legacy webhook failures and normalize terminal duplicates before SQLite schema synchronization.- Exclude retained webhook replay payloads from database backup reads.@@ -112,7 +111,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0- Preserve archived media and reactions during concurrent metadata updates.- Keep sent media when merging onto an echo row fails.- Enforce chat media size limits using decoded payload bytes.-- Preserve the Java failure constructor and empty Go redrive filters.- Keep narrow chat panes scrollable and prevent message actions from shrinking previews.- Open archived images in the dashboard media viewer without fetching them again.- Forward container shutdown signals after dropping process privileges in Compose and Helm.diff --git a/sdk/go/README.md b/sdk/go/README.mdindex cd1b3e18e..86586e5e7 100644--- a/sdk/go/README.md+++ b/sdk/go/README.md@@ -286,4 +286,4 @@ ctx := openwa.WithIdempotencyKey(context.Background(), "order-123")_, err := client.Messages.SendText(ctx, sessionID, openwa.SendTextRequest{ChatID: "[email protected]", Text: "Hello"})```-The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; pending or uncertain outcomes return 409, and a changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.+The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; a 409 with the error `code` `IDEMPOTENCY_KEY_IN_PROGRESS` means the first request is still running, so retry with the same key later; a 409 `IDEMPOTENCY_OUTCOME_UNKNOWN` means the message may have been sent, so check the chat and, if it did not arrive, send again with a new key (the `code` tells them apart from the engine-not-ready 409). A changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.diff --git a/sdk/java/README.md b/sdk/java/README.mdindex c8c5c79e0..cb76e6634 100644--- a/sdk/java/README.md+++ b/sdk/java/README.md@@ -228,4 +228,4 @@ Supply a unique caller-owned key for one logical send and reuse it when retryingclient.messages.sendText(sessionId, new SendTextRequest("[email protected]", "Hello"), "order-123");```-The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; pending or uncertain outcomes return 409, and a changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.+The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; a 409 with the error `code` `IDEMPOTENCY_KEY_IN_PROGRESS` means the first request is still running, so retry with the same key later; a 409 `IDEMPOTENCY_OUTCOME_UNKNOWN` means the message may have been sent, so check the chat and, if it did not arrive, send again with a new key (the `code` tells them apart from the engine-not-ready 409). A changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.diff --git a/sdk/javascript/README.md b/sdk/javascript/README.mdindex 97ba90039..02131b8e3 100644--- a/sdk/javascript/README.md+++ b/sdk/javascript/README.md@@ -140,4 +140,4 @@ Supply a unique caller-owned key for one logical send and reuse it when retryingawait client.messages.sendText(sessionId, { chatId: '[email protected]', text: 'Hello' }, 'order-123');```-The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; pending or uncertain outcomes return 409, and a changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.+The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; a 409 with the error `code` `IDEMPOTENCY_KEY_IN_PROGRESS` means the first request is still running, so retry with the same key later; a 409 `IDEMPOTENCY_OUTCOME_UNKNOWN` means the message may have been sent, so check the chat and, if it did not arrive, send again with a new key (the `code` tells them apart from the engine-not-ready 409). A changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.diff --git a/sdk/php/README.md b/sdk/php/README.mdindex 4ad56eca1..4a1158ce7 100644--- a/sdk/php/README.md+++ b/sdk/php/README.md@@ -170,4 +170,4 @@ Supply a unique caller-owned key for one logical send and reuse it when retrying$client->messages->sendText($sessionId, ['chatId' => '[email protected]', 'text' => 'Hello'], 'order-123');```-The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; pending or uncertain outcomes return 409, and a changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.+The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; a 409 with the error `code` `IDEMPOTENCY_KEY_IN_PROGRESS` means the first request is still running, so retry with the same key later; a 409 `IDEMPOTENCY_OUTCOME_UNKNOWN` means the message may have been sent, so check the chat and, if it did not arrive, send again with a new key (the `code` tells them apart from the engine-not-ready 409). A changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.diff --git a/sdk/python/README.md b/sdk/python/README.mdindex 096aff4c2..6d2d47215 100644--- a/sdk/python/README.md+++ b/sdk/python/README.md@@ -178,4 +178,4 @@ Supply a unique caller-owned key for one logical send and reuse it when retryingclient.messages.send_text(session_id, {"chatId": "[email protected]", "text": "Hello"}, idempotency_key="order-123")```-The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; pending or uncertain outcomes return 409, and a changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.+The gateway supports text, image, video, audio, document, sticker, location, contact, template, poll, reply and forward sends. Completed calls replay their response; a 409 with the error `code` `IDEMPOTENCY_KEY_IN_PROGRESS` means the first request is still running, so retry with the same key later; a 409 `IDEMPOTENCY_OUTCOME_UNKNOWN` means the message may have been sent, so check the chat and, if it did not arrive, send again with a new key (the `code` tells them apart from the engine-not-ready 409). A changed request with the same key returns 422. The gateway retains keys for 24 hours. Bulk, product and button operations have no such guarantee. Omit the key to preserve existing behavior.