> ## 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.

# Queues

> Inspect and manage message and operation queues with the PHP SDK

Use `$vzaps->queues()` to monitor pending messages and operations for an instance.

Common fields on all calls:

| Field           | Type     | Required | Description     |
| --------------- | -------- | -------- | --------------- |
| `instanceId`    | `string` | Yes      | Instance ID.    |
| `instanceToken` | `string` | Yes      | Instance token. |

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

Lists the pending message queue.

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

print_r($messages);
```

**Return:** envelope `{ code, success, data }` with `count` and `messages[]` (`id`, `type`, `status`, etc.).

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

Removes one specific message from the queue.

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

**Return:** envelope `{ code, success, data }` with `message_id`, `count`, `details`.

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

<Warning>
  Removes every pending item from the message queue. Use only when you are sure.
</Warning>

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

**Return:** envelope `{ code, success, data }` with removed `count`.

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

Lists the pending operation queue.

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

print_r($operations);
```

**Return:** envelope `{ code, success, data }` with pending operations queue.

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

Removes one specific operation from the queue.

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

**Return:** envelope `{ code, success, data }` with `message_id`, `count`, `details`.

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

<Warning>
  Removes every pending item from the operation queue. Use only when you are sure.
</Warning>

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

**Return:** envelope `{ code, success, data }` with removed `count`.