OnZap
Criar conta

Fila

Fila de envio da instância: intervalo entre mensagens, "digitando…" e espera por reconexão.

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

Listar a fila

GET/v1/instances/{instanceId}/queue
API OnZapAPI oficial

Por padrão, só o que ainda vai ser enviado, na ordem de envio. Com status, o histórico (7 dias), do mais novo para o mais antigo.

Parâmetros de query

statusstringopcional
pending (padrão): aguardando envio; all: tudo; ou um status final.
limitintegeropcional
Itens por página (padrão 50, máximo 100).
cursorstringopcional
Continuação: o nextCursor da página anterior.
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Página da fila

{
  "data": [
    {
      "attempts": 1,
      "chatId": "5511999999999@c.us",
      "createdAt": "2026-09-30T14:05:00Z",
      "delayMs": 3000,
      "error": "número sem WhatsApp",
      "expiresAt": "2026-09-30T14:05:00Z",
      "finishedAt": "2026-09-30T14:05:00Z",
      "id": "qm_01jabcdefghjkmnpqrstvwxyz",
      "messageId": "false_5511999999999@c.us_3EB0C0A1B2C3D4E5F6",
      "position": 1,
      "route": "POST /messages/text",
      "status": "queued",
      "typingMs": 2000
    }
  ],
  "nextCursor": "eyJvZmZzZXQiOjUwfQ",
  "paused": false,
  "pending": 0
}

Cancelar todos os envios pendentes

DELETE/v1/instances/{instanceId}/queue
API OnZapAPI oficial

Cada envio cancelado dispara queue.failed com status cancelled.

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

Envios cancelados

{
  "cancelled": 0
}

Configurações da fila

GET/v1/instances/{instanceId}/queue/settings
API OnZapAPI oficial
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue/settings" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Configurações

{
  "delayMax": 0,
  "delayMin": 0,
  "mode": "direct",
  "paused": false,
  "pending": 0,
  "ttlHours": 0
}

Alterar configurações da fila

PATCH/v1/instances/{instanceId}/queue/settings
API OnZapAPI oficial

Só os campos enviados mudam. delayMin/delayMax (0–60 s) valem para envios sem delayMessage; ttlHours (1–168) é quanto um envio espera a reconexão.

Corpo (JSON)

delayMaxintegeropcional
delayMinintegeropcional
modestringopcional
direct ou queue.
ttlHoursintegeropcional
Requisição
curl -X PATCH "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue/settings" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
Resposta

Configurações atualizadas

{
  "delayMax": 0,
  "delayMin": 0,
  "mode": "direct",
  "paused": false,
  "pending": 0,
  "ttlHours": 0
}

Pausar a fila

POST/v1/instances/{instanceId}/queue/pause
API OnZapAPI oficial

Nada sai da fila até POST /queue/resume. Novos envios continuam entrando.

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

Configurações

{
  "delayMax": 0,
  "delayMin": 0,
  "mode": "direct",
  "paused": false,
  "pending": 0,
  "ttlHours": 0
}

Retomar a fila

POST/v1/instances/{instanceId}/queue/resume
API OnZapAPI oficial
Requisição
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue/resume" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Configurações

{
  "delayMax": 0,
  "delayMin": 0,
  "mode": "direct",
  "paused": false,
  "pending": 0,
  "ttlHours": 0
}

Consultar um envio da fila

GET/v1/instances/{instanceId}/queue/{queueId}
API OnZapAPI oficial

Parâmetros do caminho

queueIdstringobrigatório
ID do envio na fila (campo id da resposta 202).
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue/01jabcdefghjkmnpqrstvwxyz0" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Envio

{
  "attempts": 1,
  "chatId": "5511999999999@c.us",
  "createdAt": "2026-09-30T14:05:00Z",
  "delayMs": 3000,
  "error": "número sem WhatsApp",
  "expiresAt": "2026-09-30T14:05:00Z",
  "finishedAt": "2026-09-30T14:05:00Z",
  "id": "qm_01jabcdefghjkmnpqrstvwxyz",
  "messageId": "false_5511999999999@c.us_3EB0C0A1B2C3D4E5F6",
  "position": 1,
  "route": "POST /messages/text",
  "status": "queued",
  "typingMs": 2000
}

Cancelar um envio da fila

DELETE/v1/instances/{instanceId}/queue/{queueId}
API OnZapAPI oficial

Só envios ainda aguardando (queued).

Parâmetros do caminho

queueIdstringobrigatório
ID do envio na fila (campo id da resposta 202).
Requisição
curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/queue/01jabcdefghjkmnpqrstvwxyz0" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Envio cancelado

{
  "attempts": 1,
  "chatId": "5511999999999@c.us",
  "createdAt": "2026-09-30T14:05:00Z",
  "delayMs": 3000,
  "error": "número sem WhatsApp",
  "expiresAt": "2026-09-30T14:05:00Z",
  "finishedAt": "2026-09-30T14:05:00Z",
  "id": "qm_01jabcdefghjkmnpqrstvwxyz",
  "messageId": "false_5511999999999@c.us_3EB0C0A1B2C3D4E5F6",
  "position": 1,
  "route": "POST /messages/text",
  "status": "queued",
  "typingMs": 2000
}