Mídia em base64

GET

api

chat

base64

:instance

Mídia em base64

curl --request GET \
  --url https://api.example.com/api/chat/base64/:instance

Auth: TokenAccount ou TokenInstance • Rate-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"

await fetch(`https://ryzeapi.cloud/api/chat/base64/${process.env.Instance_Name}?messageId=3EB08FCF27E532F1B0F5`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/chat/base64/{os.environ['Instance_Name']}?messageId=3EB08FCF27E532F1B0F5",
    headers={"token": os.environ["Token_Instance"]}
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chat/base64/"+os.Getenv("Instance_Name")+"?messageId=3EB08FCF27E532F1B0F5", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Query params

string

obrigatório

ID da mensagem que contém a mídia.

Headers

Nome	Obrigatório	Exemplo	Descrição
`token`	sim (ou `Authorization`)	`a1b2c3d4-...`	TokenAccount ou TokenInstance.

Respostas de erro

HTTP	`error.message`	Quando ocorre
400	`Instance name is required`	,
400	`messageId query parameter is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
404	`Message not found or no media available`	Mídia ausente ou ainda não baixada.
503	`Instance is not connected to WhatsApp`	,

Erro 404

{
  "success": false,
  "error": { "message": "Message not found or no media available" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Mídia em base64

Descrição

Exemplo

Resposta de sucesso

Parâmetros de rota

Query params

Headers

Respostas de erro

Relacionados

Buscar mensagem

Status de entrega

​Descrição

​Exemplo

​Resposta de sucesso

​Parâmetros de rota

​Query params

​Headers

​Respostas de erro

​Relacionados

Buscar mensagem

Status de entrega

Descrição

Exemplo

Resposta de sucesso

Parâmetros de rota

Query params

Headers

Respostas de erro

Relacionados