Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): describe the number check id as the neutral form

Yudhi Armyndharise95c7fda902e
diff --git a/sdk/javascript/src/types.ts b/sdk/javascript/src/types.ts
index 9a94e2f1b..4bfb49f6e 100644
--- a/sdk/javascript/src/types.ts
+++ b/sdk/javascript/src/types.ts
@@ -782,7 +782,10 @@ export interface ContactRecord {
export interface CheckNumberResponse {
number: string;
exists: boolean;
- /** The canonical chat id in the engine's native format, or `null` when the number is not registered. */
+ /**
+ * The chat id WhatsApp holds for the number, in the neutral `<phone>@c.us` form on both engines (it can
+ * differ from the digits supplied), or `null` when the number is not registered.
+ */
whatsappId: string | null;
}