📘 תיעוד 1

Go WhatsApp: בנוי לשימוש יעיל בזיכרון

#תמיכה ב-GOWA

GOWA חוסך לכם זמן פיתוח או מפעיל את העסק שלכם? עזרו לקיים את הפרויקט דרך GitHub Sponsors.

חסות עוזרת לפנות זמן עבור:

• חקירת באגים והתעדכנות בשינויים של WhatsApp ושל whatsmeow.
• שיפור בדיקות רגרסיה, תיעוד ודוגמאות אינטגרציה.
• סקירת תרומות והכנת גרסאות.

חסות חודשית עוזרת להפוך את התחזוקה השוטפת לבת קיימא יותר. יחידים וצוותים מוזמנים.

לתת חסות ל-GOWA ב-GitHub →

עדיין לא מוכנים לתת חסות? גם דיווחי באגים שניתן לשחזר, שיפורי תיעוד ושיתוף של GOWA עוזרים.

#תמיכה ב-ARM, ב-AMD64 וב-MCP

הורדה:

• Release
• Docker Hub
• GitHub Container Registry

#תיעוד

קראו את תיעוד GOWA המפורט להתקנה, לאימות, לניהול מכשירים, ל-webhooks, לדוגמאות ולחומר העזר של ה-API. התיעוד עוקב אחרי main שמוזג, כולל שינויים אחרי v9.7.0. בדקו את הערות הגרסה ואת GET /app/info כשמשתמשים בקובץ בינארי או בתג קונטיינר נעוץ.

• הודעות אינטראקטיביות ניסיוניות מכסה כפתורי native-flow, בקשות מיקום וקרוסלות תמונה. POST /send/interactive הוא מיידי בלבד ו-REST בלבד. התאימות אצל הנמען משתנה.
• מטעני webhook מתאר סכמות אירועים וחתימה.
• Chatwoot, MCP OAuth, Neon ואחסון מדיה מספקים מדריכי אינטגרציה ותפעול.
• OpenAPI מגדיר את חוזה ה-REST הקריא למכונה, כולל /send/interactive.

#צומת קהילה של n8n

• חבילת n8n
• עברו אל Settings → Community Nodes, הזינו @aldinokemal2104/n8n-nodes-gowa, ובחרו Install.

#שינויים שוברים

• v6

  • מצב REST דורש <binary> rest במקום <binary>.
    • דוגמה: ./whatsapp rest במקום ./whatsapp.
  • מצב MCP דרש <binary> mcp.
    • דוגמה: ./whatsapp mcp.

• v7

  • החל מגרסה 7.x, הקבצים הבינאריים נבנים עם GoReleaser ואפשר להוריד אותם מגרסת latest.

• v8

  • תמיכה בריבוי מכשירים: אפשר עכשיו לחבר ולנהל כמה חשבונות WhatsApp בו זמנית במופע שרת יחיד.

  • API חדש לניהול מכשירים: נקודות קצה חדשות תחת /devices מנהלות כמה מכשירים.

  • נדרש תיחום מכשיר: כל קריאות REST API שתחומות למכשיר דורשות עכשיו אחד מאלה:

    • כותרת X-Device-Id, או
    • פרמטר שאילתה device_id.
    • אם רשום מכשיר אחד בלבד, הוא משמש כברירת מחדל.

  • בחירת מכשיר ב-WebSocket: התחברו אל /ws?device_id=<id> עבור תווכת המכשיר. רכזת ה-WebSocket הנוכחית משדרת אירועי לוח בקרה לכל המנויים המאומתים. הפרמטר הזה לא מבודד אירועים בין חשבונות. לאינטגרציות של יישומים השתמשו ב-webhooks לכל מכשיר.

  • תמיכה בממשק מרוחק: CORS מתיר את הכותרות Authorization ו-X-Device-Id, כך שממשק ווב עצמאי (למשל gowa-ui) שמתארח במקור אחר יכול לקרוא ל-API ישירות. GET /app/info חושף את הגרסה ואת מגבלות גודל המדיה. מאחר שדפדפנים לא יכולים להגדיר כותרות בחיבורי WebSocket, העבירו /ws?device_id=<id>&authorization=<base64(user:pass)> כש-Basic Auth מופעל (השתמשו ב-TLS: האישור גלוי בכתובת).

  • שינויים במטען webhook: כל מטעני ה-webhook כוללים עכשיו שדה device_id ברמה העליונה, שמזהה איזה מכשיר קיבל את האירוע:

    העתק

    {
      "event": "message",
      "device_id": "[email protected]",
      "payload": { ... }
    }

• v9

  • MCP וה-API מאוחדים תחת rest: MCP כבר אינו מצב או תהליך נפרד. הריצו ./whatsapp rest כדי לשרת גם את REST API וגם את MCP. MCP זמין ב-/mcp (אין תת פקודה עצמאית mcp). ראו שרת MCP (Model Context Protocol) לפרטי מעבר.
  • הממשק עבר למאגר נפרד: לוח הבקרה הווב כבר אינו ארוז במאגר הזה. הוא נמצא עכשיו ב-aldinokemal/gowa-ui ונשלח כקובץ gowa-ui.html יחיד שמכיל את עצמו. השרת מוריד את גרסת לוח הבקרה העדכנית בהפעלה, מאמת את תקציר ה-SHA-256 שלה, שומר אותה במטמון תחת storages/ui/, ומגיש אותה ב-/. ראו לוח בקרה ווב (gowa-ui) להגדרות APP_UI_*, לנעיצת שרשרת אספקה ולפריסה מנותקת רשת.

#יכולות

• שליחת הודעות WhatsApp דרך HTTP API. ראו docs/openapi.yaml לפרטים.

• תמיכה בשרת MCP (Model Context Protocol): שילוב עם סוכני AI ועם כלים באמצעות פרוטוקול אחיד.

• MCP OAuth 2.1 אופציונלי: חיבור לקוחות MCP מרוחקים שלא יכולים לספק כותרת Basic Auth. ראו MCP OAuth.

• אזכור משתמשים בטקסט הודעה ובכיתוב של תמונה, וידאו או קובץ:

  • @phoneNumber
  • דוגמה: Hello @628974812XXXX, @628974812XXXX

• אזכורי רפאים (אזכור כולם): אזכור משתתפי קבוצה בלי להציג @phone בטקסט ההודעה.

  • העבירו מספרי טלפון בשדה mentions כדי לאזכר משתמשים בלי @ גלוי בהודעה.
  • השתמשו במילת המפתח המיוחדת @everyone כדי לאזכר אוטומטית את כל משתתפי הקבוצה.

• פרסום עדכוני סטטוס ב-WhatsApp.

• סימון הודעות שמע נכנסות והודעות קוליות כהודעות שהושמעו.

• שליחות מתוזמנות: תזמון סוגי שליחה נתמכים פעם אחת, או בחזרה יומית, שבועית או חודשית.

  • הוסיפו scheduled_at (RFC3339) ו-timezone (IANA) לבקשת שליחה. recurrence, weekdays, day_of_month, end_at ו-occurrence_limit שולטים בחזרות.
  • תזמונים שורדים הפעלות מחדש וממתינים למכשיר לא מקוון. אפשר לרשום, להשהות, לחדש או לבטל אותם ב-/send/schedules.
  • מופע שנכשל מנוסה שוב תחת אותו מזהה הודעת WhatsApp, כך ששליחה שאישור שלה אבד לא מנוסה שוב תחת זהות חדשה. גם ניסיונות חוזרים של סקר משתמשים מחדש בסוד השמור. מופעים בפרוטוקול החדש שהופסקו בהפעלה מחדש ממשיכים באותה דרך. ניסיונות ישנים עם תוצאה לא ידועה מדולגים או נכשלים. זה לא מבטיח מסירה של פעם אחת בדיוק.

• ערוצי ניוזלטר: מעקב או ביטול מעקב אחרי ערוצים, שליפת מטא-נתונים לפי JID או הזמנה, שאילתת ספריית הערוצים והורדת מדיה של ערוץ.

  • קריאת הודעות עם /newsletter/messages, רענון מונים עם /newsletter/message-updates, וניהול מנויי מונה חי מתחדשים עם /newsletter/live-updates.
  • מנויים חיים נמצאים בזיכרון. הירשמו שוב אחרי הפעלת שרת מחדש. אירועי מונה מגיעים כ-webhooks מסוג newsletter.message.

• מדדי שרת: GET /app/metrics מאומת מדווח על תהליך, זיכרון, דיסק, ספירת מכשירים ומטא-נתוני אחסון בלי כותרת מכשיר. הוא מחזיר JSON, לא טקסט Prometheus.

• נוכחות אנשי קשר: POST /user/presence/subscribe נרשם לעדכוני מחובר או לא מחובר של איש קשר, והם נמסרים דרך אירוע ה-webhook presence. שליחת הנוכחות שלכם נשארת תחת /send/presence.

• שגיאות אווטאר: GET /user/avatar מבדיל בין 404 AVATAR_NOT_SET ל-403 AVATAR_HIDDEN. השתמשו בקוד השגיאה לפני שפוסלים תמונה שנשמרה במטמון.

• שליחת מדבקות: המרה אוטומטית של תמונות לפורמט מדבקת WebP.

  • תומך בפורמטים JPG, JPEG, PNG, WebP ו-GIF.
  • משנה אוטומטית את גודל התמונות ל-512×512 פיקסלים.
  • שומר על שקיפות בתמונות PNG.
  • מדבקות WebP מונפשות נתמכות, אבל חייבות לעמוד בדרישות WhatsApp:
    • בדיוק 512×512 פיקסלים.
    • פחות מ-500 KB.
    • אורך של לא יותר מ-10 שניות.
    • אם מדבקה מונפשת לא עומדת בדרישות האלה, שנו את גודלה לפני ההעלאה בכלי כמו ezgif.com.

• דחיסת תמונות לפני שליחה.

• דחיסת סרטונים לפני שליחה.

• התאמה של שם מערכת ההפעלה שמוצג כשם המכשיר המקושר ב-WhatsApp:

  • --os=Chrome או --os=MyApplication

• Basic Auth עם כמה פרטי גישה:

  • --basic-auth=kemal:secret,toni:password,userName:secretPassword
  • צורה קצרה: -b=kemal:secret,toni:password,userName:secretPassword

• תמיכה בפריסה תחת נתיב משנה:

  • --base-path="/gowa" מאפשר פריסה תחת נתיב כמו /gowa.

• פורט שניתן להתאמה ומצב ניפוי שגיאות:

  • --port 8000
  • --debug true

• תשובות אוטומטיות להודעות נכנסות:

  • --autoreply="Don't reply to this message"

• סימון אוטומטי של הודעות נכנסות כנקראו:

  • --auto-mark-read=true

• הורדה אוטומטית של מדיה מהודעות נכנסות:

  • --auto-download-media=false מבטל הורדות מדיה אוטומטיות (ברירת מחדל: true).
  • ראו אחסון מדיה וניקוי למיקומי אחסון ולפקודות שמירה ידנית.

• התעלמות מהורדת מדיה של סטטוס:

  • --ignore-status-media=true מבטל הורדת מדיה של סטטוס (ברירת מחדל: false).

• דחייה אוטומטית של שיחות נכנסות:

  • --auto-reject-call=true או WHATSAPP_AUTO_REJECT_CALL=true (ראו מטען Webhook לאירועי שיחה).

• נוכחות ניתנת להגדרה בעת החיבור:

  • --presence-on-connect=unavailable או WHATSAPP_PRESENCE_ON_CONNECT=unavailable
  • available: סימון החשבון כמקוון (מדכא התראות בטלפון).
  • unavailable: רישום שם ה-push בלי מעבר למצב מקוון (ברירת מחדל, שומר על התראות הטלפון).
  • none: דילוג על נוכחות לגמרי (שם ה-push לא נרשם, ולכן אנשי קשר עשויים לראות - כשם).

• פעימת נוכחות יומית:

  • --presence-pulse-enabled=true או WHATSAPP_PRESENCE_PULSE_ENABLED=true (ברירת מחדל: true).
  • --presence-pulse-interval=24h שולט באיזו תדירות כל מכשיר מחובר מקבל פעימה.
  • --presence-pulse-duration=5m שולט כמה זמן החשבון נשאר available לפני החזרה ל-unavailable.

• Webhooks להודעות שהתקבלו ולאירועים אחרים:

  • --webhook="http://yourwebhook.site/handler"
  • צורה קצרה: -w="http://yourwebhook.site/handler"
  • ראו תיעוד מטען Webhook לפרטים.

• Webhooks לכל מכשיר: לכל מכשיר יכולה להיות כתובת webhook ומסנני אירועים משלו.

  • הגדרה דרך API: PATCH /devices/:device_id/webhook עם {"webhook_url": "https://device-webhook.site/handler"}.
  • קבלה דרך API: GET /devices/:device_id/webhook.
  • כשלמכשיר יש webhook מותאם, אירועים של המכשיר נשלחים לכתובת הייחודית למכשיר.
  • כשלא מוגדר webhook למכשיר, האירועים חוזרים ל-webhook הגלובלי (--webhook).
  • הגדירו את webhook_url למחרוזת ריקה עם PATCH כדי לנקות אותו ולהשתמש ב-webhook הגלובלי.
  • הגדירו WHATSAPP_WEBHOOK_DEVICE_MERGE_GLOBAL=true (או --webhook-device-merge-global=true) כדי ש-webhook של מכשיר יהיה תוספת במקום החלפה: כתובות --webhook הגלובליות עדיין מקבלות את אירועי המכשיר (חתומים בסוד הגלובלי, מסוננים לפי WHATSAPP_WEBHOOK_EVENTS), בעוד כתובת המכשיר שומרת על הסוד ועל מסנן האירועים שלה.

• חתימות webhook: בקשות webhook כוללות חתימת HMAC-SHA-256 בכותרת X-Hub-Signature-256. הגדירו מפתח פרטי עם --webhook-secret או WHATSAPP_WEBHOOK_SECRET. ברירת המחדל הישנה שפורסמה, secret, לא בשימוש. אם לא מוגדר סוד, התהליך יוצר מפתח אקראי ורושם אזהרה. המפתח הזה משתנה בהפעלה מחדש, ולכן מקלטים לא צריכים להסתמך עליו.

  צרו מפתח יציב פעם אחת, למשל עם openssl rand -hex 32, והגדירו אותו עם:

  • --webhook-secret="<generated key>"

• תיעוד מטען webhook: לסכמות מפורטות, ליישום אבטחה ולדוגמאות אינטגרציה, ראו תיעוד מטען Webhook.

• סינון אירועי webhook: סננו אילו אירועים מועברים ל-webhook שלכם עם:

  • --webhook-events="message,message.ack" (רשימה מופרדת בפסיקים), או
  • WHATSAPP_WEBHOOK_EVENTS=message,message.ack.

  אירועי Webhook זמינים:

אם ההגדרה הזו ריקה, כל האירועים מועברים.

• סינון JID ב-webhook

  אפשר לדלג על אירועים של צ'אטים או שולחים מסוימים (למשל, להשתיק את כל הקבוצות) לפני שהם מועברים:

  • --webhook-ignore-jids="@g.us,[email protected]" (רשימה מופרדת בפסיקים), או
  • [email protected].
  • תומך בתווי הכל @g.us / @s.whatsapp.net / @lid (התאמה למרחב כתובות שלם) וב-JID מדויקים.
  • זה מסנן לפי שיחה או שולח, והוא עצמאי מ---webhook-events, שמסנן לפי סוג אירוע. לאינטגרציית Chatwoot יש הגדרה נפרדת CHATWOOT_IGNORE_JIDS.

• הגדרת TLS ל-webhook

  אם נתקלים בשגיאות אימות אישור TLS בשימוש ב-webhooks (למשל עם מנהרות Cloudflare או עם אישורים בחתימה עצמית):

  העתק

  tls: failed to verify certificate: x509: certificate signed by unknown authority

  אפשר לבטל אימות אישור TLS עם:

  • --webhook-insecure-skip-verify=true, או
  • WHATSAPP_WEBHOOK_INSECURE_SKIP_VERIFY=true.

  אזהרת אבטחה: האפשרות הזו מבטלת אימות אישור TLS, ויש להשתמש בה רק ב:

  • סביבות פיתוח או בדיקה.
  • רשתות פנימיות עם אישורים בחתימה עצמית.

  מנהרת Cloudflare לא הופכת חיבור TLS יוצא לא מאומת לבטוח. לסביבות ייצור, השתמשו באישור TLS תקף (למשל מ-Let's Encrypt) במקום לבטל את האימות.

#הגדרות

כדי לאחסן הפעלות ומפתחות של WhatsApp ב-PostgreSQL מנוהל, עקבו אחרי מדריך ההגדרה של Neon.

ההגדרות מאותחלות מדגלים, ואחר כך מוחלים רוב הגדרות הסביבה. ערך סביבה שהוגדר יכול לכן לדרוס את הדגל התואם. הקובץ .env ממלא רק משתנים שעדיין לא הוגדרו בסביבת התהליך.

דגלים מפורשים גוברים בהגדרות MCP OAuth, ב---allow-unauthenticated, ב---trusted-origins, ב---chatwoot-webhook-allow-unsigned וב- --webhook-all-device-receipts. הגדירו כל אפשרות במקום אחד כדי להימנע מערכים סותרים. לדוגמה, WHATSAPP_WEBHOOK_INSECURE_SKIP_VERIFY=true דורס את --webhook-insecure-skip-verify=false.

#משתני סביבה

כדי להשתמש במשתני סביבה:

1. משורש המאגר, העתיקו את קובץ הדוגמה: cp src/.env.example src/.env.
2. עדכנו את הערכים ב-src/.env לפי הצורך.
3. לחלופין, הגדירו את אותם משתנים בסביבת התהליך.

#משתני סביבה זמינים

תיעוד:

• לסכמות מפורטות של מטען webhook, למימוש האבטחה ולדוגמאות שילוב, ראו תיעוד מטען Webhook.
• למדריך המקיף לשילוב Chatwoot, ראו תיעוד שילוב Chatwoot.
• לפרטי פריסה ואבטחה של OAuth, ראו MCP OAuth.

הריצו ./whatsapp --help כדי לראות את כל דגלי שורת הפקודה.

#דרישות

#דרישות מערכת

• Go 1.26.0 ואילך (בעת בנייה ממקור)
• FFmpeg (לעיבוד מדיה)

#פלטפורמות נתמכות

• Linux (x86_64, ARM64)
• macOS (Intel, Apple Silicon)
• Windows (x86_64, מומלץ WSL)

#תלויות (בלי Docker)

• macOS:
  • brew install ffmpeg webp
  • export CGO_CFLAGS_ALLOW="-Xpreprocessor"
• Linux:
  • sudo apt update
  • sudo apt install ffmpeg webp
• Windows (מומלץ WSL, ראו התקנת WSL):
  • התקינו FFmpeg.
  • התקינו libwebp, ואז חלצו אותו והוסיפו את ספריית bin שלו ל-PATH.

הערה: חבילת webp מספקת את הכלים cwebp (מקודד), dwebp (מפענח) ו-webpmux (מחלץ פריימים). FFmpeg נדרש לעיבוד מדיה. כלי libwebp (webpmux + dwebp) משמשים לתמיכה במדבקות WebP מונפשות.

#איך להשתמש

#בסיסי

1. שכפל את המאגר: git clone https://github.com/aldinokemal/go-whatsapp-web-multidevice.
2. פתח את התיקייה המשוכפלת בטרמינל.
3. הרץ cd src.
4. הרץ go run . rest.
5. פתח את http://localhost:3000.

#Docker

Docker מונע את הצורך להתקין את Go, FFmpeg ו-libwebp ישירות על המארח.

1. שכפל את המאגר: git clone https://github.com/aldinokemal/go-whatsapp-web-multidevice.
2. פתח את התיקייה המשוכפלת בטרמינל.
3. העתק את קובץ הסביבה: cp src/.env.example src/.env.
4. הרץ docker compose up -d --build.
5. פתח את http://localhost:3000.

#בניית קובץ בינארי משלך

1. שכפל את המאגר: git clone https://github.com/aldinokemal/go-whatsapp-web-multidevice.
2. פתח את התיקייה המשוכפלת בטרמינל.
3. הרץ cd src.
4. בנה את הקובץ הבינארי:
   • Linux ו-macOS: go build -o whatsapp
   • Windows (שורת פקודה או PowerShell): go build -o whatsapp.exe
5. הפעל את השרת:
   • Linux ו-macOS: ./whatsapp rest
   • Windows: .\whatsapp.exe rest
6. פתח את http://localhost:3000 בדפדפן.

הרץ ./whatsapp --help (או .\whatsapp.exe --help ב-Windows) כדי לראות את כל הדגלים. הרץ ./whatsapp version כדי להדפיס רק את מספר הגרסה (לדוגמה, 9.6.0).

#קומפילציה צולבת ל-Raspberry Pi (ARM)

כדי לבנות עבור Raspberry Pi או מכשיר ARM אחר בלי שרשרת כלים של C (CGO), השתמש בתג הבנייה purego. זה בוחר מימוש SQLite ב-Go טהור.

1. שכפל את המאגר: git clone https://github.com/aldinokemal/go-whatsapp-web-multidevice.

2. פתח את התיקייה המשוכפלת בטרמינל.

3. הרץ cd src.

4. בנייה עבור Raspberry Pi Zero / 1 (ARMv6):

   העתק

   CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=6 go build -tags purego -o whatsapp-armv6

5. בנייה עבור Raspberry Pi 2 / 3 / 4 (ARMv7 32-bit):

   העתק

   CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=7 go build -tags purego -o whatsapp-armv7

6. העבר את הקובץ הבינארי ל-Pi שלך, תן לו הרשאת הרצה (chmod +x), והרץ אותו:

   • אם בנית ARMv6: ./whatsapp-armv6 rest
   • אם בנית ARMv7: ./whatsapp-armv7 rest

#שרת MCP (Model Context Protocol)

MCP אינו מצב או תהליך נפרד, הוא מוגש על ידי שרת ה-REST עצמו. בכל פעם ש-./whatsapp rest רץ, נקודת הקצה של MCP זמינה ב-http://<host>:<port><base-path>/mcp (ברירת המחדל http://localhost:3000/mcp) באמצעות תעבורת HTTP ניתנת להזרמה. השבת אותו עם MCP_ENABLED=false או --mcp-enabled=false (ברירת מחדל: מופעל).

#כלי MCP זמינים

יש שבעה כלים מאוחדים. סוכנים בוחרים התנהגות דרך ארגומנט type/action במקום כלי אחד לכל פעולה:

whatsapp_send מקבל גם את scheduled_at, timezone, recurrence, weekdays, day_of_month, end_at ו-occurrence_limit כדי לתזמן את ההודעה במקום לשלוח אותה עכשיו. נהל את התוצאה עם whatsapp_schedule.

#בחירת מכשיר

בפריסות מרובות מכשירים, הכותרת X-Device-Id בחיבור לקוח ה-MCP בוחרת את המכשיר שמשמש בכל קריאת כלי באותו חיבור. אם היא מושמטת, מתבצעת חזרה למכשיר ברירת המחדל, בדיוק כמו ב-REST. כל קריאה בודדת יכולה לעקוף זאת עם ארגומנט device_id אופציונלי.

#הגדרת MCP

כוון את לקוח ה-MCP שלך לנקודת הקצה /mcp. הוא יורש את ה-Basic Auth של שרת ה-REST, ולכן כלול את אותה כותרת Authorization שבה משתמשות קריאות ה-REST שלך:

{
  "mcpServers": {
    "whatsapp": {
      "url": "http://localhost:3000/mcp",
      "headers": {
        "Authorization": "Basic dXNlcjpzZWNyZXQ=",
        "X-Device-Id": "628123456789"
      }
    }
  }
}

headers אופציונלי: כלול את Authorization רק כאשר Basic Auth מוגדר, ואת X-Device-Id רק עבור הגדרות מרובות מכשירים.

#OAuth עבור לקוחות MCP מרוחקים

OAuth 2.1 זמין ללקוחות מרוחקים שאינם יכולים לצרף כותרת Basic Auth. הוא מושבת כברירת מחדל. הגדרה מינימלית היא:

APP_BASIC_AUTH=admin:replace-with-a-strong-password
MCP_ENABLED=true
MCP_OAUTH_ENABLED=true
MCP_OAUTH_ISSUER_URL=https://gowa.example.com

כאשר OAuth מופעל, /mcp מקבל או אסימון Bearer או את אישורי Basic Auth המוגדרים. OAuth אינו מאמת נתיבי REST או ממשק משתמש. ראה MCP OAuth להגדרת לקוח, דרישות לפרוקסי הפוך, התנהגות של תת-נתיב ומודל האבטחה.

#מעבר ממצב MCP עצמאי

• ./whatsapp mcp → ./whatsapp rest (MCP כלול כעת באופן אוטומטי).
• http://localhost:8080/sse → http://localhost:3000/mcp.
• 40 כלים מפורטים → 5 כלים מאוחדים (סוכנים בוחרים פעולות דרך השדה type/action).

#שרת REST לייצור (Docker)

באמצעות Docker Hub:

docker volume create whatsapp-storages
docker volume create whatsapp-statics
docker run --detach \
  --publish 3000:3000 \
  --name whatsapp \
  --restart always \
  --volume whatsapp-storages:/app/storages \
  --volume whatsapp-statics:/app/statics \
  aldinokemal2104/go-whatsapp-web-multidevice \
  rest --autoreply="Don't reply to this message, please"

באמצעות GitHub Container Registry:

docker volume create whatsapp-storages
docker volume create whatsapp-statics
docker run --detach \
  --publish 3000:3000 \
  --name whatsapp \
  --restart always \
  --volume whatsapp-storages:/app/storages \
  --volume whatsapp-statics:/app/statics \
  ghcr.io/aldinokemal/go-whatsapp-web-multidevice \
  rest --autoreply="Don't reply to this message, please"

#שרת REST לייצור (Docker Compose)

צור קובץ docker-compose.yml עם אחת מההגדרות הבאות.

באמצעות Docker Hub:

services:
  whatsapp:
    image: aldinokemal2104/go-whatsapp-web-multidevice
    container_name: whatsapp
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - whatsapp_storages:/app/storages
      - whatsapp_statics:/app/statics
    command:
      - rest
      - --basic-auth=admin:admin
      - --port=3000
      - --debug=true
      - --os=Chrome
      - --account-validation=false

volumes:
  whatsapp_storages:
  whatsapp_statics:

באמצעות GitHub Container Registry:

services:
  whatsapp:
    image: ghcr.io/aldinokemal/go-whatsapp-web-multidevice
    container_name: whatsapp
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - whatsapp_storages:/app/storages
      - whatsapp_statics:/app/statics
    command:
      - rest
      - --basic-auth=admin:admin
      - --port=3000
      - --debug=true
      - --os=Chrome
      - --account-validation=false

volumes:
  whatsapp_storages:
  whatsapp_statics:

באמצעות משתני סביבה עם Docker Hub:

services:
  whatsapp:
    image: aldinokemal2104/go-whatsapp-web-multidevice
    container_name: whatsapp
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - whatsapp_storages:/app/storages
      - whatsapp_statics:/app/statics
    environment:
      - APP_BASIC_AUTH=admin:admin
      - APP_PORT=3000
      - APP_DEBUG=true
      - APP_OS=Chrome
      - WHATSAPP_ACCOUNT_VALIDATION=false

volumes:
  whatsapp_storages:
  whatsapp_statics:

באמצעות משתני סביבה עם GitHub Container Registry:

services:
  whatsapp:
    image: ghcr.io/aldinokemal/go-whatsapp-web-multidevice
    container_name: whatsapp
    restart: always
    ports:
      - "3000:3000"
    volumes:
      - whatsapp_storages:/app/storages
      - whatsapp_statics:/app/statics
    environment:
      - APP_BASIC_AUTH=admin:admin
      - APP_PORT=3000
      - APP_DEBUG=true
      - APP_OS=Chrome
      - WHATSAPP_ACCOUNT_VALIDATION=false

volumes:
  whatsapp_storages:
  whatsapp_statics:

הפעל את המחסנית שנבחרה עם docker compose up -d.

#שרת לייצור (קובץ בינארי)

הורד קובץ בינארי מדף הגרסאות, ואז הרץ אותו עם פקודת המשנה rest.

אפשר גם לעשות fork או לשנות את קוד המקור.

#ה-API הנוכחי

#API של MCP (Model Context Protocol)

• מוגש ב-/mcp על ידי שרת ה-REST באמצעות HTTP ניתן להזרמה בכל פעם ש-MCP_ENABLED הוא true. כאשר APP_BASE_PATH מוגדר, הנתיב הוא <base-path>/mcp.
• הכלים הזמינים מפורטים בסעיף "כלי MCP זמינים" למעלה.
• תואם לכלי AI ולסוכנים שתומכים ב-MCP.

#API של HTTP REST

• בדוק את docs/openapi.yaml למפרטי API מפורטים.
• השתמש ב-Swagger Editor כדי להציג את ה-API.
• צור לקוחות HTTP באמצעות openapi-generator.

✅ = זמין. * = יש מגבלות ידועות. ראה את ההערות למטה.

הערות:

• *List My Groups: מחזיר לכל היותר 500 קבוצות בגלל מגבלה של פרוטוקול וואטסאפ. השרתים של וואטסאפ, לא ה-API הזה, אוכפים את המגבלה. ראה את קוד המקור של whatsmeow לפרטים.
• /health ציבורי ותמיד רשום בנתיב השורש, גם כאשר APP_BASE_PATH מוגדר.
• נתיבי Chatwoot נרשמים רק כאשר CHATWOOT_ENABLED=true.

#ממשק משתמש

#ממשק MCP

• הגדרת MCP (נבדק ב-Cursor)
• בדיקת MCP
• הגדרת MCP מוצלחת

#לוח בקרה באינטרנט (gowa-ui)

לוח הבקרה נמצא במאגר משלו: aldinokemal/gowa-ui. כל מהדורה של gowa-ui מפרסמת קובץ gowa-ui.html עצמאי אחד. השרת מוריד את המהדורה האחרונה בעת ההפעלה (ובכל APP_UI_UPDATE_INTERVAL, שברירת המחדל שלו היא 3h), מאמת את תקציר ה-SHA-256 שלה, שומר אותה במטמון תחת storages/ui/, ומגיש אותה ב-/ מאחורי Basic Auth.

מודל האמון: תקציר המהדורה מוכיח שההורדה תואמת את מה ש-GitHub מפרסם, ולא את זהות מי שפרסם אותה. מפעילים שמבצעים ביקורת על build מסוים יכולים לנעוץ אותו עם APP_UI_ASSET_SHA256 (כל מהדורה כוללת נכס .sha256. זו ההגדרה היחידה שנועצת build מדויק), להפנות את APP_UI_REPO למזלג שבשליטתם (המעדכן עדיין עוקב אחרי המהדורה האחרונה של המאגר הזה), או לאכלס מראש את המטמון ולהשבית את העדכון האוטומטי לגמרי.

שרתים מבודדים מהרשת: מקמו קובץ gowa-ui.html שהורד בנתיב storages/ui/index.html והגדירו APP_UI_AUTO_UPDATE=false. אפשר גם לארח את לוח הבקרה בעצמכם בכל מקום סטטי ולהפנות אותו לכתובת ה-URL של השרת הזה (ראו את ה-README של gowa-ui).

#הערה ל-macOS

אם מופיעה השגיאה invalid flag in pkg-config --cflags: -Xpreprocessor, הריצו:

export CGO_CFLAGS_ALLOW="-Xpreprocessor"

#חשוב

• הפרויקט הזה אינו רשמי ואינו מסונף ל-WhatsApp.
• השתמשו בפלטפורמת WhatsApp Business הרשמית כאשר אתם זקוקים לשילוב נתמך ברמת ייצור.