Zum Inhalt springen
WbizTool

Media-API

Mediendatei abrufen (API)

Rufen Sie die Details und die Download-URL einer Datei in Ihrem Medienverzeichnis anhand ihrer ID ab. Nutzen Sie die API, um vor dem Senden zu prüfen, ob eine Datei noch existiert.

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

Body: Query-String oder JSON-Body mit POST

Ersetzen Sie {media_id} im Pfad durch die id, die Medien hochladen oder Medien auflisten zurückgegeben hat, zum Beispiel /api/v1/media/5122/.

Kurzes Beispiel#

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

Ersetzen Sie 12345 und YOUR_API_KEY durch Ihre eigenen Werte. Wo Sie diese finden, steht unter Authentifizierung.

Request-Parameter#

Senden Sie client_id und api_key im Query-String eines GET-Requests oder als JSON-Body in einem POST-Request. Steht client_id im Query-String, wird der JSON-Body ignoriert.

Pfad

media_idintegererforderlich

ID der Mediendatei. Sie muss eine ganze Zahl sein; alles andere liefert statt JSON eine HTML-Antwort „page not found“.

Authentifizierung

client_idintegererforderlich

Ihre API-Client-ID aus Einstellungen → API-Schlüssel.

api_keystringerforderlich

Ihr API-Schlüssel von derselben Seite.

Antwort#

{
  "status": 1,
  "message": "Media file retrieved successfully",
  "data": {
    "id": 5122,
    "file_name": "media_12345_17895804001234_3f9a1c7e.pdf",
    "original_file_name": "invoice-4821.pdf",
    "file_url": "https://wbiztool-static.s3.ap-southeast-1.amazonaws.com/media/org_12345/media_12345_17895804001234_3f9a1c7e.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]"
  }
}
FeldTypBeschreibung
statusinteger1 bei Erfolg, 0, wenn der Request fehlgeschlagen ist.
messagestringMedia file retrieved successfully, andernfalls der Fehler.
data.idintegerID der Mediendatei.
data.file_namestringName, unter dem die Datei gespeichert ist.
data.original_file_namestringDer Name, den die Datei beim Hochladen hatte.
data.file_urlstringDirekte Download-URL. Verwenden Sie sie beim Senden als img_url oder file_url. Sie ist öffentlich und läuft nicht ab. Sie kann auf media.wbiztool.com (unserem CDN) oder auf wbiztool-static.s3.ap-southeast-1.amazonaws.com liegen; beide liefern dieselbe Datei. Speichern Sie sie also so, wie sie ist, und bauen Sie diese URLs nicht selbst zusammen.
data.file_typestringimage oder file.
data.file_sizeintegerGröße in Bytes.
data.file_size_displaystringLesbare Größe mit einer Nachkommastelle, zum Beispiel 242.5 KB.
data.mime_typestringMIME-Typ, zum Beispiel application/pdf.
data.is_imagebooleantrue, wenn file_type den Wert image hat.
data.file_extensionstringEndung von original_file_name in Kleinbuchstaben, ohne Punkt.
data.created_atstringUpload-Zeitpunkt, ISO 8601 in UTC mit der Abweichung +00:00.
data.modified_atstringWann der Datensatz der Datei zuletzt geändert wurde, im selben Format.
data.uploaded_bystring or nullAnmeldename (meist die E-Mail-Adresse) des Teammitglieds, das die Datei hochgeladen hat.

Fehler#

Auch Fehler geben HTTP 200 zurück, mit status gleich 0:

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

Eine Ausnahme: Wenn media_id keine Zahl ist, passt die URL zu keinem Endpoint, und Sie erhalten statt JSON eine HTML-Seite mit 404.

MeldungLösung
client_id is requiredFügen Sie client_id hinzu.
api_key is requiredFügen Sie api_key hinzu.
client_id must be a valid integerSenden Sie client_id als Zahl.
Invalid API keyPrüfen Sie, ob der Schlüssel existiert und nicht gelöscht oder deaktiviert wurde.
Invalid client_id for this API keyDer Schlüssel gehört zu einer anderen client_id.
Media file not foundIm Arbeitsbereich des API-Schlüssels existiert keine Datei mit dieser ID, oder sie wurde gelöscht.
Error retrieving media file: …Auf unserer Seite ist etwas schiefgelaufen. Versuchen Sie es erneut.

Datei vor dem Senden prüfen#

Rufen Sie die Datei über ihre ID ab, brechen Sie ab, wenn sie nicht mehr existiert, und senden Sie dann ihre file_url: bei Bildern als img_url mit msg_type 1, bei allem anderen als file_url mit msg_type 2.

Gespeicherte Mediendatei senden
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())

Mit msg_type 2 gesendete Dateien behalten ihre Endung, zum Beispiel .doc, .csv oder .zip, und Bilder über 16 MB können nicht als Bild (msg_type 1) gesendet werden. Siehe Medien hochladen → Hochladen und senden.

Tipps#

  • Gelöschte Dateien liefern Media file not found, und ihre file_url funktioniert nicht mehr. Bis eine Datei gelöscht wird, kann jeder mit ihrer URL sie herunterladen; siehe Medien hochladen → Hochladen und senden.
  • Dateien gehören zu einem Arbeitsbereich. Eine in einem Arbeitsbereich hochgeladene Datei kann nicht mit einem API-Schlüssel aus einem anderen gelesen werden.
  • ID unbekannt? Suchen Sie mit Medien auflisten nach dem Namen.