Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(message): say only Baileys accepts a send to an unregistered number

Yudhi Armyndharis8ef1c38c4793
diff --git a/openapi.json b/openapi.json
index 62c4f86d9..6c1509a8c 100644
--- a/openapi.json
+++ b/openapi.json
@@ -19418,7 +19418,7 @@
"properties": {
"messageId": {
"type": "string",
- "description": "The message id, assigned when the gateway accepts the message for sending. A 201 here means the message was handed to the WhatsApp client — it does NOT confirm delivery. WhatsApp does not reject an unregistered recipient synchronously, so a message to a number that is not on WhatsApp still returns 201 with a valid messageId; whether it later delivers, stalls, or is reported as an error reaches you asynchronously, if at all. To confirm a number is on WhatsApp before sending, use GET /api/sessions/{sessionId}/contacts/check/{number}; track real delivery via the message `status` field (sent → delivered → read, or failed if WhatsApp reports an error for it). A message resting at `sent` is not diagnostic on its own: a registered recipient whose device has not come online since the send stays at `sent` too.",
+ "description": "The message id, assigned when the gateway accepts the message for sending. A 201 here means the message was handed to the WhatsApp client — it does NOT confirm delivery. On Baileys a message to a number that is not on WhatsApp still returns 201 with a valid messageId (whatsapp-web.js answers 400); whether it later delivers, stalls, or is reported as an error reaches you asynchronously, if at all. To confirm a number is on WhatsApp before sending, use GET /api/sessions/{sessionId}/contacts/check/{number}; track real delivery via the message `status` field (sent → delivered → read, or failed if WhatsApp reports an error for it). A message resting at `sent` is not diagnostic on its own: a registered recipient whose device has not come online since the send stays at `sent` too.",
"example": "[email protected]_3EB0123456789"
},
"timestamp": {
diff --git a/src/modules/message/dto/send-message.dto.ts b/src/modules/message/dto/send-message.dto.ts
index 31eca12e1..322697053 100644
--- a/src/modules/message/dto/send-message.dto.ts
+++ b/src/modules/message/dto/send-message.dto.ts
@@ -343,9 +343,9 @@ export class MessageResponseDto {
@ApiProperty({
description:
'The message id, assigned when the gateway accepts the message for sending. A 201 here means the ' +
- 'message was handed to the WhatsApp client — it does NOT confirm delivery. WhatsApp does not reject ' +
- 'an unregistered recipient synchronously, so a message to a number that is not on WhatsApp still ' +
- 'returns 201 with a valid messageId; whether it later delivers, stalls, or is reported as an error ' +
+ 'message was handed to the WhatsApp client — it does NOT confirm delivery. On Baileys a message to a ' +
+ 'number that is not on WhatsApp still returns 201 with a valid messageId (whatsapp-web.js answers ' +
+ '400); whether it later delivers, stalls, or is reported as an error ' +
'reaches you asynchronously, if at all. To confirm a number is on WhatsApp before ' +
'sending, use GET /api/sessions/{sessionId}/contacts/check/{number}; track real delivery via the ' +
'message `status` field (sent → delivered → read, or failed if WhatsApp reports an error for it). ' +