Fila de mensagens

Envios com intervalo, "digitando…" e espera enquanto o celular está desconectado.

A fila da instância manda uma mensagem por vez, com intervalo entre elas e "digitando…" antes de cada uma. Enquanto o número estiver desconectado, ela segura os envios e continua quando ele voltar, até o prazo configurado. Serve para disparos em sequência e para parecer mais natural a quem recebe.

Quando um envio vai para a fila

ComoEfeito
delayMessage no corpo (0–60 s)Espera esse tempo antes de enviar esta mensagem
delayTyping no corpo (0–15 s)Mostra "digitando…" por esse tempo antes de enviar
Header X-Queue: trueForça a fila neste envio
Header X-Queue: falseEnvia na hora (não combina com delayMessage nem delayTyping)
Nada dissoVale o modo da instância: direct (na hora) ou queue (sempre fila)
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/messages/text" \
  -H "X-Instance-Token: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"chatId": "5511999999999", "text": "Olá!", "delayTyping": 3}'

Um envio enfileirado responde 202 com o id dele na fila. O resultado chega depois nos eventos queue.sent (com o id da mensagem no WhatsApp) ou queue.failed, e também em GET /queue/{queueId}.

Configuração

PATCH /queue/settings muda só os campos enviados:

CampoSignificado
modedirect ou queue (modo padrão dos envios)
delayMin, delayMaxIntervalo, em segundos, sorteado entre uma mensagem e a próxima
ttlHoursPor quanto tempo uma mensagem espera na fila (até 168 h); depois vira queue.failed
  • POST /queue/pause e POST /queue/resume param e retomam a fila.
  • DELETE /queue/{queueId} cancela um envio; DELETE /queue cancela todos os pendentes.
  • A fila guarda até 10.000 mensagens pendentes por instância (acima disso, 429 queue_full).