NODAPI

Ações na mensagem e Buscar

Solicitar histórico sob demanda de um chat

POST/message/history-sync

Autenticação: envie a chave da conexão no header token ou em Authorization: Bearer.

Solicita ao WhatsApp um sync sob demanda de mensagens antigas de um chat ou tenta recuperar uma mensagem exata já conhecida localmente.

Modos suportados:

  • history (padrão): busca histórico para trás a partir de uma mensagem âncora
  • exact: tenta recarregar a mensagem exata informada em messageid

Regras:

  • envie number
  • mode é opcional; quando omitido, assume history
  • em mode=history, count é opcional e limitado a 100
  • em mode=history, messageid é opcional; quando informado, a API usa essa mensagem como referência para buscar mensagens mais antigas do chat
  • em mode=exact, messageid é obrigatório e count não é necessário

Observação:

  • Importante: a recuperação pode só acontecer depois de abrir o WhatsApp no celular ou deixá-lo ativo em segundo plano
  • em mode=history, messageid define a mensagem de referência para carregar histórico anterior
  • em mode=history, esse campo não serve para buscar essa mensagem específica
  • em mode=history, o histórico é buscado para trás a partir da mensagem de referência informada
  • se você quiser recuperar apenas uma mensagem específica X via histórico, informe como messageid a mensagem logo depois de X e use count=1
  • se messageid não for informado em mode=history, a API usa a mensagem mais antiga conhecida localmente desse chat como referência para buscar histórico anterior
  • em mode=exact, a API tenta um rerequest da mensagem exata informada em messageid
  • `mode=exact` está em teste e funciona melhor quando a mensagem já existe no histórico local da instância
  • as mensagens retornam depois via webhook/SSE em eventos do tipo history e também ficam disponíveis em /message/find

Corpo da requisição (JSON)

CampoTipoDescrição
modestring

Define o comportamento da operação.

  • history: busca mensagens mais antigas a partir de uma âncora
  • exact: tenta recuperar a mensagem exata informada em messageid

Exemplo: history

messageidstring

Em mode=history, ID da mensagem de referência usada para buscar mensagens mais antigas do chat. Em mode=exact, ID exato da mensagem que deve ser recarregada.

Exemplo: 3EB01234567890ABCDEF

number*string

JID completo do chat. Mantido obrigatório em todos os modos para simplificar o contrato público e restringir a busca ao chat esperado.

Exemplo: [email protected]

countinteger

Quantidade desejada de mensagens no sync em mode=history. Em mode=exact, este campo é ignorado.

Exemplo: 20

* obrigatório

Exemplos de corpo

Recuperar a mensagem exata informada

{
  "number": "[email protected]",
  "mode": "exact",
  "messageid": "3EB01234567890ABCDEF"
}

Buscar histórico anterior a uma mensagem de referência

{
  "number": "[email protected]",
  "mode": "history",
  "messageid": "3EB01234567890ABCDEF",
  "count": 20
}

Recuperar apenas a mensagem imediatamente anterior à referência

{
  "number": "[email protected]",
  "mode": "history",
  "messageid": "3EB0MENSAGEM_LOGO_APOS_X",
  "count": 1
}

Reutilizar âncora local já persistida

{
  "number": "[email protected]",
  "mode": "history",
  "count": 50
}

Respostas

  • 200Solicitação enviada com sucesso
  • 400Payload inválido, modo inválido ou âncora insuficiente
  • 404Mensagem exata não encontrada no histórico local
  • 500Erro interno ao solicitar o history sync ou o rerequest exato

Experimente

Atenção: a chamada é real. Ela roda na sua conexão e pode enviar mensagem de verdade. A chave fica só nesta tela e some ao sair dela; nunca é guardada.

Cole a chave gerada no painel.