API de mídia
API para obter arquivo de mídia
Obtenha os detalhes e a URL de download de um arquivo da sua biblioteca de mídia pelo ID. Use-a para verificar se um arquivo ainda existe antes de enviá-lo.
https://wbiztool.com/api/v1/media/{media_id}/Corpo: Query string, ou corpo JSON com POST
Substitua {media_id} no caminho pelo id retornado por Upload de mídia ou Listar mídia, por exemplo /api/v1/media/5122/.
Exemplo rápido#
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');
}Substitua 12345 e YOUR_API_KEY pelos seus próprios valores. Veja em Autenticação onde encontrá-los.
Parâmetros da requisição#
Envie client_id e api_key na query string de uma requisição GET, ou como corpo JSON em uma requisição POST. Se client_id estiver na query string, o corpo JSON é ignorado.
Caminho
media_idintegerobrigatórioID do arquivo de mídia. Precisa ser um número inteiro; qualquer outro valor retorna uma resposta HTML de «página não encontrada» em vez de JSON.
Autenticação
client_idintegerobrigatórioSeu ID do Cliente da API, em Configurações → Chaves API.
api_keystringobrigatórioSua chave de API, na mesma página.
Resposta#
{
"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]"
}
}
| Campo | Tipo | Descrição |
|---|---|---|
status | integer | 1 em caso de sucesso, 0 se a requisição falhou. |
message | string | Media file retrieved successfully; caso contrário, o erro. |
data.id | integer | ID do arquivo de mídia. |
data.file_name | string | Nome com o qual o arquivo é armazenado. |
data.original_file_name | string | O nome que o arquivo tinha quando foi enviado. |
data.file_url | string | URL de download direto. Use-a como img_url ou file_url ao enviar. |
data.file_type | string | image ou file. |
data.file_size | integer | Tamanho em bytes. |
data.file_size_display | string | Tamanho legível com uma casa decimal, por exemplo 242.5 KB. |
data.mime_type | string | Tipo MIME, por exemplo application/pdf. |
data.is_image | boolean | true quando file_type é image. |
data.file_extension | string | Extensão de original_file_name em minúsculas, sem o ponto. |
data.created_at | string | Horário do upload, em ISO 8601, em UTC, com deslocamento +00:00. |
data.modified_at | string | Quando o registro do arquivo foi alterado pela última vez, no mesmo formato. |
data.uploaded_by | string ou null | Nome de usuário de login (geralmente o endereço de e-mail) do membro da equipe que enviou o arquivo. |
Erros#
Os erros também retornam HTTP 200, com status igual a 0:
{ "status": 0, "message": "Media file not found" }
Uma exceção: se media_id não for um número, a URL não corresponde a nenhum endpoint e você recebe uma página HTML 404 em vez de JSON.
| Mensagem | Como corrigir |
|---|---|
client_id is required | Adicione client_id. |
api_key is required | Adicione api_key. |
client_id must be a valid integer | Envie client_id como número. |
Invalid API key | Verifique se a chave existe e não foi excluída nem desativada. |
Invalid client_id for this API key | A chave pertence a outro client_id. |
Media file not found | Não existe nenhum arquivo com este ID no espaço de trabalho da chave de API, ou ele foi excluído. |
Error retrieving media file: … | Algo deu errado do nosso lado. Tente novamente. |
Verificar um arquivo antes de enviá-lo#
Busque o arquivo pelo ID, pare se ele não existir mais e depois envie o file_url dele: como img_url com msg_type 1 para imagens, ou como file_url com msg_type 2 para todo o resto.
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());Arquivos que não são imagens, como .doc, .ppt, .csv, .zip, .wav e .mov, são entregues com .pdf adicionado ao nome, e imagens acima de 16 MB falham no envio. Veja Upload de mídia → Enviar o arquivo e mandar a mensagem.
Dicas#
- Arquivos excluídos retornam
Media file not found, mesmo que ofile_urldeles ainda possa ser baixado. Verifique com este endpoint em vez de acessar a URL. As URLs dos arquivos enviados são públicas e permanentes; veja Upload de mídia → Enviar o arquivo e mandar a mensagem. - Os arquivos são por espaço de trabalho. Um arquivo enviado em um espaço de trabalho não pode ser lido com uma chave de API de outro.
- Não sabe o ID? Pesquise pelo nome com Listar mídia.
