> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Filas

> Consultar e gerenciar filas de mensagens e operações com o SDK PHP

Use `$vzaps->queues()` para acompanhar mensagens e operações pendentes de uma instância.

Campos comuns em todas as chamadas:

| Campo           | Tipo     | Obrigatório | Descrição           |
| --------------- | -------- | ----------- | ------------------- |
| `instanceId`    | `string` | Sim         | ID da instância.    |
| `instanceToken` | `string` | Sim         | Token da instância. |

## `queues()->listMessages($request)`

Lista a fila de mensagens pendentes.

```php theme={null}
$messages = $vzaps->queues()->listMessages([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);

print_r($messages);
```

**Retorno:** envelope `{ code, success, data }` com `count` e `messages[]` (`id`, `type`, `status`, etc.).

## `queues()->removeMessage($request)`

Remove uma mensagem específica da fila.

```php theme={null}
$vzaps->queues()->removeMessage([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'messageId' => 'queue-message-id',
]);
```

**Retorno:** envelope `{ code, success, data }` com `message_id`, `count`, `details`.

## `queues()->purgeMessages($request)`

<Warning>
  Remove todos os itens pendentes da fila de mensagens. Use apenas quando tiver certeza.
</Warning>

```php theme={null}
$vzaps->queues()->purgeMessages([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);
```

**Retorno:** envelope `{ code, success, data }` com `count` de itens removidos.

## `queues()->listOperations($request)`

Lista a fila de operações pendentes.

```php theme={null}
$operations = $vzaps->queues()->listOperations([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);

print_r($operations);
```

**Retorno:** envelope `{ code, success, data }` com fila de operacoes pendentes.

## `queues()->removeOperation($request)`

Remove uma operação específica da fila.

```php theme={null}
$vzaps->queues()->removeOperation([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'messageId' => 'queue-operation-id',
]);
```

**Retorno:** envelope `{ code, success, data }` com `message_id`, `count`, `details`.

## `queues()->purgeOperations($request)`

<Warning>
  Remove todos os itens pendentes da fila de operações. Use apenas quando tiver certeza.
</Warning>

```php theme={null}
$vzaps->queues()->purgeOperations([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);
```

**Retorno:** envelope `{ code, success, data }` com `count` de itens removidos.