דלגו לתוכן
Wbiztool

API למדיה

ממשק API לקבלת קובץ מדיה

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

GEThttps://wbiztool.com/api/v1/media/{media_id}/

גוף הבקשה: query string, או גוף JSON עם POST

החליפו את {media_id} בנתיב ב-id שהוחזר מ-העלאת מדיה או מ-רשימת מדיה, למשל /api/v1/media/5122/.

דוגמה מהירה#

curl -G https://wbiztool.com/api/v1/media/5122/ \
  --data-urlencode client_id=12345 \
  --data-urlencode api_key=YOUR_API_KEY

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

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

שלחו את client_id ואת api_key ב-query string של בקשת GET, או כגוף JSON בבקשת POST. אם client_id נמצא ב-query string, המערכת מתעלמת מגוף ה-JSON.

נתיב

media_idintegerחובה

המזהה של קובץ המדיה. הוא חייב להיות מספר שלם; כל ערך אחר מחזיר תגובת HTML מסוג „page not found“ (הדף לא נמצא) במקום JSON.

אימות

client_idintegerחובה

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

api_keystringחובה

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

תגובה#

{
  "status": 1,
  "message": "Media file retrieved successfully",
  "data": {
    "id": 5122,
    "file_name": "media_12345_17895804001234.pdf",
    "original_file_name": "invoice-4821.pdf",
    "file_url": "https://wbiztool-static.s3.ap-southeast-1.amazonaws.com/media/org_12345/media_12345_17895804001234.pdf",
    "file_type": "file",
    "file_size": 248312,
    "file_size_display": "242.5 KB",
    "mime_type": "application/pdf",
    "is_image": false,
    "file_extension": "pdf",
    "created_at": "2026-09-16T10:20:31.512934+00:00",
    "modified_at": "2026-09-16T10:20:31.512961+00:00",
    "uploaded_by": "[email protected]"
  }
}
שדהסוגתיאור
statusinteger1 בהצלחה, 0 אם הבקשה נכשלה.
messagestringMedia file retrieved successfully, אחרת השגיאה.
data.idintegerהמזהה של קובץ המדיה.
data.file_namestringהשם שתחתיו הקובץ נשמר.
data.original_file_namestringהשם שהיה לקובץ כשהוא הועלה.
data.file_urlstringכתובת URL להורדה ישירה. השתמשו בה בתור img_url או file_url בזמן השליחה.
data.file_typestringimage או file.
data.file_sizeintegerהגודל בבייטים.
data.file_size_displaystringגודל קריא עם ספרה אחת אחרי הנקודה, למשל 242.5 KB.
data.mime_typestringסוג MIME, למשל application/pdf.
data.is_imagebooleantrue כש-file_type הוא image.
data.file_extensionstringהסיומת של original_file_name באותיות קטנות, בלי הנקודה.
data.created_atstringזמן ההעלאה, בפורמט ISO 8601 לפי UTC עם הפרש +00:00.
data.modified_atstringמתי רשומת הקובץ שונתה לאחרונה, באותו פורמט.
data.uploaded_bystring or nullשם המשתמש להתחברות (בדרך כלל כתובת האימייל) של חבר הצוות שהעלה את הקובץ.

שגיאות#

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

{ "status": 0, "message": "Media file not found" }

חריג אחד: אם media_id אינו מספר, כתובת ה-URL לא תואמת לאף endpoint ותקבלו דף HTML של שגיאת 404 במקום JSON.

הודעהאיך לתקן
client_id is requiredהוסיפו client_id.
api_key is requiredהוסיפו api_key.
client_id must be a valid integerשלחו את client_id כמספר.
Invalid API keyודאו שהמפתח קיים ולא נמחק או הושבת.
Invalid client_id for this API keyהמפתח שייך ל-client_id אחר.
Media file not foundאין קובץ עם המזהה הזה בסביבת העבודה של מפתח ה-API, או שהוא נמחק.
Error retrieving media file: …משהו השתבש אצלנו. נסו שוב.

בדיקת קובץ לפני שליחה#

שלפו את הקובץ לפי המזהה, עצרו אם הוא כבר לא קיים, ואז שלחו את ה-file_url שלו: כ-img_url עם msg_type 1 לתמונות, או כ-file_url עם msg_type 2 לכל השאר.

שליחת קובץ מדיה שמור
import requests

BASE = "https://wbiztool.com/api/v1"
AUTH = {"client_id": 12345, "api_key": "YOUR_API_KEY"}

result = requests.get(f"{BASE}/media/5122/", params=AUTH, timeout=60).json()
if result["status"] != 1:
    raise SystemExit("Can't use this file: " + result["message"])

media = result["data"]
message = {
    **AUTH,
    "whatsapp_client": 678,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Here is the document you asked for.",
}
if media["is_image"]:
    message.update(msg_type=1, img_url=media["file_url"])
else:
    message.update(msg_type=2, file_url=media["file_url"], file_name=media["original_file_name"])

print(requests.post(f"{BASE}/send_msg/", json=message, timeout=60).json())

קבצים שאינם תמונות, כמו .doc, ‏.ppt, ‏.csv, ‏.zip, ‏.wav ו-.mov, נמסרים כשלשם שלהם מתווסף .pdf, ותמונות מעל 16 MB נכשלות בשליחה. ראו העלאת מדיה ← העלאה ושליחה.

טיפים#

  • קבצים שנמחקו מחזירים Media file not found, גם אם עדיין אפשר להוריד אותם דרך ה-file_url שלהם. בדקו באמצעות ה-endpoint הזה, ולא על ידי בקשה לכתובת ה-URL. כתובות ה-URL של קבצים שהועלו הן ציבוריות וקבועות; ראו העלאת מדיה ← העלאה ושליחה.
  • הקבצים שייכים לסביבת עבודה. אי אפשר לקרוא קובץ שהועלה בסביבת עבודה אחת עם מפתח API מסביבת עבודה אחרת.
  • לא יודעים את המזהה? חפשו לפי שם באמצעות רשימת מדיה.