Langkau ke kandungan
WbizTool

API v2 (beta)

Media

Direktori media menyimpan fail ruang kerja anda: senarai harga, menu, risalah, foto produk. Muat naik fail sekali, kemudian hantarnya sekerap yang anda mahu dengan "media": {"media_id": …} dalam mesej atau peringatan. Ia ialah direktori yang sama seperti halaman Direktori media dalam papan pemuka, jadi fail yang dimuat naik di sana turut disenaraikan di sini.

OperasiEndpointSkop
Muat naik failPOST /api/v2/mediamedia
Senaraikan failGET /api/v2/mediamedia
Dapatkan failGET /api/v2/media/{id}media
Padam failDELETE /api/v2/media/{id}media

Muat naik fail#

POSThttps://wbiztool.com/api/v2/media

Body: multipart/form-data

Hantar satu fail bagi setiap permintaan sebagai multipart/form-data, dalam medan file. Ini satu-satunya endpoint v2 yang tidak menerima JSON. Responsnya ialah 201 dengan objek Media.

  • Sehingga 64 MB bagi setiap fail.
  • Jenis: jenis ditentukan oleh sambungan di hujung nama fail, jadi kekalkannya.
JenisSambungan
Imej.jpg, .jpeg, .jpe, .png, .gif, .webp, .bmp
Dokumen.pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .csv, .txt
Audio.mp3, .m4a, .wav, .ogg, .oga, .aac
Video.mp4, .mov, .avi
Arkib.zip, .rar
  • Storan: semua fail ruang kerja bersama-sama boleh menggunakan ruang sebanyak yang dibenarkan oleh pelannya, dari 250 MB hingga 10 GB (lihat Storan mengikut pelan). Fail yang tidak muat ditolak dengan storage_full.
  • Fail imej (type image) dihantar sebagai imej secara lalai; yang lain sebagai fail.
  • Hantar Idempotency-Key supaya cubaan semula selepas tamat masa tidak menyimpan fail dua kali.
curl -X POST https://wbiztool.com/api/v2/media \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Idempotency-Key: price-list-2026-10" \
  -F "file=@./price list.pdf"

Respons (201):

{
  "id": 3301,
  "name": "price list.pdf",
  "type": "file",
  "mime_type": "application/pdf",
  "size": 182344,
  "url": "https://media.wbiztool.com/media/org_5012/media_5012_17608123450000_0.pdf",
  "created_at": "2026-10-18T10:31:40.120Z"
}

Kemudian hantarnya:

{
  "to": { "phone": "+919876543210" },
  "text": "Here is our new price list.",
  "media": { "media_id": 3301 }
}

Penerima melihat nama yang digunakan semasa ia dimuat naik (price list.pdf); tetapkan media.file_name dalam mesej untuk memaparkan nama lain.

Ralat semasa memuat naik#

HTTPKodBila
400validation_failedTiada fail dalam medan file, atau lebih daripada satu
413file_too_largeFail melebihi 64 MB
415unsupported_file_typeSambungannya bukan salah satu jenis di atas
415unsupported_content_typePermintaan bukan multipart/form-data (contohnya JSON)
422storage_fullFail tidak muat dalam storan pelan; used dan limit menyatakan jumlahnya, dalam bait
502upload_failedFail tidak dapat disimpan. Cuba lagi (dengan Idempotency-Key yang sama)

Senaraikan fail#

GEThttps://wbiztool.com/api/v2/media

Fail ruang kerja, yang terbaharu dahulu, dalam halaman (limit 1 hingga 100, lalai 25, dan cursor).

curl "https://wbiztool.com/api/v2/media?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Responsnya ialah {"data": [Media, …], "next_cursor": "…" or null}.

Dapatkan fail#

GEThttps://wbiztool.com/api/v2/media/{id}
curl https://wbiztool.com/api/v2/media/3301 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Fail yang tidak wujud atau telah dipadam menjawab 404 media_not_found.

Padam fail#

DELETEhttps://wbiztool.com/api/v2/media/{id}

Memadam fail daripada Direktori media dan daripada storan, jadi url-nya berhenti berfungsi. Mesej yang telah dihantar mengekalkan salinannya pada telefon penerima.

Ia ditolak selagi masih ada sesuatu yang akan menghantar fail itu: mesej yang menunggu untuk dihantar (termasuk mesej kempen), peringatan yang aktif, atau pencetus Google Sheets yang aktif. Responsnya kemudian ialah 409 media_in_use, dan count menyatakan berapa banyak. Batalkan atau ubah semua itu dahulu, atau tunggu sehingga mesej telah dihantar.

curl -X DELETE https://wbiztool.com/api/v2/media/3301 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{ "id": 3301, "deleted": true }
HTTPKodBila
404media_not_foundTiada fail sedemikian
409media_in_useMesej yang menunggu, peringatan yang aktif atau pencetus Google Sheets masih menggunakannya

Objek Media#

MedanJenisPenerangan
idintegerID fail: media_id untuk menghantarnya.
namestringNama yang digunakan semasa ia dimuat naik.
typestringimage bagi fail imej, file bagi yang lain.
mime_typestringSeperti application/pdf atau image/jpeg.
sizeintegerSaiz dalam bait.
urlstringPautan awam ke fail. Sesiapa yang mempunyai pautan boleh membukanya, jadi jangan muat naik fail yang mesti kekal peribadi.
created_atstringBila ia dimuat naik.

Berkaitan#