Listar a fila

GET/v1/instances/{id}/queuedesde M6token da instância ou admin

Quando usar

Itens da fila de envio da instância, do mais antigo ao mais novo. Sem status, lista o que ainda não saiu (queued e in_flight); ?status= filtra por queued, in_flight, sent, failed ou all. Pagina por next_cursor.

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
`id`obrigatório	`string`	Id da instância (`inst_...`).

Query

Nome	Tipo	Descrição
`status`	`"queued" \| "in_flight" \| "sent" \| "failed" \| "all"`	`queued`, `in_flight`, `sent`, `failed` ou `all`. Omitido: `queued` e `in_flight`.
`limit`	`integer`	Itens por página. Padrão 50, máximo 200. (padrão 50)
`cursor`	`string`	`next_cursor` da página anterior (opaco).

Exemplo

curl -s "$LITEZAP_URL/v1/instances/$ID/queue?status=queued" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/queue?status=queued", {
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

import os
import requests

r = requests.get(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/queue",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    params={
        "status": "queued",
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/queue?status=queued", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('GET', '/v1/instances/inst_7f3a9c2e5b1d4086/queue', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'query' => [
        'status' => 'queued',
    ],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 Uma página da fila.

Campos de object

`items`	`Message[]`
`next_cursor`	`string`	Ausente na última página.

{
  "items": [
    {
      "id": "msg_a41c9e07d2b35f68",
      "chat": "[email protected]",
      "from_me": true,
      "source": "api",
      "type": "text",
      "text": "Seu pedido saiu para entrega!",
      "status": "queued",
      "timestamp": "2026-10-17T13:50:00Z"
    }
  ]
}

Erros

Código	HTTP	Retentável	O que fazer
`validation_failed`	400	não	Corrija o corpo ou os parâmetros; a `message` diz o campo.
`unauthorized`	401	não	Envie `Authorization: Bearer <token>` válido.
`forbidden`	403	não	Use o token certo (admin, ou o da própria instância).
`instance_not_found`	404	não	Confira o id da instância.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Equivalente na Z-API: Fila. Veja Migrar da Z-API.

Outras operações de Mensagens: Enviar mensagem · Consultar mensagem · Esvaziar a fila · Cancelar item da fila · Favoritar mensagem