メディアAPI
メディアファイルの取得API
メディアライブラリ内の1つのファイルの詳細とダウンロードURLを、IDを指定して取得します。送信前にファイルがまだ存在するかを確認するのに利用できます。
https://wbiztool.com/api/v1/media/{media_id}/リクエストボディ: クエリ文字列、またはPOSTの場合はJSONボディ
パスの{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は、GETリクエストのクエリ文字列で送信するか、POSTリクエストのJSONボディで送信します。client_idがクエリ文字列にある場合、JSONボディは無視されます。
パス
media_idinteger必須メディアファイルのIDです。整数である必要があり、それ以外の値ではJSONではなくHTMLの「page not found」レスポンスが返ります。
認証
client_idinteger必須設定 → APIキーに表示されるAPIクライアントIDです。
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 | メディアファイルのID。 |
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 | 小数点以下1桁の読みやすいサイズ(例:242.5 KB)。 |
data.mime_type | string | MIMEタイプ(例:application/pdf)。 |
data.is_image | boolean | file_typeがimageの場合はtrue。 |
data.file_extension | string | original_file_nameの小文字の拡張子(ドットなし)。 |
data.created_at | string | アップロード日時。+00:00オフセット付きのUTCのISO 8601形式です。 |
data.modified_at | string | ファイルのレコードが最後に変更された日時(同じ形式)。 |
data.uploaded_by | string or null | ファイルをアップロードしたチームメンバーのログインユーザー名(通常はメールアドレス)。 |
エラー#
エラーの場合もHTTP 200が返り、statusは0になります。
{ "status": 0, "message": "Media file not found" }
例外が1つあります。media_idが数値でない場合、URLがどのエンドポイントにも一致しないため、JSONではなくHTMLの404ページが返ります。
| メッセージ | 対処方法 |
|---|---|
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 | このIDのファイルがAPIキーのワークスペースに存在しないか、削除されています。 |
Error retrieving media file: … | サーバー側で問題が発生しました。もう一度お試しください。 |
送信前にファイルを確認する#
IDでファイルを取得し、ファイルが存在しなくなっていれば処理を止めてから、そのfile_urlを送信します。画像の場合はmsg_type 1でimg_urlとして、それ以外の場合はmsg_type 2でfile_urlとして送信します。
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からはまだダウンロードできる場合もあります。URLを取得して確認するのではなく、このエンドポイントで確認してください。アップロードしたファイルのURLは公開されており、無期限に有効です。メディアのアップロード → アップロードして送信するをご覧ください。 - ファイルはワークスペースごとに管理されます。あるワークスペースでアップロードしたファイルは、別のワークスペースのAPIキーでは読み取れません。
- IDがわからない場合:メディア一覧で名前から検索してください。
