Fila

Listar jobs da fila

Lista os jobs da fila da instância e permite filtrar por status: queued, sending, sent, delivered, read, failed ou canceled.

API key Escopo read

Exemplo de requisição

curl -X GET "https://seu-dominio/instances/:id/queue" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/instances/:id/queue', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /instances/{id}/queue

API key

Entenda

Conceituação

Lista os jobs da fila da instância e permite filtrar por status: queued, sending, sent, delivered, read, failed ou canceled.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

3 campos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

Query

status string opcional

Contrato

Resposta

200

{
  "data": [
    {
      "id": "job_...",
      "status": "queued",
      "toJid": "5511999999999@s.whatsapp.net",
      "attempts": 0,
      "delayMs": 3000,
      "createdAt": "2026-10-26T18:00:00.000Z"
    }
  ]
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.

401 Credencial ausente, inválida ou sessão expirada.

403 Escopo insuficiente, IP não autorizado ou workspace suspenso.

404 Recurso não encontrado ou pertence a outro workspace.

429 Fila cheia, limite de tentativas ou rate limit.