API למדיה
ממשק API לקבלת קובץ מדיה
קבלו את הפרטים ואת כתובת ה-URL להורדה של קובץ אחד בספריית המדיה שלכם לפי המזהה שלו. השתמשו בו כדי לוודא שקובץ עדיין קיים לפני שאתם שולחים אותו.
https://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_KEYimport requests
media_id = 5122
response = requests.get(
f"https://wbiztool.com/api/v1/media/{media_id}/",
params={"client_id": 12345, "api_key": "YOUR_API_KEY"},
timeout=60,
)
result = response.json()
if result["status"] == 1:
media = result["data"]
print(media["original_file_name"], media["file_size_display"], media["file_url"])
else:
print("Failed:", result["message"])// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const mediaId = 5122;
const url = new URL(`https://wbiztool.com/api/v1/media/${mediaId}/`);
url.search = new URLSearchParams({ client_id: "12345", api_key: "YOUR_API_KEY" });
const response = await fetch(url);
const result = await response.json();
if (result.status === 1) {
const media = result.data;
console.log(media.original_file_name, media.file_size_display, media.file_url);
} else {
console.error("Failed:", result.message);
}<?php
$mediaId = 5122;
$query = http_build_query(['client_id' => 12345, 'api_key' => 'YOUR_API_KEY']);
$ch = curl_init("https://wbiztool.com/api/v1/media/$mediaId/?" . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
echo $result['data']['original_file_name'] . ': ' . $result['data']['file_url'];
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}החליפו את 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]"
}
}
| שדה | סוג | תיאור |
|---|---|---|
status | integer | 1 בהצלחה, 0 אם הבקשה נכשלה. |
message | string | Media file retrieved successfully, אחרת השגיאה. |
data.id | integer | המזהה של קובץ המדיה. |
data.file_name | string | השם שתחתיו הקובץ נשמר. |
data.original_file_name | string | השם שהיה לקובץ כשהוא הועלה. |
data.file_url | string | כתובת URL להורדה ישירה. השתמשו בה בתור img_url או file_url בזמן השליחה. |
data.file_type | string | image או file. |
data.file_size | integer | הגודל בבייטים. |
data.file_size_display | string | גודל קריא עם ספרה אחת אחרי הנקודה, למשל 242.5 KB. |
data.mime_type | string | סוג MIME, למשל application/pdf. |
data.is_image | boolean | true כש-file_type הוא image. |
data.file_extension | string | הסיומת של original_file_name באותיות קטנות, בלי הנקודה. |
data.created_at | string | זמן ההעלאה, בפורמט ISO 8601 לפי UTC עם הפרש +00:00. |
data.modified_at | string | מתי רשומת הקובץ שונתה לאחרונה, באותו פורמט. |
data.uploaded_by | string 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())// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const BASE = "https://wbiztool.com/api/v1";
const auth = { client_id: 12345, api_key: "YOUR_API_KEY" };
const url = new URL(`${BASE}/media/5122/`);
url.search = new URLSearchParams(auth);
const result = await (await fetch(url)).json();
if (result.status !== 1) throw new Error(`Can't use this file: ${result.message}`);
const media = result.data;
const message = {
...auth,
whatsapp_client: 678,
country_code: "91",
phone: "9876543210",
msg: "Here is the document you asked for.",
...(media.is_image
? { msg_type: 1, img_url: media.file_url }
: { msg_type: 2, file_url: media.file_url, file_name: media.original_file_name }),
};
const sent = await fetch(`${BASE}/send_msg/`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(message),
});
console.log(await sent.json());קבצים שאינם תמונות, כמו .doc, .ppt, .csv, .zip, .wav ו-.mov, נמסרים כשלשם שלהם מתווסף .pdf, ותמונות מעל 16 MB נכשלות בשליחה. ראו העלאת מדיה ← העלאה ושליחה.
טיפים#
- קבצים שנמחקו מחזירים
Media file not found, גם אם עדיין אפשר להוריד אותם דרך ה-file_urlשלהם. בדקו באמצעות ה-endpoint הזה, ולא על ידי בקשה לכתובת ה-URL. כתובות ה-URL של קבצים שהועלו הן ציבוריות וקבועות; ראו העלאת מדיה ← העלאה ושליחה. - הקבצים שייכים לסביבת עבודה. אי אפשר לקרוא קובץ שהועלה בסביבת עבודה אחת עם מפתח API מסביבת עבודה אחרת.
- לא יודעים את המזהה? חפשו לפי שם באמצעות רשימת מדיה.
