> ## 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 TypeScript SDK

Use `vzaps.queues` to monitor pending messages and operations for an instance.

Common fields on every call:

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

## `queues.listMessages(request)`

Lists the pending message queue.

```ts theme={null}
const messages = await vzaps.queues.listMessages({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
});

console.dir(messages, { depth: null });
```

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

## `queues.removeMessage(request)`

Removes one specific message from the queue.

```ts theme={null}
await vzaps.queues.removeMessage({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  messageId: 'queue-message-id',
});
```

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

## `queues.purgeMessages(request)`

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

```ts theme={null}
await vzaps.queues.purgeMessages({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
});
```

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

## `queues.listOperations(request)`

Lists the pending operation queue.

```ts theme={null}
const operations = await vzaps.queues.listOperations({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
});

console.dir(operations, { depth: null });
```

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

## `queues.removeOperation(request)`

Removes one specific operation from the queue.

```ts theme={null}
await vzaps.queues.removeOperation({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
  messageId: 'queue-operation-id',
});
```

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

## `queues.purgeOperations(request)`

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

```ts theme={null}
await vzaps.queues.purgeOperations({
  instanceId: 'VZ...',
  instanceToken: 'instance-token',
});
```

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