Pular para o conteúdo principal
POST
/
api
/
chat
/
history
/
:instance
Histórico do chat
curl --request POST \
  --url https://api.example.com/api/chat/history/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "count": 123,
  "from": "<string>",
  "to": "<string>"
}
'

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

Retorna as mensagens armazenadas de um chat específico, ordenadas das mais novas para as mais antigas. Você pode controlar a quantidade com count e filtrar por janela de datas com from/to.
Não há cursor de paginação. Para paginar, ajuste os filtros from e to. O campo hasMore é uma heurística: vale true quando o número de mensagens retornadas == count (provavelmente há mais).

Exemplos

Últimas 50

Forma mínima: passa apenas number e usa o count padrão de 50 mensagens, retornando as mais recentes do chat ordenadas da mais nova para a mais antiga.
curl -X POST "https://ryzeapi.cloud/api/chat/history/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999"}'

Com janela de datas

Recupera até 200 mensagens enviadas entre 20 e 28 de abril de 2026 (from/to em ISO 8601). Útil para extrair o histórico de um intervalo específico ou paginar usando o to como cursor.
curl -X POST "https://ryzeapi.cloud/api/chat/history/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "count":  200,
    "from":   "2026-04-20T00:00:00Z",
    "to":     "2026-04-28T23:59:59Z"
  }'

Grupo

Mesma lógica, mas com number apontando para um JID de grupo (@g.us) e count de 100. Cada item em messages[] traz senderJid preenchido com o autor da mensagem dentro do grupo.
curl -X POST "https://ryzeapi.cloud/api/chat/history/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "120363123456789@g.us",
    "count":  100
  }'

Resposta de sucesso

messages traz as mensagens em ordem cronológica decrescente (mais recente primeiro). count indica quantos itens vieram nesta página e hasMore é true quando você atingiu exatamente o count solicitado, sinalizando que pode haver mais mensagens, paginar usando o from/to da última mensagem retornada. chat_jid é o JID resolvido do chat solicitado.
200 OK
{
  "success": true,
  "message": "Retrieved 2 messages from chat history",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "messages": [
    {
      "id": "3EB08FCF27E532F1B0F5",
      "fromMe": true,
      "timestamp": "2026-04-28T14:30:00Z",
      "content": "Ola",
      "type": "text",
      "chatJid": "5511999999999@s.whatsapp.net",
      "senderJid": ""
    },
    {
      "id": "3EB08FCF27E532F1B0F4",
      "fromMe": false,
      "timestamp": "2026-04-28T14:29:55Z",
      "content": "Bom dia!",
      "type": "text",
      "chatJid": "5511999999999@s.whatsapp.net",
      "senderJid": "5511999999999@s.whatsapp.net"
    }
  ],
  "count": 2,
  "hasMore": false
}

Parâmetros de rota

instance
string
obrigatório
Nome da instância.

Headers

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

Request body

number
string
obrigatório
Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.
count
int
padrão:"50"
Quantidade máxima de mensagens a retornar. Sem limite superior interno.
from
string
ISO 8601 / RFC3339. Mensagens a partir desta data (inclusivo).
to
string
ISO 8601 / RFC3339. Mensagens até esta data (inclusivo).

Notas e gotchas

  • Funciona mesmo com a instância desconectada, lê direto do banco da ingestão.
  • Para paginar com segurança, use to = timestamp da mensagem mais antiga já recebida na chamada anterior.
  • hasMore=true não garante 100% que existam mais mensagens, é apenas uma heurística baseada no count solicitado.

Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required
400Invalid request body: <...>JSON malformado.
400Number is required
400invalid 'from' date format. Use ISO 8601 format (e.g., '2026-02-16T18:32:39Z')
400invalid 'to' date format. Use ISO 8601 format (e.g., '2026-02-16T18:32:39Z')
401Invalid token
404Instance not found
Erro 400
{
  "success": false,
  "error": { "message": "Number is required" }
}

Relacionados

Buscar mensagem

Recuperar uma mensagem específica do histórico.

Mídia em base64

Baixar uma mídia citada no histórico.