דלגו לתוכן
Wbiztool

API להודעות

ממשק API לשליחת הודעה לקבוצת WhatsApp

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

POSThttps://wbiztool.com/api/v1/send_msg/group/

גוף הבקשה: JSON, שדות טופס, או multipart/form-data בהעלאת קובץ

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

דוגמה מהירה#

curl -X POST https://wbiztool.com/api/v1/send_msg/group/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "group_name": "Sales Team Mumbai",
    "msg": "Reminder: *weekly review* starts at 4 PM today."
  }'

החליפו את 12345, YOUR_API_KEY ו-678 בערכים שלכם. בסעיף אימות מוסבר איפה למצוא אותם.

פרמטרי הבקשה#

אימות

client_idintegerחובה

מזהה הלקוח שלכם ל-API (API Client ID) מהדף Settings → API keys.

api_keystringחובה

מפתח ה-API שלכם מאותו דף.

whatsapp_clientintegerחובה אם לבעלים יש יותר ממספר מחובר אחד

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

קבוצה והודעה

group_namestringחובה

שם קבוצת ה-WhatsApp, בדיוק כפי שהוא מופיע ב-WhatsApp. שלחו אותו כמחרוזת. מספר JSON כמו 2024 מחזיר דף שגיאה ב-HTML ‏(HTTP 500). ראו איך מאתרים את הקבוצה.

msg_typeintegerאופציונלי

0 טקסט (ברירת מחדל), 1 תמונה, 2 קובץ או מסמך.

msgstringחובה כש-msg_type הוא 0

טקסט ההודעה. בתמונות ובקבצים זה הכיתוב, והוא יכול להיות ריק. עיצוב של WhatsApp עובד: *bold*, _italic_, ~strikethrough~. אפשר להשתמש גם בשם החלופי message.

תמונות וקבצים

img_urlstringחובה כש-msg_type הוא 1 ולא הועלה קובץ

כתובת URL ציבורית של התמונה, ב-http או ב-https.

file_urlstringחובה כש-msg_type הוא 2 ולא הועלה קובץ

כתובת URL ציבורית ב-http או ב-https שממנה אפשר להוריד את הקובץ ישירות.

filefileאופציונלי

העלו את התמונה או הקובץ במקום לתת כתובת URL. שלחו את הבקשה כ-multipart/form-data עם שדה בשם file.

file_namestringאופציונלי

שם הקובץ שהקבוצה רואה, למשל price-list.pdf. הסיומת שלו קובעת איך הקובץ נשלח, לכן הקפידו לכלול סיומת. הוא נשלח באותיות קטנות, תווים כמו & : ? * $ ; מוחלפים ב-_, והוא נחתך ל-150 תווים. אם לא תשלחו אותו, השם יילקח מכתובת ה-URL או מהקובץ שהועלה.

אפשרויות מסירה

expire_after_secondsintegerאופציונלי

סימון ההודעה כפגת תוקף (סטטוס 4) אם היא לא נשלחה בתוך מספר השניות הזה, למשל 3600 לשעה אחת. תהליך רקע עושה זאת לפחות 30 שניות אחרי המועד האחרון, לכן אל תסתמכו עליו למועדים קצרים מדקה.

webhookstringאופציונלי

כתובת URL שמקבלת בקשת POST כשההודעה נשלחת או נכשלת. התוכן זהה לזה של שליחת הודעה.

תמונות וקבצים כפופים לאותם כללים כמו בשליחת הודעה: כתובות URL מורדות ברגע שאתם קוראים ל-API (עד 100 MB). כשההודעה נשלחת, תמונות מעל 16 MB וסרטונים מעל 64 MB נכשלים, אודיו WAV ו-OGG לא נתמך, ולקבצים (msg_type 2) בלי סיומת נתמכת מתווספת הסיומת .pdf, כולל קבצים שהועלו. שמות קבצים נשלחים באותיות קטנות. הרשימה המלאה של הסיומות והשגיאות נמצאת בשליחת תמונות וקבצים.

כדי להעלות קובץ, השתמשו בדוגמאות ה-multipart שבשליחת הודעה, והחליפו את כתובת ה-URL ב-/api/v1/send_msg/group/ ואת phone/country_code ב-group_name.

תמונה מכתובת URL
curl -X POST https://wbiztool.com/api/v1/send_msg/group/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 1,
    "group_name": "Sales Team Mumbai",
    "img_url": "https://example.com/reports/weekly-sales.png",
    "msg": "This week'\''s sales summary"
  }'

איך מאתרים את הקבוצה#

מערכת Wbiztool לא בודקת את שם הקבוצה כשאתם קוראים ל-API. בזמן שליחת ההודעה, Wbiztool מחפשת את group_name בצ'אטים של ה-WhatsApp שלכם ופותחת את התוצאה הראשונה. לכן:

  • מספר ה-WhatsApp המחובר שלכם חייב להיות חבר בקבוצה.
  • השתמשו בשם המלא של הקבוצה בדיוק כפי ש-WhatsApp מציג אותו, כולל אימוג'י וסימני פיסוק. רווחים בתחילת השם ובסופו לא נלקחים בחשבון.
  • הקפידו שהשם יהיה ייחודי. שם קצר או חלקי עלול להתאים לצ'אט אחר שמופיע ראשון בחיפוש.
  • אם אין התאמה, אם רק מנהלים יכולים לשלוח הודעות בקבוצה והמספר שלכם אינו מנהל, או אם רק מנהלי הקהילה יכולים לפרסם, ההודעה נכשלת עם השגיאה Group not found.
  • אם המספר שלכם עזב את הקבוצה, ההודעה נכשלת עם השגיאה Group member blocked.

בעיות בקבוצה לא מופיעות בתגובת ה-API. השתמשו ב-webhook או ב-סטטוס הודעה כדי לגלות אם ההודעה נשלחה.

שימוש בלקוח הרשמי#

לקוח ה-Python קורא ל-endpoint הזה בשבילכם.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.send_message_to_group(
    group_name="Sales Team Mumbai",
    msg="Reminder: weekly review starts at 4 PM today.",
    whatsapp_client=678,
)
print(result)

שגיאות זורקות requests.HTTPError. קראו את הסיבה עם e.response.json()["message"].

תגובה#

בקשה מוצלחת מחזירה HTTP 200:

{
  "status": 1,
  "message": "Created",
  "msg_id": 9817263
}
שדהסוגתיאור
statusinteger1 אם ההודעה נכנסה לתור, 0 אם הבקשה נכשלה.
messagestringCreated בהצלחה, אחרת השגיאה.
msg_idintegerהמזהה של ההודעה שבתור. שמרו אותו כדי לבדוק את הסטטוס בהמשך. מופיע רק בהצלחה.

הערך "status": 1 אומר שההודעה נכנסה לתור, ולא שהיא הגיעה לקבוצה. השתמשו ב-webhook או ב-סטטוס הודעה כדי לוודא שהיא נשלחה.

שגיאות#

שגיאות מחזירות HTTP 400 עם status שמוגדר ל-0:

{ "status": 0, "message": "Group Name cant be null" }
הודעהאיך לתקן
Auth Error - Please send correct API key and Client idשלחו api_key שאינו ריק.
Invalid client id.שלחו את client_id כמספר.
Auth Error: invalid api keyודאו שהמפתח קיים, לא נמחק ושייך ל-client_id הזה.
Group Name cant be nullהוסיפו group_name.
Msg cant be nullהודעות טקסט (msg_type 0) דורשות msg.
Image Url Can't be nullעבור msg_type 1, שלחו img_url או העלו file.
File Url Can't be nullעבור msg_type 2, שלחו file_url או העלו file.
Invalid file url, Can't download / Invalid file urlכתובת ה-URL לא ציבורית, חרגה מזמן ההמתנה, או שהקובץ גדול מ-100 MB.
Invalid whatsapp client Noneהמזהה whatsapp_client הזה לא שייך לבעלים של סביבת העבודה. ראו את האזהרה למעלה.
Invalid whatsapp client id.שלחו whatsapp_client. הוא חובה, אלא אם לבעלים יש בדיוק מספר מחובר אחד.
Not enough creditsלא נותרו הודעות בחבילה שלכם.
Demo Account can not access apisהשתמשו בחשבון רגיל.
Account Disabledהחשבון שלכם מושבת. פנו לתמיכה.
Invalid JSON format: …גוף ה-JSON לא תקין, לרוב בגלל פסיק מיותר בסוף או ירידת שורה בתוך msg שלא עברה escape. השתמשו ב-\n לשורות חדשות.

טיפים#

  • בדקו את השם קודם: שלחו טקסט קצר לקבוצה ובדקו את סטטוס ההודעה לפני שאתם הופכים משהו לאוטומטי.
  • קבוצות ששמן שונה: אם מישהו משנה את שם הקבוצה ב-WhatsApp, עדכנו גם את group_name באינטגרציה שלכם.
  • סוגי הודעות: הערכים התקינים היחידים של msg_type הם 0, 1 ו-2. כל ערך שאינו מספר שלם מחזיר דף שגיאה ב-HTML ‏(HTTP 500) במקום JSON.
  • כמה קבוצות בבת אחת: שליחה למספרים מרובים מקבלת שמות קבוצות לצד מספרי טלפון באותה בקשה.