OnZap
Criar conta

Histórico

Importar o histórico de conversas do número para os webhooks (evento `history.sync`).

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Importar o histórico de conversas

POST/v1/instances/{instanceId}/history/import
API OnZap

Lê o histórico que o número baixou ao conectar (até 180 dias) e entrega cada conversa aos webhooks no evento history.sync, o mesmo formato da API oficial: lotes de até 100 mensagens, do mais antigo para o mais novo, com source: history. Roda em segundo plano, com calma, e responde 202 na hora; acompanhe em GET /history/import.

Precisa de um webhook ativo assinando history.sync (ou todos os eventos). Uma importação por vez em cada instância. Na API oficial não há o que importar: a Meta envia o histórico sozinha ao conectar o número (coexistência).

Corpo (JSON)

daysintegeropcional
Quantos dias para trás (padrão 30).
includeGroupsbooleanopcional
Incluir as conversas em grupo (padrão false).
includeMediabooleanopcional
Trazer as mídias com link assinado (padrão false; deixa a importação bem mais lenta).
Requisição
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/history/import" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "days": 30
  }'
Resposta

Importação iniciada

{
  "chatsDone": 0,
  "chatsTotal": 0,
  "createdAt": "2026-09-30T14:05:00Z",
  "days": 0,
  "error": "número sem WhatsApp",
  "events": 0,
  "finishedAt": "2026-09-30T14:05:00Z",
  "id": "3EB0C0A1B2C3D4E5F6",
  "includeGroups": false,
  "includeMedia": false,
  "messages": 0,
  "since": "2026-09-30T14:05:00Z",
  "startedAt": "2026-09-30T14:05:00Z",
  "status": "ok"
}

Acompanhar a importação

GET/v1/instances/{instanceId}/history/import
API OnZap

A importação mais recente da instância: situação, conversas processadas e eventos entregues.

Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/history/import" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Importação

{
  "chatsDone": 0,
  "chatsTotal": 0,
  "createdAt": "2026-09-30T14:05:00Z",
  "days": 0,
  "error": "número sem WhatsApp",
  "events": 0,
  "finishedAt": "2026-09-30T14:05:00Z",
  "id": "3EB0C0A1B2C3D4E5F6",
  "includeGroups": false,
  "includeMedia": false,
  "messages": 0,
  "since": "2026-09-30T14:05:00Z",
  "startedAt": "2026-09-30T14:05:00Z",
  "status": "ok"
}

Cancelar a importação

DELETE/v1/instances/{instanceId}/history/import
API OnZap

Interrompe a importação em andamento. O que já foi entregue fica.

Requisição
curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/history/import" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Importação cancelada

{
  "chatsDone": 0,
  "chatsTotal": 0,
  "createdAt": "2026-09-30T14:05:00Z",
  "days": 0,
  "error": "número sem WhatsApp",
  "events": 0,
  "finishedAt": "2026-09-30T14:05:00Z",
  "id": "3EB0C0A1B2C3D4E5F6",
  "includeGroups": false,
  "includeMedia": false,
  "messages": 0,
  "since": "2026-09-30T14:05:00Z",
  "startedAt": "2026-09-30T14:05:00Z",
  "status": "ok"
}