# Baixar a mídia POST /messages/media Baixa o arquivo da mensagem (imagem, vídeo, áudio, documento ou figurinha) para o servidor da inbox e responde o link. Com `transcribe: true`, também transcreve o áudio. Uma mensagem pode ter mídia em mais de um lugar (o cabeçalho dos botões, os cartões do carrossel): escolha qual em `item`. Sem `item`, o link fica também na própria mensagem, no lugar da mídia (`url`), e volta na busca. Com `item`, o link vem só na resposta: a mensagem não o guarda, então guarde o link se for precisar dele depois. Com `item`, `transcribe`, `audio_format` e `quoted` não valem (são ignorados). ## Autenticação ```json [ { "token": [] } ] ``` ```json { "token": { "name": "token", "type": "apiKey", "in": "header" } } ``` ## Corpo da requisição ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "message_id": { "type": "string", "description": "A mensagem: o `id` dela." }, "item": { "type": "string", "pattern": "^(header|cards\\.[0-9]+)$", "description": "Qual mídia baixar quando a mensagem tem mais de uma: `header` (a do cabeçalho) ou `cards.N` (a do cartão N do carrossel, a partir de 0). Sem ele, a mídia principal. O link desse item vem só na resposta; `transcribe`, `audio_format` e `quoted` são ignorados." }, "base64": { "type": "boolean", "default": false, "description": "Inclui o arquivo em base64 na resposta. Evite: pesa na memória e na resposta." }, "audio_format": { "type": "string", "enum": [ "mp3", "ogg" ], "default": "mp3", "description": "Formato do áudio baixado: `mp3` ou `ogg` (o formato em que o WhatsApp manda)." }, "transcribe": { "type": "boolean", "default": false, "description": "Transcreve o áudio. Usa a chave da OpenAI configurada na IA da inbox, ou a de `openai_api_key`." }, "openai_api_key": { "type": "string", "description": "Chave da OpenAI só para esta transcrição." }, "quoted": { "type": "boolean", "default": false, "description": "Baixa a mídia da mensagem citada, não a da própria mensagem." } }, "required": [ "message_id" ] }, "example": { "message_id": "3EB0A1B2C3D4E5F60718", "transcribe": true } } } } ``` ## Respostas ```json { "200": { "description": "O arquivo.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "url", "mime_type" ], "properties": { "url": { "type": "string", "description": "Link do arquivo no servidor da inbox." }, "mime_type": { "type": "string", "description": "Tipo do arquivo." }, "base64": { "type": "string", "description": "O arquivo em base64 (só com `base64: true`)." }, "transcription": { "type": "string", "description": "O texto do áudio (só com `transcribe: true`)." } } }, "example": { "url": "https://api.exemplo.com/files/3EB0A1B2C3D4E5F60718.mp3", "mime_type": "audio/mpeg", "transcription": "Oi, queria saber do meu pedido." } } } }, "400": { "description": "A mensagem (ou a citada, com `quoted`) não tem mídia, ou não tem mídia no `item` pedido.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "no_media", "message": "A mensagem não tem arquivo." } } } }, "401": { "description": "Token inválido ou ausente.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "unauthorized", "message": "Token inválido." } } } }, "404": { "description": "Mensagem não encontrada, ou, com `quoted`, ela não cita outra mensagem.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "not_found", "message": "Mensagem não encontrada." } } } }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/Disconnected" } } ``` **Estado:** Disponível ## Compatibilidade de canais | Canal | Compatível | Observação | |---|---|---| | WhatsApp (Web) | Sim | | | WhatsApp (API oficial) | Sim | | | Instagram | Sim | | | Messenger | Sim | | | Telegram | Sim | | ## Eventos que esta rota gera O que chega no seu webhook (ou em `GET /events`) depois desta rota. ### [`message.updated`](/webhook/message.updated): `change: media_ready` (e `transcribed`, com `transcribe`) ```json { "id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H", "type": "message.updated", "created_at": "2026-10-17T12:00:00.000Z", "inbox": { "id": "r0269625d29bfbd", "name": "loja", "phone": "5511888888888", "channel": "whatsapp_web" }, "data": { "change": "media_ready", "message": { "id": "3EB05DCE1D4036FCE241C6", "chat_id": "5511999999999@s.whatsapp.net", "author": { "id": "5511888888888@s.whatsapp.net", "name": "Loja" }, "direction": "in", "sent_at": "2026-10-17T12:00:00.000Z", "category": "conversation", "type": "audio", "mime_type": "audio/ogg; codecs=opus", "duration_seconds": 7, "url": "https://api.exemplo.com/files/3EB0A1B2C3D4E5F60718.ogg", "track_source": "crm", "track_id": "42" }, "chat": { "id": "5511999999999@s.whatsapp.net", "lid": "123456789012345@lid", "type": "direct" } } } ``` ## Antes e depois (uazapi → Orkesio) Na uazapi: `POST /message/download`. - `id` → `message_id`. - `return_base64` → `base64`; `generate_mp3` → `audio_format` (`mp3` ou `ogg`); `download_quoted` → `quoted`; `openai_apikey` → `openai_api_key`; `return_link` saiu (o link vem sempre). - Resposta: `fileURL` → `url`, `mimetype` → `mime_type`, `base64Data` → `base64`. ## #/components/schemas/OrkesioError ```json { "type": "object", "properties": { "error": { "type": "string", "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP." }, "message": { "type": "string", "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`." }, "field": { "type": "string", "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)." } }, "required": [ "error", "message" ], "additionalProperties": true, "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)." } ``` ## #/components/responses/RateLimited ```json { "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.", "headers": { "Retry-After": { "description": "Segundos até poder chamar de novo.", "schema": { "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "rate_limited", "message": "Muitas requisições." } } } } ``` ## #/components/responses/InternalError ```json { "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "internal_error", "message": "Falha inesperada." } } } } ``` ## #/components/responses/Disconnected ```json { "description": "`disconnected`: a inbox está desconectada do WhatsApp (a api esperou a sessão e tentou reconectar). `unavailable`: o WhatsApp não respondeu agora; tente de novo.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "disconnected", "message": "Instância desconectada do WhatsApp." } } } } ``` ## Guias relacionados [Visão geral](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)