תחילת העבודה עם ה-API של WbizTool

ה-REST API של WbizTool מאפשר לתוכנה שלכם לשלוח הודעות WhatsApp ממספר ה-WhatsApp המחובר שלכם. השתמשו בו כדי לשלוח עדכוני הזמנות, תזכורות והתראות מהאפליקציה, מה-CRM, מהאתר או מכלי האוטומציה שלכם.

הדף הזה מסביר מה נדרש בכל בקשה. כדי לשלוח את ההודעה הראשונה, עברו אל שליחת הודעה.

כתובת בסיס#

כל ה-endpoints נמצאים תחת:

https://wbiztool.com/api/v1/

רוב ה-endpoints מקבלים בקשות POST. אפשר לשלוח את גוף הבקשה כ-JSON (application/json) או כשדות טופס (application/x-www-form-urlencoded). להעלאת קובץ, השתמשו ב-multipart/form-data. כמה endpoints לקריאת נתונים משתמשים ב-GET; בדף של כל endpoint מופיעה השיטה שלו.

לפני שמתחילים#

1. צרו חשבון בכתובת wbiztool.com/signup. חשבונות חדשים כוללים 50 הודעות בחינם.
2. חברו מספר WhatsApp. פתחו את מספרי WhatsApp, לחצו על הוספת מספר וסרקו את קוד ה-QR מאפליקציית WhatsApp בטלפון.
3. צרו מפתח API. עברו אל Settings → API keys (הגדרות ← מפתחות API). רק הבעלים של סביבת עבודה יכולים ליצור מפתחות. בכל סביבת עבודה אפשר ליצור עד 10 מפתחות.

אימות#

שלחו את מפתח ה-API בכותרת Authorization: Bearer בכל בקשה (מומלץ). המפתח מציין את סביבת העבודה שלו, ולכן אז אין צורך ב-client_id. פרטי התחברות בגוף (client_id ו-api_key כ-JSON או כשדות טופס) ממשיכים לעבוד בכל ה-endpoints. אם המפתח נשלח גם בכותרת וגם בגוף, נעשה שימוש במפתח שבכותרת אם הוא תקף. ראו שליחת המפתח בכותרת.

Authorization: Bearer YOUR_API_KEY

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

אם מפתח דלף, מחקו אותו בדף מפתחות ה-API. מפתחות שנמחקו מפסיקים לעבוד מיד.

הבקשה הראשונה שלכם#

הבקשה הזו שולחת הודעת טקסט מהמספר המחובר שלכם. החליפו את המזהים, המפתח ומספר הטלפון בערכים שלכם.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

תגובה עם "status": 1 ועם msg_id אומרת שההודעה נכנסה לתור. בדף שליחת הודעה מוסבר כל פרמטר, ויש בו גרסאות ב-Python, ‏Node.js ו-PHP.

תגובות ושגיאות#

כל תגובה היא אובייקט JSON עם שדה status (למעט בדיקת התקינות /api/v1/status/, שמחזירה "status": 200):

• הערך "status": 1 אומר שהבקשה הצליחה.
• הערך "status": 0 אומר שהיא נכשלה. השדה message מסביר למה.

{ "status": 0, "message": "Auth Error: invalid api key" }

שגיאות אימות נפוצות:

מחזור החיים של הודעה#

הודעות שאתם שולחים דרך ה-API נכנסות קודם לתור, ואז נשלחות ממספר ה-WhatsApp שלכם. לכל הודעה יש אחד מהסטטוסים הבאים:

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

כדי לעקוב אחרי הודעה, שמרו את ה-msg_id מהתגובה, ואז העבירו כתובת webhook בזמן השליחה או קראו ל-סטטוס הודעה.

ספריות לקוח רשמיות#

ספריות עטיפה ל-Python ול-Node.js מטפלות בשבילכם באימות ובהעלאת קבצים. הן עדיין לא מכסות כל endpoint בצורה נכונה, לכן בדקו את הדף של כל endpoint לפני שאתם מסתמכים על מתודה של הלקוח.

pip install wbiztool-client

npm install wbiztool-client

• ל-Python: wbiztool-client ב-PyPI
• ל-Node.js: wbiztool-client ב-npm

מעדיפים הגדרה ללא קוד? ראו אפליקציות ואינטגרציות עבור Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify ו-WordPress.

עיון בתיעוד#

• מדריכי המוצר: שימוש במרכז הבקרה של WbizTool, מחיבור מספר ועד קמפיינים, תזכורות ו-Unibox.
• API להודעות: שליחה, תזמון, ביטול ומעקב אחרי הודעות.
• API לחשבונות WhatsApp: חיבור מספרים ובדיקת הסטטוס שלהם.
• API לאימות מספרים: בדיקה המונית אילו מספרים נמצאים ב-WhatsApp.
• API לתזכורות: יצירה, הצגה וביטול של תזכורות חוזרות.
• API למדיה: העלאת קבצים, ואז הצגה או שליפה שלהם.
• אינטגרציות: הגדרות ללא קוד ותוספים.