Pular para o conteúdo principal
GET
/
api
/
chat
/
base64
/
:instance
Mídia em base64
curl --request GET \
  --url https://api.example.com/api/chat/base64/:instance

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstanceRate-limit: Global (100/min) • Idempotente: sim

Descrição

Lê a mídia já armazenada localmente (após a ingestão) e devolve o conteúdo em base64. Funciona para imagens, vídeos, áudios, documentos e stickers.
Apenas mensagens cuja mídia já foi baixada e persistida pelo pipeline de ingestão retornam dados aqui. Caso a mídia ainda não exista no storage, a resposta é 404.

Exemplo

curl -X GET "https://ryzeapi.cloud/api/chat/base64/$Instance_Name?messageId=3EB08FCF27E532F1B0F5" \
  -H "token: $Token_Instance"

Resposta de sucesso

A resposta ecoa message_id, traz mime_type e media_type (categoria geral: image, video, audio, document, sticker) e devolve em base64 os bytes brutos da mídia já codificados, pronto para escrever em arquivo, fazer upload em outro lugar ou exibir inline. O payload pode ser grande para vídeos/áudios longos.
200 OK
{
  "success": true,
  "message": "Base64 recuperado com sucesso",
  "message_id": "3EB08FCF27E532F1B0F5",
  "mime_type": "image/jpeg",
  "media_type": "image",
  "base64": "iVBORw0KGgoAAAANSUhEUgAAAAEA..."
}

Parâmetros de rota

instance
string
obrigatório
Nome da instância.

Query params

messageId
string
obrigatório
ID da mensagem que contém a mídia.

Headers

NomeObrigatórioExemploDescrição
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required
400messageId query parameter is required
401Invalid token
404Instance not found
404Message not found or no media availableMídia ausente ou ainda não baixada.
503Instance is not connected to WhatsApp
Erro 404
{
  "success": false,
  "error": { "message": "Message not found or no media available" }
}

Relacionados

Buscar mensagem

Recuperar metadados antes de baixar.

Status de entrega

Conferir entrega/leitura.